Skip to content

Commit ce6f285

Browse files
committed
docs(conversation): align runtime model env vars & update component examples
- Add and document runtime env vars: OPENAI_MODEL, AZURE_OPENAI_MODEL, ANTHROPIC_MODEL, GOOGLEAI_MODEL, MISTRAL_MODEL, HUGGINGFACE_MODEL, OLLAMA_MODEL (with defaults) - Update environment reference page with the new env var names and defaults - Replace env-var placeholders in component YAML examples with literal default model names for OpenAI, GoogleAI, Anthropic, Mistral, Hugging Face and Ollama - Add "(configurable via '<ENV>' environment variable)" to each provider's Spec metadata table to show override option - Add Azure OpenAI usage section to `conversation.openai` doc (how to use `apiType: azure` and `AZURE_OPENAI_MODEL`) - Clarify AWS Bedrock uses standard AWS auth (no Bedrock-specific env var added) - Fix small markdown lint issues (trailing newlines/whitespace) Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com>
1 parent b37e079 commit ce6f285

File tree

7 files changed

+50
-18
lines changed

7 files changed

+50
-18
lines changed

daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
- name: key
2121
value: "mykey"
2222
- name: model
23-
value: '${{DAPR_CONVERSATION_ANTHROPIC_MODEL}}'
23+
value: 'claude-sonnet-4-20250514'
2424
- name: cacheTTL
2525
value: 10m
2626
```
@@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3434
| Field | Required | Details | Example |
3535
|--------------------|:--------:|---------|---------|
3636
| `key` | Y | API key for Anthropic. | `"mykey"` |
37-
| `model` | N | The Anthropic LLM to use. Defaults to `claude-3-5-sonnet-20240620` (configurable via `DAPR_CONVERSATION_ANTHROPIC_MODEL` environment variable). | `${{DAPR_CONVERSATION_ANTHROPIC_MODEL}}` |
37+
| `model` | N | The Anthropic LLM to use. Defaults to `claude-sonnet-4-20250514` (configurable via the `ANTHROPIC_MODEL` environment variable). | `claude-sonnet-4-20250514` |
3838
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
3939

4040
## Related links
4141

42-
- [Conversation API overview]({{< ref conversation-overview.md >}})
42+
- [Conversation API overview]({{< ref conversation-overview.md >}})

daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
- name: key
2121
value: "mykey"
2222
- name: model
23-
value: '${{DAPR_CONVERSATION_GOOGLEAI_MODEL}}'
23+
value: 'gemini-2.5-flash-lite'
2424
- name: cacheTTL
2525
value: 10m
2626
```
@@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3434
| Field | Required | Details | Example |
3535
|--------------------|:--------:|---------|---------|
3636
| `key` | Y | API key for GoogleAI. | `"mykey"` |
37-
| `model` | N | The GoogleAI LLM to use. Defaults to `gemini-1.5-flash` (configurable via `DAPR_CONVERSATION_GOOGLEAI_MODEL` environment variable). | `${{DAPR_CONVERSATION_GOOGLEAI_MODEL}}` |
37+
| `model` | N | The GoogleAI LLM to use. Defaults to `gemini-2.5-flash-lite` (configurable via the `GOOGLEAI_MODEL` environment variable). | `gemini-2.5-flash-lite` |
3838
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
3939

4040
## Related links

daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
- name: key
2121
value: mykey
2222
- name: model
23-
value: '${{DAPR_CONVERSATION_HUGGINGFACE_MODEL}}'
23+
value: 'deepseek-ai/DeepSeek-R1-Distill-Qwen-32B'
2424
- name: cacheTTL
2525
value: 10m
2626
```
@@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3434
| Field | Required | Details | Example |
3535
|--------------------|:--------:|---------|---------|
3636
| `key` | Y | API key for Huggingface. | `mykey` |
37-
| `model` | N | The Huggingface LLM to use. Defaults to `deepseek-ai/DeepSeek-R1-Distill-Qwen-32B` (configurable via `DAPR_CONVERSATION_HUGGINGFACE_MODEL` environment variable). | `${{DAPR_CONVERSATION_HUGGINGFACE_MODEL}}` |
37+
| `model` | N | The Huggingface LLM to use. Defaults to `deepseek-ai/DeepSeek-R1-Distill-Qwen-32B` (configurable via the `HUGGINGFACE_MODEL` environment variable). | `deepseek-ai/DeepSeek-R1-Distill-Qwen-32B` |
3838
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
3939

4040
## Related links
4141

42-
- [Conversation API overview]({{< ref conversation-overview.md >}})
42+
- [Conversation API overview]({{< ref conversation-overview.md >}})

daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
- name: key
2121
value: mykey
2222
- name: model
23-
value: '${{DAPR_CONVERSATION_MISTRAL_MODEL}}'
23+
value: 'open-mistral-7b'
2424
- name: cacheTTL
2525
value: 10m
2626
```
@@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3434
| Field | Required | Details | Example |
3535
|--------------------|:--------:|---------|---------|
3636
| `key` | Y | API key for Mistral. | `mykey` |
37-
| `model` | N | The Mistral LLM to use. Defaults to `open-mistral-7b` (configurable via `DAPR_CONVERSATION_MISTRAL_MODEL` environment variable). | `${{DAPR_CONVERSATION_MISTRAL_MODEL}}` |
37+
| `model` | N | The Mistral LLM to use. Defaults to `open-mistral-7b` (configurable via the `MISTRAL_MODEL` environment variable). | `open-mistral-7b` |
3838
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
3939

4040
## Related links
4141

42-
- [Conversation API overview]({{< ref conversation-overview.md >}})
42+
- [Conversation API overview]({{< ref conversation-overview.md >}})

daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ spec:
1818
type: conversation.ollama
1919
metadata:
2020
- name: model
21-
value: '${{DAPR_CONVERSATION_OLLAMA_MODEL}}'
21+
value: 'llama3.2:latest'
2222
- name: cacheTTL
2323
value: 10m
2424
```
@@ -31,7 +31,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3131
3232
| Field | Required | Details | Example |
3333
|--------------------|:--------:|---------|---------|
34-
| `model` | N | The Ollama LLM to use. Defaults to `llama3.2:latest` (configurable via `DAPR_CONVERSATION_OLLAMA_MODEL` environment variable). | `${{DAPR_CONVERSATION_OLLAMA_MODEL}}` |
34+
| `model` | N | The Ollama LLM to use. Defaults to `llama3.2:latest` (configurable via the `OLLAMA_MODEL` environment variable). | `llama3.2:latest` |
3535
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
3636

3737
## Related links

daprdocs/content/en/reference/components-reference/supported-conversation/openai.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
- name: key
2121
value: mykey
2222
- name: model
23-
value: '${{DAPR_CONVERSATION_OPENAI_MODEL}}'
23+
value: 'gpt-5-nano'
2424
- name: cacheTTL
2525
value: 10m
2626
```
@@ -34,9 +34,33 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3434
| Field | Required | Details | Example |
3535
|--------------------|:--------:|---------|---------|
3636
| `key` | Y | API key for OpenAI. | `mykey` |
37-
| `model` | N | The OpenAI LLM to use. Defaults to `gpt-5-nano` (configurable via `DAPR_CONVERSATION_OPENAI_MODEL` environment variable). | `${{DAPR_CONVERSATION_OPENAI_MODEL}}` |
37+
| `model` | N | The OpenAI LLM to use. Defaults to `gpt-5-nano` (configurable via the `OPENAI_MODEL` environment variable). | `gpt-5-nano` |
3838
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
3939

40+
## Azure OpenAI usage
41+
42+
The `conversation.openai` component can target either OpenAI's hosted API or Azure OpenAI. To select Azure OpenAI, set the component's `apiType` metadata to `azure` and provide the usual Azure-specific connection settings (for example, endpoint/region and API key) in the component configuration.
43+
44+
When `apiType: azure` is used, the environment variable `AZURE_OPENAI_MODEL` may be set to provide a default Azure model identifier to use when the component's `model` metadata is not provided. This environment variable only affects the component when `apiType` is set to `azure` — the regular `DAPR_CONVERSATION_OPENAI_MODEL` remains the default for non-Azure OpenAI usage.
45+
46+
Example (Azure OpenAI configuration):
47+
48+
```yaml
49+
spec:
50+
type: conversation.openai
51+
metadata:
52+
- name: apiType
53+
value: azure
54+
- name: key
55+
value: "<your-azure-openai-key>"
56+
- name: endpoint
57+
value: "https://<your-resource-name>.openai.azure.com/"
58+
- name: model
59+
value: '${{AZURE_OPENAI_MODEL}}'
60+
```
61+
62+
If `model` is omitted from the component metadata and neither `AZURE_OPENAI_MODEL` nor `DAPR_CONVERSATION_OPENAI_MODEL` are set, the component falls back to its built-in default model.
63+
4064
## Related links
4165

