From d6903230bba353fd05afcf192c73c0ab93eb9507 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Fri, 29 Aug 2025 08:56:01 +0000 Subject: [PATCH 1/9] docs(conversation): reference env vars for default models in conversation components Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com> --- .../components-reference/supported-conversation/anthropic.md | 4 ++-- .../supported-conversation/hugging-face.md | 4 ++-- .../components-reference/supported-conversation/mistral.md | 4 ++-- .../components-reference/supported-conversation/openai.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md b/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md index 334b7cb9966..a6aaa2426bb 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md @@ -20,7 +20,7 @@ spec: - name: key value: "mykey" - name: model - value: claude-3-5-sonnet-20240620 + value: '${{DAPR_CONVERSATION_ANTHROPIC_MODEL}}' - name: cacheTTL value: 10m ``` @@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for Anthropic. | `"mykey"` | -| `model` | N | The Anthropic LLM to use. Defaults to `claude-3-5-sonnet-20240620` | `claude-3-5-sonnet-20240620` | +| `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}}` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md b/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md index 6429c84e87d..ae296983384 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md @@ -20,7 +20,7 @@ spec: - name: key value: mykey - name: model - value: meta-llama/Meta-Llama-3-8B + value: '${{DAPR_CONVERSATION_HUGGINGFACE_MODEL}}' - name: cacheTTL value: 10m ``` @@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for Huggingface. | `mykey` | -| `model` | N | The Huggingface LLM to use. Defaults to `meta-llama/Meta-Llama-3-8B`. | `meta-llama/Meta-Llama-3-8B` | +| `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}}` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md b/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md index 57504e56b3f..7baae91d790 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md @@ -20,7 +20,7 @@ spec: - name: key value: mykey - name: model - value: open-mistral-7b + value: '${{DAPR_CONVERSATION_MISTRAL_MODEL}}' - name: cacheTTL value: 10m ``` @@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for Mistral. | `mykey` | -| `model` | N | The Mistral LLM to use. Defaults to `open-mistral-7b`. | `open-mistral-7b` | +| `model` | N | The Mistral LLM to use. Defaults to `open-mistral-7b` (configurable via `DAPR_CONVERSATION_MISTRAL_MODEL` environment variable). | `${{DAPR_CONVERSATION_MISTRAL_MODEL}}` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md index 7148685b1bb..aa406d77d72 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md @@ -20,7 +20,7 @@ spec: - name: key value: mykey - name: model - value: gpt-4-turbo + value: '${{DAPR_CONVERSATION_OPENAI_MODEL}}' - name: cacheTTL value: 10m ``` @@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for OpenAI. | `mykey` | -| `model` | N | The OpenAI LLM to use. Defaults to `gpt-4-turbo`. | `gpt-4-turbo` | +| `model` | N | The OpenAI LLM to use. Defaults to `gpt-5-nano` (configurable via `DAPR_CONVERSATION_OPENAI_MODEL` environment variable). | `${{DAPR_CONVERSATION_OPENAI_MODEL}}` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links From 5820f48034a12b55a255a476b58734f8c2999e34 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Fri, 29 Aug 2025 09:13:42 +0000 Subject: [PATCH 2/9] docs(conversation): add GoogleAI and Ollama conversation component docs Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com> --- .../supported-conversation/googleai.md | 42 +++++++++++++++++++ .../supported-conversation/ollama.md | 39 +++++++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md create mode 100644 daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md new file mode 100644 index 00000000000..ae9d39870b3 --- /dev/null +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md @@ -0,0 +1,42 @@ +--- +type: docs +title: "GoogleAI" +linkTitle: "GoogleAI" +description: Detailed information on the GoogleAI conversation component +--- + +## Component format + +A Dapr `conversation.yaml` component file has the following structure: + +```yaml +apiVersion: dapr.io/v1alpha1 +kind: Component +metadata: + name: googleai +spec: + type: conversation.googleai + metadata: + - name: key + value: "mykey" + - name: model + value: '${{DAPR_CONVERSATION_GOOGLEAI_MODEL}}' + - name: cacheTTL + value: 10m +``` + +{{% alert title="Warning" color="warning" %}} +The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets, as described [here]({{< ref component-secrets.md >}}). +{{% /alert %}} + +## Spec metadata fields + +| Field | Required | Details | Example | +|--------------------|:--------:|---------|---------| +| `key` | Y | API key for GoogleAI. | `"mykey"` | +| `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}}` | +| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | + +## Related links + +- [Conversation API overview]({{< ref conversation-overview.md >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md b/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md new file mode 100644 index 00000000000..5614439c950 --- /dev/null +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md @@ -0,0 +1,39 @@ +--- +type: docs +title: "Ollama" +linkTitle: "Ollama" +description: Detailed information on the Ollama conversation component +--- + +## Component format + +A Dapr `conversation.yaml` component file has the following structure: + +```yaml +apiVersion: dapr.io/v1alpha1 +kind: Component +metadata: + name: ollama +spec: + type: conversation.ollama + metadata: + - name: model + value: '${{DAPR_CONVERSATION_OLLAMA_MODEL}}' + - name: cacheTTL + value: 10m +``` + +{{% alert title="Warning" color="warning" %}} +The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets, as described [here]({{< ref component-secrets.md >}}). +{{% /alert %}} + +## Spec metadata fields + +| Field | Required | Details | Example | +|--------------------|:--------:|---------|---------| +| `model` | N | The Ollama LLM to use. Defaults to `llama3.2:latest` (configurable via `DAPR_CONVERSATION_OLLAMA_MODEL` environment variable). | `${{DAPR_CONVERSATION_OLLAMA_MODEL}}` | +| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | + +## Related links + +- [Conversation API overview]({{< ref conversation-overview.md >}}) From a0d6cb290d7f7a850c947ae950362e35558ad87b Mon Sep 17 00:00:00 2001 From: Marc Duiker Date: Tue, 2 Sep 2025 23:21:13 +0200 Subject: [PATCH 3/9] Add kapa.ai script (#4853) Signed-off-by: Marc Duiker --- daprdocs/layouts/partials/hooks/head-end.html | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/daprdocs/layouts/partials/hooks/head-end.html b/daprdocs/layouts/partials/hooks/head-end.html index 03e91efa215..e13417c3671 100644 --- a/daprdocs/layouts/partials/hooks/head-end.html +++ b/daprdocs/layouts/partials/hooks/head-end.html @@ -1,3 +1,25 @@ {{ with .Site.Params.algolia_docsearch }} + + {{ end }} \ No newline at end of file From de42393ac260c7259f23d22b597a5606194cffdf Mon Sep 17 00:00:00 2001 From: Mustafa <100032108+TechyMT@users.noreply.github.com> Date: Mon, 8 Sep 2025 10:12:11 +0530 Subject: [PATCH 4/9] fix: update Redis documentation to reference latest Sentinel documentation links (#4860) Modified multiple Redis-related markdown files to update the links for the Sentinel master name documentation from the old URL to the latest version. This ensures users have access to the most current information regarding Redis Sentinel configuration. Signed-off-by: Mustafa --- .../components-reference/supported-bindings/redis.md | 2 +- .../redis-configuration-store.md | 2 +- .../components-reference/supported-locks/redis-lock.md | 4 ++-- .../supported-pubsub/setup-redis-pubsub.md | 2 +- .../supported-state-stores/setup-redis.md | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md index 4fc8dbb1b47..6d4d64bf2f8 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md @@ -46,7 +46,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | `clientCert` | N | Output | The content of the client certificate, used for Redis instances that require client-side certificates. Must be used with `clientKey` and `enableTLS` must be set to true. It is recommended to use a secret store as described [here]({{< ref component-secrets.md >}}) | `"----BEGIN CERTIFICATE-----\nMIIC..."` | | `clientKey` | N | Output | The content of the client private key, used in conjunction with `clientCert` for authentication. It is recommended to use a secret store as described [here]({{< ref component-secrets.md >}}) | `"----BEGIN PRIVATE KEY-----\nMIIE..."` | | `failover` | N | Output | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` -| `sentinelMasterName` | N | Output | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` +| `sentinelMasterName` | N | Output | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/latest/develop/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` | `redeliverInterval` | N | Output | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | `processingTimeout` | N | Output | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | `redisType` | N | Output | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` diff --git a/daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md b/daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md index 28965cb0e7b..153f7ce4223 100644 --- a/daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md +++ b/daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md @@ -46,7 +46,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | clientCert | N | Output | The content of the client certificate, used for Redis instances that require client-side certificates. Must be used with `clientKey` and `enableTLS` must be set to true. It is recommended to use a secret store as described [here]({{< ref component-secrets.md >}}) | `"----BEGIN CERTIFICATE-----\nMIIC..."` | | clientKey | N | Output | The content of the client private key, used in conjunction with `clientCert` for authentication. It is recommended to use a secret store as described [here]({{< ref component-secrets.md >}}) | `"----BEGIN PRIVATE KEY-----\nMIIE..."` | | failover | N | Output | Property to enabled failover configuration. Needs sentinelMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` -| sentinelMasterName | N | Output | The Sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` +| sentinelMasterName | N | Output | The Sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/latest/develop/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` | redisType | N | Output | The type of Redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for Redis cluster mode. Defaults to `"node"`. | `"cluster"` | redisDB | N | Output | Database selected after connecting to Redis. If `"redisType"` is `"cluster"`, this option is ignored. Defaults to `"0"`. | `"0"` | redisMaxRetries | N | Output | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` diff --git a/daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md b/daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md index fd499a2c71f..53d471331ec 100644 --- a/daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md +++ b/daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md @@ -88,8 +88,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr | enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` -| failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/). Defaults to `"false"` | `"true"`, `"false"` -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `"mymaster"` +| failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/). Defaults to `"false"` | `"true"`, `"false"` +| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/) | `"mymaster"` | redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md index 7ea8295630b..11e9e8f91e7 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md @@ -67,7 +67,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | idleTimeout | N | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | failover | N | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `""`, `"127.0.0.1:6379"` +| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/) | `""`, `"127.0.0.1:6379"` | maxLenApprox | N | Maximum number of items inside a stream.The old entries are automatically evicted when the specified length is reached, so that the stream is left at a constant size. Defaults to unlimited. | `"10000"` | streamTTL | N | TTL duration for stream entries. Entries older than this duration will be evicted. This is an approximate value, as it's implemented using Redis stream's `MINID` trimming with the '~' modifier. The actual retention may include slightly more entries than strictly defined by the TTL, as Redis optimizes the trimming operation for efficiency by potentially keeping some additional entries. | `"30d"` diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md index 9b672c6a6dc..0f01d8a916c 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md @@ -110,8 +110,8 @@ If you wish to use Redis as an actor store, append the following to the yaml. | clientKey | N | The content of the client private key, used in conjunction with `clientCert` for authentication. It is recommended to use a secret store as described [here]({{< ref component-secrets.md >}}) | `"----BEGIN PRIVATE KEY-----\nMIIE..."` | | maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` -| failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/). Defaults to `"false"` | `"true"`, `"false"` -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `""`, `"127.0.0.1:6379"` +| failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/). Defaults to `"false"` | `"true"`, `"false"` +| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/) | `""`, `"127.0.0.1:6379"` | redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` From 96eb17c96bc636457ab90d1a1e5db4503d0877c2 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Sun, 14 Sep 2025 02:06:35 +0000 Subject: [PATCH 5/9] 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 '' 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> --- .../supported-conversation/anthropic.md | 6 ++-- .../supported-conversation/googleai.md | 4 +-- .../supported-conversation/hugging-face.md | 6 ++-- .../supported-conversation/mistral.md | 6 ++-- .../supported-conversation/ollama.md | 4 +-- .../supported-conversation/openai.md | 30 +++++++++++++++++-- .../en/reference/environment/_index.md | 12 ++++++-- 7 files changed, 50 insertions(+), 18 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md b/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md index a6aaa2426bb..c31a2bffa19 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/anthropic.md @@ -20,7 +20,7 @@ spec: - name: key value: "mykey" - name: model - value: '${{DAPR_CONVERSATION_ANTHROPIC_MODEL}}' + value: 'claude-sonnet-4-20250514' - name: cacheTTL value: 10m ``` @@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for Anthropic. | `"mykey"` | -| `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}}` | +| `model` | N | The Anthropic LLM to use. Defaults to `claude-sonnet-4-20250514` (configurable via the `ANTHROPIC_MODEL` environment variable). | `claude-sonnet-4-20250514` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links -- [Conversation API overview]({{< ref conversation-overview.md >}}) \ No newline at end of file +- [Conversation API overview]({{< ref conversation-overview.md >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md index ae9d39870b3..a54b1822a82 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/googleai.md @@ -20,7 +20,7 @@ spec: - name: key value: "mykey" - name: model - value: '${{DAPR_CONVERSATION_GOOGLEAI_MODEL}}' + value: 'gemini-2.5-flash-lite' - name: cacheTTL value: 10m ``` @@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for GoogleAI. | `"mykey"` | -| `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}}` | +| `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` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md b/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md index ae296983384..ca0212f31a5 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/hugging-face.md @@ -20,7 +20,7 @@ spec: - name: key value: mykey - name: model - value: '${{DAPR_CONVERSATION_HUGGINGFACE_MODEL}}' + value: 'deepseek-ai/DeepSeek-R1-Distill-Qwen-32B' - name: cacheTTL value: 10m ``` @@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for Huggingface. | `mykey` | -| `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}}` | +| `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` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links -- [Conversation API overview]({{< ref conversation-overview.md >}}) \ No newline at end of file +- [Conversation API overview]({{< ref conversation-overview.md >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md b/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md index 7baae91d790..fca964c4d68 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/mistral.md @@ -20,7 +20,7 @@ spec: - name: key value: mykey - name: model - value: '${{DAPR_CONVERSATION_MISTRAL_MODEL}}' + value: 'open-mistral-7b' - name: cacheTTL value: 10m ``` @@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for Mistral. | `mykey` | -| `model` | N | The Mistral LLM to use. Defaults to `open-mistral-7b` (configurable via `DAPR_CONVERSATION_MISTRAL_MODEL` environment variable). | `${{DAPR_CONVERSATION_MISTRAL_MODEL}}` | +| `model` | N | The Mistral LLM to use. Defaults to `open-mistral-7b` (configurable via the `MISTRAL_MODEL` environment variable). | `open-mistral-7b` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links -- [Conversation API overview]({{< ref conversation-overview.md >}}) \ No newline at end of file +- [Conversation API overview]({{< ref conversation-overview.md >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md b/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md index 5614439c950..c58a04b3c24 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/ollama.md @@ -18,7 +18,7 @@ spec: type: conversation.ollama metadata: - name: model - value: '${{DAPR_CONVERSATION_OLLAMA_MODEL}}' + value: 'llama3.2:latest' - name: cacheTTL value: 10m ``` @@ -31,7 +31,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| `model` | N | The Ollama LLM to use. Defaults to `llama3.2:latest` (configurable via `DAPR_CONVERSATION_OLLAMA_MODEL` environment variable). | `${{DAPR_CONVERSATION_OLLAMA_MODEL}}` | +| `model` | N | The Ollama LLM to use. Defaults to `llama3.2:latest` (configurable via the `OLLAMA_MODEL` environment variable). | `llama3.2:latest` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md index aa406d77d72..dfdd33ab682 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md @@ -20,7 +20,7 @@ spec: - name: key value: mykey - name: model - value: '${{DAPR_CONVERSATION_OPENAI_MODEL}}' + value: 'gpt-5-nano' - name: cacheTTL value: 10m ``` @@ -34,9 +34,33 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | `key` | Y | API key for OpenAI. | `mykey` | -| `model` | N | The OpenAI LLM to use. Defaults to `gpt-5-nano` (configurable via `DAPR_CONVERSATION_OPENAI_MODEL` environment variable). | `${{DAPR_CONVERSATION_OPENAI_MODEL}}` | +| `model` | N | The OpenAI LLM to use. Defaults to `gpt-5-nano` (configurable via the `OPENAI_MODEL` environment variable). | `gpt-5-nano` | | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | +## Azure OpenAI usage + +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. + +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. + +Example (Azure OpenAI configuration): + +```yaml +spec: + type: conversation.openai + metadata: + - name: apiType + value: azure + - name: key + value: "" + - name: endpoint + value: "https://.openai.azure.com/" + - name: model + value: '${{AZURE_OPENAI_MODEL}}' +``` + +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. + ## Related links -- [Conversation API overview]({{< ref conversation-overview.md >}}) \ No newline at end of file +- [Conversation API overview]({{< ref conversation-overview.md >}}) diff --git a/daprdocs/content/en/reference/environment/_index.md b/daprdocs/content/en/reference/environment/_index.md index d5ed2d529c1..fc834b69a26 100644 --- a/daprdocs/content/en/reference/environment/_index.md +++ b/daprdocs/content/en/reference/environment/_index.md @@ -21,7 +21,7 @@ The following table lists the environment variables used by the Dapr runtime, CL | 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.| | 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`| | 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| -| 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| +| 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| | OTEL_EXPORTER_OTLP_ENDPOINT | OpenTelemetry Tracing | Sets the Open Telemetry (OTEL) server address, turns on tracing. (Example: `http://localhost:4318`) | | OTEL_EXPORTER_OTLP_INSECURE | OpenTelemetry Tracing | Sets the connection to the endpoint as unencrypted. (`true`, `false`) | | OTEL_EXPORTER_OTLP_PROTOCOL | OpenTelemetry Tracing | The OTLP protocol to use Transport protocol. (`grpc`, `http/protobuf`, `http/json`) | @@ -29,4 +29,12 @@ The following table lists the environment variables used by the Dapr runtime, CL | 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. | | 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 >}}) | | 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.| -| DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. | \ No newline at end of file +| DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. | +| 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`. | +| 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`. | +| 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`. | +| 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`. | +| 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`. | +| 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`. | +| 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`. | + \ No newline at end of file From 6900861ed7ff7afe683f765ea3e7f0efb283f1a9 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Tue, 16 Sep 2025 01:15:09 +0200 Subject: [PATCH 6/9] Update daprdocs/content/en/reference/components-reference/supported-conversation/openai.md Co-authored-by: Sam Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com> --- .../components-reference/supported-conversation/openai.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md index dfdd33ab682..deefb723cb8 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md @@ -41,7 +41,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr 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. -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. +When `apiType: azure` is used, the environment variable `OPENAI_MODEL` may be set to provide a default Azure model identifier to use if the component's `model` metadata is not provided. In addition, the corresponding `endpoint` and `apiVersion` fields will be set to Azure specific settings. Example (Azure OpenAI configuration): From e716abf17c08a6af2c05b973382bcd255fae4d10 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Tue, 16 Sep 2025 01:15:19 +0200 Subject: [PATCH 7/9] Update daprdocs/content/en/reference/components-reference/supported-conversation/openai.md Co-authored-by: Sam Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com> --- .../components-reference/supported-conversation/openai.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md index deefb723cb8..83a7a6a2d17 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md @@ -56,7 +56,7 @@ spec: - name: endpoint value: "https://.openai.azure.com/" - name: model - value: '${{AZURE_OPENAI_MODEL}}' + value: 'gpt-4.1-nano' ``` 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. From cf9ac4926ccfddbc63fdd7439d1594b1854508e0 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Tue, 16 Sep 2025 01:15:32 +0200 Subject: [PATCH 8/9] Update daprdocs/content/en/reference/components-reference/supported-conversation/openai.md Co-authored-by: Sam Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com> --- .../components-reference/supported-conversation/openai.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md index 83a7a6a2d17..a9eeefb76f2 100644 --- a/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md +++ b/daprdocs/content/en/reference/components-reference/supported-conversation/openai.md @@ -59,7 +59,7 @@ spec: value: 'gpt-4.1-nano' ``` -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. +If `model` is omitted from the component metadata and the model environment variable is not set, then the component falls back to its built-in default model. ## Related links From 30b4cf4d1d738448dfe3cc92ad70b609b3eff457 Mon Sep 17 00:00:00 2001 From: Erin La <107987318+giterinhub@users.noreply.github.com> Date: Mon, 15 Sep 2025 23:18:30 +0000 Subject: [PATCH 9/9] docs(environment): remove AZURE_OPENAI_MODEL variable from reference Signed-off-by: GitHub --- daprdocs/content/en/reference/environment/_index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/daprdocs/content/en/reference/environment/_index.md b/daprdocs/content/en/reference/environment/_index.md index fc834b69a26..8fa2731546b 100644 --- a/daprdocs/content/en/reference/environment/_index.md +++ b/daprdocs/content/en/reference/environment/_index.md @@ -31,7 +31,6 @@ The following table lists the environment variables used by the Dapr runtime, CL | 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.| | DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. | | 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`. | -| 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`. | | 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`. | | 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`. | | 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`. |