From 55f09f950577bb314612ed295402eb7f7ccd0c57 Mon Sep 17 00:00:00 2001 From: Greg McKeon Date: Tue, 15 Oct 2024 11:40:47 -0500 Subject: [PATCH 1/4] initial BYOK docs --- website/docs/docs/cloud/dbt-copilot.md | 2 +- website/docs/docs/cloud/enable-dbt-copilot.md | 22 ++++++++++++++++--- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/website/docs/docs/cloud/dbt-copilot.md b/website/docs/docs/cloud/dbt-copilot.md index 42a05dd91ba..33494ff1264 100644 --- a/website/docs/docs/cloud/dbt-copilot.md +++ b/website/docs/docs/cloud/dbt-copilot.md @@ -13,7 +13,7 @@ dbt Copilot is a powerful artificial intelligence (AI) engine that's fully integ :::tip Beta feature dbt Copilot is designed to _help_ developers generate documentation, tests, and semantic models in dbt Cloud. It's available in beta, in the dbt Cloud IDE only. -To use dbt Copilot, you must have an active [dbt Cloud Enterprise account](https://www.getdbt.com/pricing) and agree to use dbt Labs' OpenAI key. [Register your interest](https://docs.google.com/forms/d/e/1FAIpQLScPjRGyrtgfmdY919Pf3kgqI5E95xxPXz-8JoVruw-L9jVtxg/viewform) to join the private beta or reach out to your Account team to begin this process. +To use dbt Copilot, you must have an active [dbt Cloud Enterprise account](https://www.getdbt.com/pricing) either agree to use dbt Labs' OpenAI key or provide your own Open AIAPI key. [Register your interest](https://docs.google.com/forms/d/e/1FAIpQLScPjRGyrtgfmdY919Pf3kgqI5E95xxPXz-8JoVruw-L9jVtxg/viewform) to join the private beta or reach out to your Account team to begin this process. ::: diff --git a/website/docs/docs/cloud/enable-dbt-copilot.md b/website/docs/docs/cloud/enable-dbt-copilot.md index 23c253ecf7a..cb951aab3e5 100644 --- a/website/docs/docs/cloud/enable-dbt-copilot.md +++ b/website/docs/docs/cloud/enable-dbt-copilot.md @@ -13,12 +13,12 @@ This page explains how to enable the dbt Copilot engine in dbt Cloud, leveraging - Available in the dbt Cloud IDE only. - Must have an active [dbt Cloud Enterprise account](https://www.getdbt.com/pricing). - Development environment has been upgraded to ["Versionless"](/docs/dbt-versions/upgrade-dbt-version-in-cloud#versionless). -- Current dbt Copilot deployments use a central OpenAI API key managed by dbt Labs. In the future, you may provide your own key for Azure OpenAI or OpenAI. +- By default, dbt Copilot deployments use a central OpenAI API key managed by dbt Labs. Alternatively, you can provide your own OpenAI API key as described below. - Accept and sign legal agreements. Reach out to your Account team to begin this process. ## Enable dbt Copilot -dbt Copilot is only available at an account level after your organization has signed the legal requirements. It's disabled by default. A dbt Cloud admin(s) can enable it by following these steps: +dbt Copilot is only available at an account level after your organization has signed the legal requirements. It's disabled by default. A dbt Cloud admin can enable it by following these steps: 1. Navigate to **Account settings** in the navigation menu. @@ -32,4 +32,20 @@ dbt Copilot is only available at an account level after your organization has si Note: To disable (only after enabled), repeat steps 1 to 3, toggle off in step 4, and repeat step 5. - \ No newline at end of file + + +### Bringing your own OpenAI API Key (BYOK) + +Once AI features have been enabled, you can provide your own organization's OpenAI API key. dbt Cloud will then your OpenAI account and terms to power dbt CoPilot. Note that this will incur billing charges to your organization from OpenAI for requests made by CoPilot. + +Note that Azure OpenAI is not currently supported, but will be in the future. + +A dbt Cloud admin can provide their API key by following these steps: + +1. Navigate to **Account settings** in the navigation menu. + +2. Under **Settings**, click on **Integrations**. + +3. Scroll to **AI**. Select the toggle for **OpenAI** + +4. Enter your API key and save. \ No newline at end of file From 21308951c90962ada4c2cd1674ca6933715e7a3d Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 15 Oct 2024 13:01:29 -0400 Subject: [PATCH 2/4] Apply suggestions from code review --- website/docs/docs/cloud/dbt-copilot.md | 2 +- website/docs/docs/cloud/enable-dbt-copilot.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/docs/cloud/dbt-copilot.md b/website/docs/docs/cloud/dbt-copilot.md index 33494ff1264..403df86a089 100644 --- a/website/docs/docs/cloud/dbt-copilot.md +++ b/website/docs/docs/cloud/dbt-copilot.md @@ -13,7 +13,7 @@ dbt Copilot is a powerful artificial intelligence (AI) engine that's fully integ :::tip Beta feature dbt Copilot is designed to _help_ developers generate documentation, tests, and semantic models in dbt Cloud. It's available in beta, in the dbt Cloud IDE only. -To use dbt Copilot, you must have an active [dbt Cloud Enterprise account](https://www.getdbt.com/pricing) either agree to use dbt Labs' OpenAI key or provide your own Open AIAPI key. [Register your interest](https://docs.google.com/forms/d/e/1FAIpQLScPjRGyrtgfmdY919Pf3kgqI5E95xxPXz-8JoVruw-L9jVtxg/viewform) to join the private beta or reach out to your Account team to begin this process. +To use dbt Copilot, you must have an active [dbt Cloud Enterprise account](https://www.getdbt.com/pricing) and either agree to use dbt Labs' OpenAI key or provide your own Open AI API key. [Register here](https://docs.google.com/forms/d/e/1FAIpQLScPjRGyrtgfmdY919Pf3kgqI5E95xxPXz-8JoVruw-L9jVtxg/viewform) or reach out to the Account Team if you're interested in joining the private beta. ::: diff --git a/website/docs/docs/cloud/enable-dbt-copilot.md b/website/docs/docs/cloud/enable-dbt-copilot.md index cb951aab3e5..fd138bf6c72 100644 --- a/website/docs/docs/cloud/enable-dbt-copilot.md +++ b/website/docs/docs/cloud/enable-dbt-copilot.md @@ -13,12 +13,12 @@ This page explains how to enable the dbt Copilot engine in dbt Cloud, leveraging - Available in the dbt Cloud IDE only. - Must have an active [dbt Cloud Enterprise account](https://www.getdbt.com/pricing). - Development environment has been upgraded to ["Versionless"](/docs/dbt-versions/upgrade-dbt-version-in-cloud#versionless). -- By default, dbt Copilot deployments use a central OpenAI API key managed by dbt Labs. Alternatively, you can provide your own OpenAI API key as described below. +- By default, dbt Copilot deployments use a central OpenAI API key managed by dbt Labs. Alternatively, you can [provide your own OpenAI API key](#bringing-your-own-openai-api-key-byok). - Accept and sign legal agreements. Reach out to your Account team to begin this process. ## Enable dbt Copilot -dbt Copilot is only available at an account level after your organization has signed the legal requirements. It's disabled by default. A dbt Cloud admin can enable it by following these steps: +dbt Copilot is only available to your account after your organization has signed the required legal documents. It's disabled by default. A dbt Cloud admin can enable it by following these steps: 1. Navigate to **Account settings** in the navigation menu. @@ -34,9 +34,9 @@ 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 own organization's OpenAI API key. dbt Cloud will then your OpenAI account and terms to power dbt CoPilot. Note that this will incur billing charges to your organization from OpenAI for requests made by CoPilot. +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. From b1fc37a91a7c4e5732a743734e92b9eddf8b488b Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 15 Oct 2024 13:03:24 -0400 Subject: [PATCH 3/4] Apply suggestions from code review --- website/docs/docs/cloud/enable-dbt-copilot.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/enable-dbt-copilot.md b/website/docs/docs/cloud/enable-dbt-copilot.md index fd138bf6c72..88462391883 100644 --- a/website/docs/docs/cloud/enable-dbt-copilot.md +++ b/website/docs/docs/cloud/enable-dbt-copilot.md @@ -42,10 +42,10 @@ Note that Azure OpenAI is not currently supported, but will be in the future. A dbt Cloud admin can provide their API key by following these steps: -1. Navigate to **Account settings** in the navigation menu. +1. Navigate to **Account settings** in the side menu. -2. Under **Settings**, click on **Integrations**. +2. Find the **Settings** section and click on **Integrations**. 3. Scroll to **AI**. Select the toggle for **OpenAI** -4. Enter your API key and save. \ No newline at end of file +4. Enter your API key and click **Save**. \ No newline at end of file From a9de21b2da9941969bc5a954e7b7818373614c06 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 15 Oct 2024 13:04:20 -0400 Subject: [PATCH 4/4] Update website/docs/docs/cloud/enable-dbt-copilot.md --- website/docs/docs/cloud/enable-dbt-copilot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/enable-dbt-copilot.md b/website/docs/docs/cloud/enable-dbt-copilot.md index 88462391883..07a9f6294da 100644 --- a/website/docs/docs/cloud/enable-dbt-copilot.md +++ b/website/docs/docs/cloud/enable-dbt-copilot.md @@ -46,6 +46,6 @@ A dbt Cloud admin can provide their API key by following these steps: 2. Find the **Settings** section and click on **Integrations**. -3. Scroll to **AI**. Select the toggle for **OpenAI** +3. Scroll to **AI** and select the toggle for **OpenAI** 4. Enter your API key and click **Save**. \ No newline at end of file