42-
- [Conversation API overview]({{< ref conversation-overview.md >}})
66+
- [Conversation API overview]({{< ref conversation-overview.md >}})

daprdocs/content/en/reference/environment/_index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,20 @@ The following table lists the environment variables used by the Dapr runtime, CL
2121
| SSL_CERT_DIR | Dapr sidecar | Specifies the location where the public certificates for all the trusted certificate authorities (CA) are located. Not applicable when the sidecar is running as a process in self-hosted mode.|
2222
| DAPR_HELM_REPO_URL | Your private Dapr Helm chart url | Specifies a private Dapr Helm chart url, which defaults to the official Helm chart URL: `https://dapr.github.io/helm-charts`|
2323
| DAPR_HELM_REPO_USERNAME | A username for a private Helm chart | The username required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set|
24-
| DAPR_HELM_REPO_PASSWORD | A password for a private Helm chart |The password required to access the private Dapr helm chart. If it can be accessed publicly, this env variable does not need to be set|
24+
| DAPR_HELM_REPO_PASSWORD | A password for a private Helm chart |The password required to access the private Dapr helm chart. If it can be accessed publicly, this env variable does not need to be set|
2525
| OTEL_EXPORTER_OTLP_ENDPOINT | OpenTelemetry Tracing | Sets the Open Telemetry (OTEL) server address, turns on tracing. (Example: `http://localhost:4318`) |
2626
| OTEL_EXPORTER_OTLP_INSECURE | OpenTelemetry Tracing | Sets the connection to the endpoint as unencrypted. (`true`, `false`) |
2727
| OTEL_EXPORTER_OTLP_PROTOCOL | OpenTelemetry Tracing | The OTLP protocol to use Transport protocol. (`grpc`, `http/protobuf`, `http/json`) |
2828
| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` |
2929
| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. |
3030
| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) |
3131
| DAPR_HOST_IP | Dapr sidecar | The host's chosen IP address. If not specified, will loop over the network interfaces and select the first non-loopback address it finds.|
32-
| DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. |
32+
| DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. |
33+
| OPENAI_MODEL | Conversation components | Default model name used by the `conversation.openai` component at runtime when no `model` metadata is set in the component file. Default: `gpt-5-nano`. |
34+
| AZURE_OPENAI_MODEL | Conversation components / Azure config | Default Azure model name used by the `conversation.openai` component when `apiType: azure` is configured and no `model` metadata is provided. Default: `gpt-4.1-mini`. |
35+
| ANTHROPIC_MODEL | Conversation components | Default model name used by the `conversation.anthropic` component when no `model` metadata is set in the component file. Default: `claude-sonnet-4-20250514`. |
36+
| GOOGLEAI_MODEL | Conversation components | Default model name used by the `conversation.googleai` component when no `model` metadata is set in the component file. Default: `gemini-2.5-flash-lite`. |
37+
| MISTRAL_MODEL | Conversation components | Default model name used by the `conversation.mistral` component when no `model` metadata is set in the component file. Default: `open-mistral-7b`. |
38+
| HUGGINGFACE_MODEL | Conversation components | Default model name used by the `conversation.huggingface` component when no `model` metadata is set in the component file. Default: `deepseek-ai/DeepSeek-R1-Distill-Qwen-32B`. |
39+
| OLLAMA_MODEL | Conversation components | Default model name used by the `conversation.ollama` component when no `model` metadata is set in the component file. Default: `llama3.2:latest`. |
40+

0 commit comments

Comments
 (0)