Skip to content

Commit

Permalink
initial BYOK docs
Browse files Browse the repository at this point in the history
  • Loading branch information
greg-mckeon committed Oct 15, 2024
1 parent cdb659c commit 55f09f9
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/dbt-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::

<Lightbox src="/img/docs/dbt-cloud/cloud-ide/dbt-copilot-doc.gif" width="100%" title="Example of using dbt Copilot to generate documentation in the IDE" />
Expand Down
22 changes: 19 additions & 3 deletions website/docs/docs/cloud/enable-dbt-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

<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" />
<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" />

Check warning on line 35 in website/docs/docs/cloud/enable-dbt-copilot.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/enable-dbt-copilot.md#L35

[custom.UIElements] UI elements like 'Account settings' should be bold.
Raw output
{"message": "[custom.UIElements] UI elements like 'Account settings' should be bold.", "location": {"path": "website/docs/docs/cloud/enable-dbt-copilot.md", "range": {"start": {"line": 35, "column": 153}}}, "severity": "WARNING"}

### Bringing your own OpenAI API Key (BYOK)

Check warning on line 37 in website/docs/docs/cloud/enable-dbt-copilot.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/enable-dbt-copilot.md#L37

[custom.SentenceCaseHeaders] 'Bringing your own OpenAI API Key (BYOK)' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'Bringing your own OpenAI API Key (BYOK)' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/cloud/enable-dbt-copilot.md", "range": {"start": {"line": 37, "column": 5}}}, "severity": "WARNING"}

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.

Check warning on line 45 in website/docs/docs/cloud/enable-dbt-copilot.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/cloud/enable-dbt-copilot.md#L45

[custom.UIElements] UI elements like 'Account settings' should be bold.
Raw output
{"message": "[custom.UIElements] UI elements like 'Account settings' should be bold.", "location": {"path": "website/docs/docs/cloud/enable-dbt-copilot.md", "range": {"start": {"line": 45, "column": 18}}}, "severity": "WARNING"}

2. Under **Settings**, click on **Integrations**.

3. Scroll to **AI**. Select the toggle for **OpenAI**

4. Enter your API key and save.

0 comments on commit 55f09f9

Please sign in to comment.