mirror of https://github.com/dapr/docs.git
updates from Yaron
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
parent
9a2e489893
commit
e5c0ad3b2a
|
@ -32,9 +32,19 @@ POST /v1.0-alpha1/conversation/<llm-name>/converse
|
||||||
| --------- | ----------- |
|
| --------- | ----------- |
|
||||||
| `conversationContext` | The ID of an existing chat room (like in ChatGPT). |
|
| `conversationContext` | The ID of an existing chat room (like in ChatGPT). |
|
||||||
| `inputs` | Inputs for the conversation. Multiple inputs at one time are supported. |
|
| `inputs` | Inputs for the conversation. Multiple inputs at one time are supported. |
|
||||||
| `parameters` | Parameters for all custom fields. |
|
| `metadata` | [Metadata](#metadata) passed to conversation components. |
|
||||||
| `metadata` | Metadata passed to conversation components. Values include `model`, `key`, `endpoint`, and `cacheTTL` |
|
|
||||||
|
|
||||||
|
#### Metadata
|
||||||
|
|
||||||
|
Metadata can be sent in the request’s URL. It must be prefixed with `metadata.`, as shown in the table below.
|
||||||
|
|
||||||
|
| Parameter | Description |
|
||||||
|
| --------- | ----------- |
|
||||||
|
| `metadata.key` | The API key for the component. `key` is not applicable to the [AWS Bedrock component]({{< ref "aws-bedrock.md#authenticating-aws" >}}). |
|
||||||
|
| `metadata.model` | The Large Language Model you're using. Value depends on which conversation component you're using. `model` is not applicable to the [DeepSeek component]({{< ref deepseek.md >}}). |
|
||||||
|
| `metadata.cacheTTL` | A time-to-live value for a prompt cache to expire. Uses Golang duration format. |
|
||||||
|
|
||||||
|
The metadata parameters available depend on the conversation component you use. [See all the supported components for the conversation API.]({{< ref supported-conversation >}})
|
||||||
|
|
||||||
### Request content
|
### Request content
|
||||||
|
|
||||||
|
|
|
@ -37,6 +37,10 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
||||||
| `model` | N | The LLM to use. Defaults to Bedrock's default provider model from Amazon. | `amazon.titan-text-express-v1` |
|
| `model` | N | The LLM to use. Defaults to Bedrock's default provider model from Amazon. | `amazon.titan-text-express-v1` |
|
||||||
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
|
| `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` |
|
||||||
|
|
||||||
|
## Authenticating AWS
|
||||||
|
|
||||||
|
Instead of using a `key` parameter, AWS Bedrock authenticates using Dapr's standard method of IAM or static credentials. [Learn more about authenticating with AWS.]({{< ref authenticating-aws.md >}})
|
||||||
|
|
||||||
## Related links
|
## Related links
|
||||||
|
|
||||||
- [Conversation API overview]({{< ref conversation-overview.md >}})
|
- [Conversation API overview]({{< ref conversation-overview.md >}})
|
|
@ -32,7 +32,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
||||||
| Field | Required | Details | Example |
|
| Field | Required | Details | Example |
|
||||||
|--------------------|:--------:|---------|---------|
|
|--------------------|:--------:|---------|---------|
|
||||||
| `key` | Y | API key for DeepSeek. | `mykey` |
|
| `key` | Y | API key for DeepSeek. | `mykey` |
|
||||||
| `maxToken` | N | The max amount of tokens for each request. | `2048` |
|
| `maxTokens` | N | The max amount of tokens for each request. | `2048` |
|
||||||
|
|
||||||
## Related links
|
## Related links
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue