Skip to content

Commit 5820f48

Browse files
authored
docs(conversation): add GoogleAI and Ollama conversation component docs
Signed-off-by: Erin La <107987318+giterinhub@users.noreply.github.com>
1 parent d690323 commit 5820f48

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
type: docs
3+
title: "GoogleAI"
4+
linkTitle: "GoogleAI"
5+
description: Detailed information on the GoogleAI conversation component
6+
---
7+
8+
## Component format
9+
10+
A Dapr `conversation.yaml` component file has the following structure:
11+
12+
```yaml
13+
apiVersion: dapr.io/v1alpha1
14+
kind: Component
15+
metadata:
16+
name: googleai
17+
spec:
18+
type: conversation.googleai
19+
metadata:
20+
- name: key
21+
value: "mykey"
22+
- name: model
23+
value: '${{DAPR_CONVERSATION_GOOGLEAI_MODEL}}'
24+
- name: cacheTTL
25+
value: 10m
26+
```
27+
28+
{{% alert title="Warning" color="warning" %}}
29+
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 >}}).
30+
{{% /alert %}}
31+
32+
## Spec metadata fields
33+
34+
| Field | Required | Details | Example |
35+
|--------------------|:--------:|---------|---------|
36+
| `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}}` |
38+
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
39+
40+
## Related links
41+
42+
- [Conversation API overview]({{< ref conversation-overview.md >}})
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
type: docs
3+
title: "Ollama"
4+
linkTitle: "Ollama"
5+
description: Detailed information on the Ollama conversation component
6+
---
7+
8+
## Component format
9+
10+
A Dapr `conversation.yaml` component file has the following structure:
11+
12+
```yaml
13+
apiVersion: dapr.io/v1alpha1
14+
kind: Component
15+
metadata:
16+
name: ollama
17+
spec:
18+
type: conversation.ollama
19+
metadata:
20+
- name: model
21+
value: '${{DAPR_CONVERSATION_OLLAMA_MODEL}}'
22+
- name: cacheTTL
23+
value: 10m
24+
```
25+
26+
{{% alert title="Warning" color="warning" %}}
27+
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 >}}).
28+
{{% /alert %}}
29+
30+
## Spec metadata fields
31+
32+
| Field | Required | Details | Example |
33+
|--------------------|:--------:|---------|---------|
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}}` |
35+
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
36+
37+
## Related links
38+
39+
- [Conversation API overview]({{< ref conversation-overview.md >}})

0 commit comments

Comments
 (0)