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..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: claude-3-5-sonnet-20240620 + 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` | `claude-3-5-sonnet-20240620` | +| `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 new file mode 100644 index 00000000000..a54b1822a82 --- /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: 'gemini-2.5-flash-lite' + - 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-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 + +- [Conversation API overview]({{< ref conversation-overview.md >}}) 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..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: meta-llama/Meta-Llama-3-8B + 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 `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 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 57504e56b3f..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: open-mistral-7b + 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`. | `open-mistral-7b` | +| `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 new file mode 100644 index 00000000000..c58a04b3c24 --- /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: 'llama3.2:latest' + - 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 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 + +- [Conversation API overview]({{< ref conversation-overview.md >}}) 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..a9eeefb76f2 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: '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-4-turbo`. | `gpt-4-turbo` | +| `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 `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): + +```yaml +spec: + type: conversation.openai + metadata: + - name: apiType + value: azure + - name: key + value: "" + - name: endpoint + value: "https://.openai.azure.com/" + - name: model + value: 'gpt-4.1-nano' +``` + +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 -- [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..8fa2731546b 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,11 @@ 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`. | +| 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