mirror of https://github.com/dapr/docs.git
inital docs
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
Hannah Hunter
parent
1632f50784
commit
7bb54b0287
|
|
@ -31,3 +31,4 @@ Dapr provides the following building blocks:
|
|||
| [**Distributed lock**]({{< ref "distributed-lock-api-overview.md" >}}) | `/v1.0-alpha1/lock` | The distributed lock API enables you to take a lock on a resource so that multiple instances of an application can access the resource without conflicts and provide consistency guarantees.
|
||||
| [**Cryptography**]({{< ref "cryptography-overview.md" >}}) | `/v1.0-alpha1/crypto` | The Cryptography API enables you to perform cryptographic operations, such as encrypting and decrypting messages, without exposing keys to your application.
|
||||
| [**Jobs**]({{< ref "jobs-overview.md" >}}) | `/v1.0-alpha1/jobs` | The Jobs API enables you to schedule and orchestrate jobs. Example scenarios include: <ul><li>Schedule batch processing jobs to run every business day</li><li>Schedule various maintenance scripts to perform clean-ups</li><li>Schedule ETL jobs to run at specific times (hourly, daily) to fetch new data, process it, and update the data warehouse with the latest information.</li></ul>
|
||||
| [**Conversational**]({{< ref "conversational-overview.md" >}}) | `/v1.0-alpha1/conversation` | The Conversational API provides a common way to converse with different large language model providers.
|
||||
|
|
@ -137,3 +137,10 @@ Dapr allows custom [middleware]({{< ref "middleware.md" >}}) to be plugged into
|
|||
{{% alert title="Note" color="primary" %}}
|
||||
Since pluggable components are not required to be written in Go, they follow a different implementation process than built-in Dapr components. For more information on developing built-in components, read [developing new components](https://github.com/dapr/components-contrib/blob/master/docs/developing-component.md).
|
||||
{{% /alert %}}
|
||||
|
||||
### Conversational
|
||||
|
||||
Dapr provides a way for developers to migrate and converse between different large language model servers and toolkits.
|
||||
|
||||
- [List of supported conversational components]({{< ref supported-conversational >}})
|
||||
- [Conversational implementations](https://github.com/dapr/components-contrib/tree/main/conversation)
|
||||
|
|
@ -55,6 +55,7 @@ Each of these building block APIs is independent, meaning that you can use any n
|
|||
| [**Distributed lock**]({{< ref "distributed-lock-api-overview.md" >}}) | The distributed lock API enables your application to acquire a lock for any resource that gives it exclusive access until either the lock is released by the application, or a lease timeout occurs.
|
||||
| [**Cryptography**]({{< ref "cryptography-overview.md" >}}) | The cryptography API provides an abstraction layer on top of security infrastructure such as key vaults. It contains APIs that allow you to perform cryptographic operations, such as encrypting and decrypting messages, without exposing keys to your applications.
|
||||
| [**Jobs**]({{< ref "jobs-overview.md" >}}) | The jobs API enables you to schedule jobs at specific times or intervals.
|
||||
| [**Conversational**]({{< ref "conversational-overview.md" >}}) | The conversational API enables you to migrate between large language model servers and toolkits.
|
||||
|
||||
### Cross-cutting APIs
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Conversational"
|
||||
linkTitle: "Conversational"
|
||||
weight: 130
|
||||
description: "Consistently leverage Large Language Models services"
|
||||
---
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Conversational overview"
|
||||
linkTitle: "Overview"
|
||||
weight: 1000
|
||||
description: "Overview of the conversational API building block"
|
||||
---
|
||||
|
||||
Many large language model servers or toolkits provide their own APIs. Due to hardcode and API differences, migrating between these servers or toolkits can prove difficult.
|
||||
|
||||
The conversational API building block works as an abstraction layer across those APIs to ease migration.
|
||||
|
||||
## Features
|
||||
|
||||
|
||||
## Try out pub/sub
|
||||
|
||||
### Quickstarts and tutorials
|
||||
|
||||
Want to put the Dapr conversational API to the test? Walk through the following quickstart and tutorials to see it in action:
|
||||
|
||||
| Quickstart/tutorial | Description |
|
||||
| ------------------- | ----------- |
|
||||
| [Conversational quickstart](todo) | . |
|
||||
|
||||
### Start using pub/sub directly in your app
|
||||
|
||||
Want to skip the quickstarts? Not a problem. You can try out the conversational building block directly in your application. After [Dapr is installed]({{< ref "getting-started/_index.md" >}}), you can begin using the conversational API starting with [the how-to guide](todo).
|
||||
|
||||
## Next steps
|
||||
|
||||
- [How-To: Migrate between large language models]({{< ref howto-conversational-layer.md >}})
|
||||
- [Conversational API components]({{< ref supported-conversational >}})
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
type: docs
|
||||
title: "How-To: Migrate using the conversational API"
|
||||
linkTitle: "How-To: Migrate"
|
||||
weight: 2000
|
||||
description: "Learn how to use the conversational API to migrate between large language model servers and toolkits"
|
||||
---
|
||||
|
||||
todo
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Conversational component specs"
|
||||
linkTitle: "Conversational"
|
||||
weight: 9000
|
||||
description: The supported conversational components that interface with Dapr
|
||||
no_list: true
|
||||
---
|
||||
|
||||
{{< partial "components/description.html" >}}
|
||||
|
||||
{{< partial "components/conversational.html" >}}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Anthropic"
|
||||
linkTitle: "Anthropic"
|
||||
description: Detailed information on the Anthropic conversational component
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: docs
|
||||
title: "AWS Bedrock"
|
||||
linkTitle: "AWS Bedrock"
|
||||
description: Detailed information on the AWS Bedrock conversational component
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Echo"
|
||||
linkTitle: "Echo"
|
||||
description: Detailed information on the Echo conversational component
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Hugging Face"
|
||||
linkTitle: "Hugging Face"
|
||||
description: Detailed information on the Hugging Face conversational component
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Mistral"
|
||||
linkTitle: "Mistral"
|
||||
description: Detailed information on the Mistral conversational component
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
type: docs
|
||||
title: "OpenAI"
|
||||
linkTitle: "OpenAI"
|
||||
description: Detailed information on the OpenAI conversational component
|
||||
---
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
- component: AWS Bedrock
|
||||
link: aws-bedrock
|
||||
state: Alpha
|
||||
version: v1
|
||||
since: "1.15"
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
- component: Echo
|
||||
link: echo
|
||||
state: Alpha
|
||||
version: v1
|
||||
since: "1.15"
|
||||
- component: Hugging Face
|
||||
link: hugging-face
|
||||
state: Alpha
|
||||
version: v1
|
||||
since: "1.15"
|
||||
- component: Mistral
|
||||
link: mistral
|
||||
state: Alpha
|
||||
version: v1
|
||||
since: "1.15"
|
||||
- component: OpenAI
|
||||
link: openai
|
||||
state: Alpha
|
||||
version: v1
|
||||
since: "1.15"
|
||||
- component: Anthropic
|
||||
link: anthropic
|
||||
state: Alpha
|
||||
version: v1
|
||||
since: "1.15"
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{{- $groups := dict
|
||||
"Generic" $.Site.Data.components.conversational.generic
|
||||
"Amazon Web Services (AWS)" $.Site.Data.components.conversational.aws
|
||||
|
||||
}}
|
||||
|
||||
{{ range $group, $components := $groups }}
|
||||
<h3>{{ $group }}</h3>
|
||||
<table width="100%">
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Status</th>
|
||||
<th>Component version</th>
|
||||
<th>Since runtime version</th>
|
||||
</tr>
|
||||
{{ range sort $components "component" }}
|
||||
<tr>
|
||||
<td><a href="/reference/components-reference/supported-conversational/{{ .link }}/">{{ .component }}</a>
|
||||
</td>
|
||||
<td>{{ .state }}</td>
|
||||
<td>{{ .version }}</td>
|
||||
<td>{{ .since }}</td>
|
||||
</tr>
|
||||
{{ end }}
|
||||
</table>
|
||||
{{ end }}
|
||||
|
||||
{{ partial "components/componenttoc.html" . }}
|
||||
Loading…
Reference in New Issue