You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/pages/product/apis-integrations/ai-api.mdx
+25-10Lines changed: 25 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -176,25 +176,40 @@ to give the AI context on possible values in a categorical dimension:
176
176
177
177
### Other LLM providers
178
178
179
+
<WarningBox>
180
+
These environment variables also apply to the [AI Assistant](/product/workspace/ai-assistant),
181
+
if it is enabled on your deployment.
182
+
</WarningBox>
183
+
179
184
If desired, you may "bring your own" LLM model by providing a model and API credentials
180
185
for a supported model provider. Do this by setting environment variables in your Cube
181
186
deployment. See below for required variables by provider (required unless noted):
182
187
183
188
#### AWS Bedrock
184
189
185
-
- `CUBE_BEDROCK_MODEL_ID`
186
-
- `CUBE_BEDROCK_ACCESS_KEY`
187
-
- `CUBE_BEDROCK_ACCESS_SECRET`
188
-
- `CUBE_BEDROCK_REGION_ID`
190
+
<WarningBox>
191
+
The AI API currently supports only Anthropic Claude models on AWS Bedrock. Other
192
+
models may work but are not fully supported.
193
+
</WarningBox>
194
+
195
+
- `CUBE_BEDROCK_MODEL_ID` - A supported [AWS Bedrock chat model](https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html), for example `anthropic.claude-3-5-sonnet-20241022-v2:0`
196
+
- `CUBE_BEDROCK_ACCESS_KEY`- An access key for an IAM user with `InvokeModelWithResponseStream` permissions on the desired region/model.
197
+
- `CUBE_BEDROCK_ACCESS_SECRET`- The corresponding access secret
198
+
- `CUBE_BEDROCK_REGION_ID`- A supported AWS Bedrock region, for example `us-west-2`
189
199
190
200
#### GCP Vertex
191
201
192
-
- `CUBE_VERTEX_MODEL_ID`
193
-
- `CUBE_VERTEX_PROJECT_ID`
194
-
- `CUBE_VERTEX_REGION`
195
-
- `CUBE_VERTEX_CREDENTIALS`
202
+
<WarningBox>
203
+
The AI API currently supports only Anthropic Claude models on GCP Vertex. Other
204
+
models may work but are not fully supported.
205
+
</WarningBox>
206
+
207
+
- `CUBE_VERTEX_MODEL_ID`- A supported GCP Vertex chat model, for example `claude-3-5-sonnet@20240620`
208
+
- `CUBE_VERTEX_PROJECT_ID`- The GCP project the model is deployed in
209
+
- `CUBE_VERTEX_REGION`- The GCP region the model is deployed in, for example `us-east5`
210
+
- `CUBE_VERTEX_CREDENTIALS`- The private key for a service account with permissions to run the chosen model
196
211
197
212
#### OpenAI
198
213
199
-
- `OPENAI_MODEL`
200
-
- `OPENAI_API_KEY`
214
+
- `OPENAI_MODEL`- An OpenAI chat model ID, for example `gpt-4o`
215
+
- `OPENAI_API_KEY`- An OpenAI API key (we recommend creating a service account for the AI API)
0 commit comments