Skip to content

Commit

Permalink
add new integration page (#6579)
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 authored Dec 6, 2024
2 parents 2d30441 + 1d4b53a commit f1fe9f4
Show file tree
Hide file tree
Showing 13 changed files with 113 additions and 11 deletions.
103 changes: 103 additions & 0 deletions website/docs/docs/cloud/account-integrations.md
Original file line number Diff line number Diff line change
@@ -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.

<Lightbox src="/img/docs/dbt-cloud/account-integrations.jpg" title="Example of Account integrations from the sidebar" />

## 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) <Lifecycle status="enterprise" />

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.

<Lightbox src="/img/docs/dbt-cloud/account-integration-git.jpg" width="85%" title="Example of the Git integration page" />

## 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**.

<Lightbox src="/img/docs/dbt-cloud/account-integration-oauth.jpg" width="85%" title="Example of the OAuth integration page" />

## 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 <Lifecycle status="beta" />.

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.
<Lightbox src="/img/docs/dbt-cloud/account-integration-ai.jpg" width="85%" title="Example of the AI integration page" />
4. Configure the AI integration for either **dbt Labs OpenAI**, **OpenAI**, or **Azure OpenAI**.

<Tabs queryString="ai-integration">
<TabItem value="dbtlabs" label="dbt Labs OpenAI">

1. Select the toggle for **dbt Labs** to use dbt Labs' managed OpenAI key.
2. Click **Save**.

<Lightbox src="/img/docs/dbt-cloud/account-integration-dbtlabs.jpg" width="85%" title="Example of the dbt Labs integration page" />
</TabItem>

<TabItem value="openai" label="OpenAI">

1. Select the toggle for **OpenAI** to use your own OpenAI key.
2. Enter the API key.
3. Click **Save**.
<Lightbox src="/img/docs/dbt-cloud/account-integration-openai.jpg" width="85%" title="Example of the OpenAI integration page" />

</TabItem>

<TabItem value="azure" label="Azure OpenAI (beta)">
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**.
<Lightbox src="/img/docs/dbt-cloud/account-integration-azure-target.jpg" width="85%" title="Example of Azure OpenAI integration section" />

#### 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**.
<Lightbox src="/img/docs/dbt-cloud/account-integration-azure-manual.jpg" width="85%" title="Example of Azure OpenAI integration section" />

</TabItem>
</Tabs>
17 changes: 6 additions & 11 deletions website/docs/docs/cloud/enable-dbt-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,13 @@ Note: To disable (only after enabled), repeat steps 1 to 3, toggle off in step 4

<Lightbox src="/img/docs/deploy/example-account-settings.png" width="90%" title="Example of the 'Enable account access to AI-powered feature' option in Account settings" />

### 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) <Lifecycle status="beta" />

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).
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/git/connect-azure-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ id: "connect-azure-devops"
pagination_next: "docs/cloud/git/setup-azure"
---

# Connect to Azure DevOps <Lifecycle status="enterprise" />

<Snippet path="available-enterprise-tier-only" />


Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/dbt-versions/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f1fe9f4

Please sign in to comment.