diff --git a/website/docs/docs/cloud/account-integrations.md b/website/docs/docs/cloud/account-integrations.md new file mode 100644 index 0000000000..e5ff42cb90 --- /dev/null +++ b/website/docs/docs/cloud/account-integrations.md @@ -0,0 +1,103 @@ +--- +title: "Account integrations in dbt Cloud" +sidebar_label: "Account integrations" +description: "Learn how to configure account integrations for your dbt Cloud account." +--- + +The following sections describe the different **Account integrations** available from your dbt Cloud account under the account **Settings** section. + + + +## Git integrations + +Connect your dbt Cloud account to your Git provider to enable dbt Cloud users to authenticate your personal accounts. dbt Cloud will perform Git actions on behalf of your authenticated self, against repositories to which you have access according to your Git provider permissions. + +To configure a Git account integration: +1. Navigate to **Account settings** in the side menu. +2. Under the **Settings** section, click on **Integrations**. +3. Click on the Git provider from the list and select the **Pencil** icon to the right of the provider. +4. dbt Cloud [natively connects](/docs/cloud/git/git-configuration-in-dbt-cloud) to the following Git providers: + + - [GitHub](/docs/cloud/git/connect-github) + - [GitLab](/docs/cloud/git/connect-gitlab) + - [Azure DevOps](/docs/cloud/git/connect-azure-devops) + +You can connect your dbt Cloud account to additional Git providers by importing a git repository from any valid git URL. Refer to [Import a git repository](/docs/cloud/git/import-a-project-by-git-url) for more information. + + + +## OAuth integrations + +Connect your dbt Cloud account to an OAuth provider that are integrated with dbt Cloud. + +To configure an OAuth account integration: +1. Navigate to **Account settings** in the side menu. +2. Under the **Settings** section, click on **Integrations**. +3. Under **OAuth**, and click on **Link** to connect your Slack account. +4. For custom OAuth providers, under **Custom OAuth integrations**, click on **Add integration** and select the OAuth provider from the list. Fill in the required fields and click **Save**. + + + +## AI integrations + +Once AI features have been [enabled](/docs/cloud/enable-dbt-copilot#enable-dbt-copilot), you can use dbt Labs' AI integration or bring-your-own provider to support AI-powered dbt Cloud features like [dbt Copilot](/docs/cloud/dbt-copilot) and [Ask dbt](/docs/cloud-integrations/snowflake-native-app) (both available on [dbt Cloud Enterprise plans](https://www.getdbt.com/pricing)). + +dbt Cloud supports AI integrations for dbt Labs-managed OpenAI keys, Self-managed OpenAI keys, or Self-managed Azure OpenAI keys . + +Note, if you bring-your-own provider, you will incur API calls and associated charges for features used in dbt Cloud. + +:::info +dbt Cloud's AI is optimized for OpenAIs gpt-4o. Using other models can affect performance and accuracy, and functionality with other models isn't guaranteed. +::: + +To configure the AI integration in your dbt Cloud account, a dbt Cloud admin can perform the following steps: +1. Navigate to **Account settings** in the side menu. +2. Select **Integrations** and scroll to the **AI** section. +3. Click on the **Pencil** icon to the right of **OpenAI** to configure the AI integration. + +4. Configure the AI integration for either **dbt Labs OpenAI**, **OpenAI**, or **Azure OpenAI**. + + + + + 1. Select the toggle for **dbt Labs** to use dbt Labs' managed OpenAI key. + 2. Click **Save**. + + + + + + + 1. Select the toggle for **OpenAI** to use your own OpenAI key. + 2. Enter the API key. + 3. Click **Save**. + + + + + + To learn about deploying your own OpenAI model on Azure, refer to [Deploy models on Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-studio/how-to/deploy-models-openai). Configure credentials for your Azure OpenAI deployment in dbt Cloud in the following two ways: + - [From a Target URI](#from-a-target-uri) + - [Manually providing the credentials](#manually-providing-the-credentials) + + #### From a Target URI + + 1. Locate your Azure OpenAI deployment URI in your Azure Deployment details page. + 2. In the dbt Cloud **Azure OpenAI** section, select the tab **From Target URI**. + 3. Paste the URI into the **Target URI** field. + 4. Enter your Azure OpenAI API key. + 5. Verify the **Endpoint**, **API Version**, and **Deployment Name** are correct. + 6. Click **Save**. + + + #### Manually providing the credentials + + 1. Locate your Azure OpenAI configuration in your Azure Deployment details page. + 2. In the dbt Cloud **Azure OpenAI** section, select the tab **Manual Input**. + 2. Enter your Azure OpenAI API key. + 3. Enter the **Endpoint**, **API Version**, and **Deployment Name**. + 4. Click **Save**. + + + + diff --git a/website/docs/docs/cloud/enable-dbt-copilot.md b/website/docs/docs/cloud/enable-dbt-copilot.md index 9b2b74e48d..2b954d1db5 100644 --- a/website/docs/docs/cloud/enable-dbt-copilot.md +++ b/website/docs/docs/cloud/enable-dbt-copilot.md @@ -34,18 +34,13 @@ Note: To disable (only after enabled), repeat steps 1 to 3, toggle off in step 4 -### Bringing your own OpenAI API key (BYOK) +## Bringing your own OpenAI API key (BYOK) Once AI features have been enabled, you can provide your organization's OpenAI API key. dbt Cloud will then leverage your OpenAI account and terms to power dbt Copilot. This will incur billing charges to your organization from OpenAI for requests made by dbt Copilot. -Note that Azure OpenAI is not currently supported, but will be in the future. +Configure AI keys using: +- [dbt Labs-managed OpenAI API key](/docs/cloud/account-integrations?ai-integration=dbtlabs#ai-integrations) +- Your own [OpenAI API key](/docs/cloud/account-integrations?ai-integration=openai#ai-integrations) +- [Azure OpenAI](/docs/cloud/account-integrations?ai-integration=azure#ai-integrations) -A dbt Cloud admin can provide their API key by following these steps: - -1. Navigate to **Account settings** in the side menu. - -2. Find the **Settings** section and click on **Integrations**. - -3. Scroll to **AI** and select the toggle for **OpenAI** - -4. Enter your API key and click **Save**. +For configuration details, see [Account integrations](/docs/cloud/account-integrations#ai-integrations). diff --git a/website/docs/docs/cloud/git/connect-azure-devops.md b/website/docs/docs/cloud/git/connect-azure-devops.md index f6c0ee634f..f3bb07a12d 100644 --- a/website/docs/docs/cloud/git/connect-azure-devops.md +++ b/website/docs/docs/cloud/git/connect-azure-devops.md @@ -4,6 +4,8 @@ id: "connect-azure-devops" pagination_next: "docs/cloud/git/setup-azure" --- +# Connect to Azure DevOps + diff --git a/website/docs/docs/dbt-versions/release-notes.md b/website/docs/docs/dbt-versions/release-notes.md index 47c86ea34d..f09a637653 100644 --- a/website/docs/docs/dbt-versions/release-notes.md +++ b/website/docs/docs/dbt-versions/release-notes.md @@ -20,6 +20,7 @@ Release notes are grouped by month for both multi-tenant and virtual private clo ## December 2024 +- **New**: You can now use your [Azure OpenAI key](/docs/cloud/account-integrations?ai-integration=azure#ai-integrations) (available in beta) to use dbt Cloud features like [dbt Copilot](/docs/cloud/dbt-copilot) and [Ask dbt](/docs/cloud-integrations/snowflake-native-app) . Additionally, you can use your own [OpenAI API key](/docs/cloud/account-integrations?ai-integration=openai#ai-integrations) or use [dbt Labs-managed OpenAI](/docs/cloud/account-integrations?ai-integration=dbtlabs#ai-integrations) key. Refer to [AI integrations](/docs/cloud/account-integrations#ai-integrations) for more information. - **New**: The [`hard_deletes`](/reference/resource-configs/hard-deletes) config gives you more control on how to handle deleted rows from the source. Supported options are `ignore` (default), `invalidate` (replaces the legacy `invalidate_hard_deletes=true`), and `new_record`. Note that `new_record` will create a new metadata column in the snapshot table. ## November 2024 diff --git a/website/sidebars.js b/website/sidebars.js index 65a4584acd..335271d396 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -49,6 +49,7 @@ const sidebarSettings = { items: [ "docs/cloud/about-cloud-setup", "docs/cloud/account-settings", + "docs/cloud/account-integrations", "docs/dbt-cloud-environments", "docs/cloud/migration", { diff --git a/website/static/img/docs/dbt-cloud/account-integration-ai.jpg b/website/static/img/docs/dbt-cloud/account-integration-ai.jpg new file mode 100644 index 0000000000..7dd42ee037 Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-ai.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integration-azure-manual.jpg b/website/static/img/docs/dbt-cloud/account-integration-azure-manual.jpg new file mode 100644 index 0000000000..3b509d1c96 Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-azure-manual.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integration-azure-target.jpg b/website/static/img/docs/dbt-cloud/account-integration-azure-target.jpg new file mode 100644 index 0000000000..c8ff5dd8cf Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-azure-target.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integration-dbtlabs.jpg b/website/static/img/docs/dbt-cloud/account-integration-dbtlabs.jpg new file mode 100644 index 0000000000..a2d1386e0f Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-dbtlabs.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integration-git.jpg b/website/static/img/docs/dbt-cloud/account-integration-git.jpg new file mode 100644 index 0000000000..70a275bd03 Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-git.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integration-oauth.jpg b/website/static/img/docs/dbt-cloud/account-integration-oauth.jpg new file mode 100644 index 0000000000..6efb135c46 Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-oauth.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integration-openai.jpg b/website/static/img/docs/dbt-cloud/account-integration-openai.jpg new file mode 100644 index 0000000000..f92fec5c71 Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integration-openai.jpg differ diff --git a/website/static/img/docs/dbt-cloud/account-integrations.jpg b/website/static/img/docs/dbt-cloud/account-integrations.jpg new file mode 100644 index 0000000000..56ff185963 Binary files /dev/null and b/website/static/img/docs/dbt-cloud/account-integrations.jpg differ