Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add new integration page #6579

Merged
merged 26 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
24aba36
add integartions page
mirnawong1 Dec 3, 2024
6315b54
add rn
mirnawong1 Dec 3, 2024
c4ea959
add beta flag
mirnawong1 Dec 3, 2024
f4fb140
add steps
mirnawong1 Dec 3, 2024
7730032
add links
mirnawong1 Dec 3, 2024
b4b3d54
add enterprise pill
mirnawong1 Dec 3, 2024
3871104
rephrase
mirnawong1 Dec 3, 2024
f26343d
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 3, 2024
78fd8a6
Merge branch 'current' into add-ai-integration-page
mirnawong1 Dec 4, 2024
7e4296e
Merge branch 'current' into add-ai-integration-page
mirnawong1 Dec 5, 2024
742995a
Merge branch 'current' into add-ai-integration-page
mirnawong1 Dec 6, 2024
a4c0abe
small tweaks
mirnawong1 Dec 6, 2024
ad0ae2d
add link
mirnawong1 Dec 6, 2024
29de9e9
format
mirnawong1 Dec 6, 2024
b4870cd
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 6, 2024
4083236
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 6, 2024
24277ab
update
mirnawong1 Dec 6, 2024
46f8e23
Merge branch 'add-ai-integration-page' of github.com:dbt-labs/docs.ge…
mirnawong1 Dec 6, 2024
3e53bfa
adjust rn
mirnawong1 Dec 6, 2024
1b06fc9
add managed
mirnawong1 Dec 6, 2024
a740618
small tweak
mirnawong1 Dec 6, 2024
5ce2c63
small tweak
mirnawong1 Dec 6, 2024
a6e7f24
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 6, 2024
183118e
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 6, 2024
b539a5e
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 6, 2024
1d4b53a
Update website/docs/docs/cloud/account-integrations.md
mirnawong1 Dec 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions website/docs/docs/cloud/account-integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
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

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, click on the Git provider from the list and select the **Pencil** icon to the right of the provider.

dbt Cloud [natively connects](/docs/cloud/git/git-configuration-in-dbt-cloud) to the following Git providers:

- GitHub
- GitLab
- 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

Check warning on line 27 in website/docs/docs/cloud/account-integrations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/account-integrations.md#L27

[custom.SentenceCaseHeaders] 'OAuth' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'OAuth' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/cloud/account-integrations.md", "range": {"start": {"line": 27, "column": 4}}}, "severity": "WARNING"}

Connect your dbt Cloud account to an OAuth provider that are integrated with dbt Cloud.

To configure an OAuth account integration:
- Click on **Integrations** from the sidebar.
- For Slack, click on **Link** to connect your Slack account.
- 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

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). Note, if you bring-your-own provider, you will incur API calls and associated charges for features used in dbt Cloud.

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. Under the **Settings** section, click on **Integrations**.
3. Scroll to **AI**.
4. 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" />

### dbt Labs OpenAI

Check warning on line 50 in website/docs/docs/cloud/account-integrations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/account-integrations.md#L50

[custom.SentenceCaseHeaders] 'dbt Labs OpenAI' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'dbt Labs OpenAI' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/cloud/account-integrations.md", "range": {"start": {"line": 50, "column": 5}}}, "severity": "WARNING"}

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

### OpenAI key

Check warning on line 55 in website/docs/docs/cloud/account-integrations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/account-integrations.md#L55

[custom.SentenceCaseHeaders] 'OpenAI key' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'OpenAI key' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/cloud/account-integrations.md", "range": {"start": {"line": 55, "column": 5}}}, "severity": "WARNING"}
1. Select the toggle for **OpenAI** to use your own OpenAI key.
2. Enter the API key.
3. Click **Save**.

### Azure OpenAI <Lifecycle status="beta" />

Check warning on line 60 in website/docs/docs/cloud/account-integrations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/account-integrations.md#L60

[custom.SentenceCaseHeaders] 'Azure OpenAI' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'Azure OpenAI' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/cloud/account-integrations.md", "range": {"start": {"line": 60, "column": 5}}}, "severity": "WARNING"}

**Deploying your own OpenAI model on Azure** https://learn.microsoft.com/en-us/azure/ai-studio/how-to/deploy-models-openai

:::info
dbt Cloud's AI is optimized for OpenAIs gpt-4o. Using other models can negatively affect performance and accuracy.
(We cannot guarantee things will be working as expected for any other model)
:::

You can configure credentials for your Azure OpenAI deployment in the following two ways:

- <Expandable alt_header="From a Target URI">

**Locate your Azure OpenAI deployment URI**
ref to Azure docs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reneruck-dbt can't seem to find the right doc for deployment uri


ADD SCREENSHOT

1. Select **Azure OpenAI**.
2. Select the tab **From Target URI**.
3. Paste the URI into the **Target URI** field.
4. Verify the **Endpoint**, **Model Name**, and **API Version** are correct.
5. Enter your Azure OpenAI API key.
6. Click **Save**.
</Expandable>

- <Expandable alt_header="Manually providing the credentials">

**Locate your Azure OpenAI configuration**
ref to Azure docs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reneruck-dbt can't seem to find the right doc for open ai config


ADD SCREENSHOT

1. Select **Azure OpenAI**.
2. Select the tab **Manual Input**.
3. Enter the **Endpoint**.
4. Enter the **Model Name**.
5. Enter the **API Version**.
6. Enter your Azure OpenAI API key.
7. Click **Save**.
</Expandable>


15 changes: 5 additions & 10 deletions website/docs/docs/cloud/enable-dbt-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,9 @@ Note: To disable (only after enabled), repeat steps 1 to 3, toggle off in step 4

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#dbt-labs-openai)
- [Azure OpenAI](/docs/cloud/account-integrations#azure-openai) <Lifecycle status="beta" />
- Or your own [OpenAI API key](/docs/cloud/account-integrations#openai-key)

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).
3 changes: 3 additions & 0 deletions website/docs/docs/dbt-versions/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ Release notes are grouped by month for both multi-tenant and virtual private clo

\* The official release date for this new format of release notes is May 15th, 2024. Historical release notes for prior dates may not reflect all available features released earlier this year or their tenancy availability.

## December 2024
- **New**: You can now configure AI keys using [Azure OpenAI](/docs/cloud/account-integrations#azure-openai), available in beta. Additionally, you can use your own [OpenAI API key](/docs/cloud/account-integrations#openai-key) or use [dbt Labs-managed OpenAI](/docs/cloud/account-integrations#dbt-labs-openai) key. Refer to [Bring your own OpenAI API key (BYOK)](/docs/cloud/enable-dbt-copilot#bringing-your-own-openai-api-key-byok) for more information.

## November 2024
- **Fix**: Job environment variable overrides in credentials are now respected for Exports. Previously, they were ignored.
- **Behavior change**: If you use a custom microbatch macro, set a [`require_batched_execution_for_custom_microbatch_strategy` behavior flag](/reference/global-configs/behavior-changes#custom-microbatch-strategy) in your `dbt_project.yml` to enable batched execution. If you don't have a custom microbatch macro, you don't need to set this flag as dbt will handle microbatching automatically for any model using the [microbatch strategy](/docs/build/incremental-microbatch#how-microbatch-compares-to-other-incremental-strategies).
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