forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an AWS Bedrock Processor similar to the other AI processors that exist out there.
- Loading branch information
Showing
4 changed files
with
389 additions
and
15 deletions.
There are no files selected for viewing
211 changes: 211 additions & 0 deletions
211
docs/modules/components/pages/processors/aws_bedrock_chat.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| = aws_bedrock_chat | ||
| :type: processor | ||
| :status: experimental | ||
| :categories: ["AI"] | ||
|
|
||
|
|
||
|
|
||
| //// | ||
| THIS FILE IS AUTOGENERATED! | ||
|
|
||
| To make changes, edit the corresponding source file under: | ||
|
|
||
| https://github.com/redpanda-data/connect/tree/main/internal/impl/<provider>. | ||
|
|
||
| And: | ||
|
|
||
| https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl | ||
| //// | ||
| // © 2024 Redpanda Data Inc. | ||
| component_type_dropdown::[] | ||
| Generates responses to messages in a chat conversation, using the AWS Bedrock API. | ||
| Introduced in version 4.33.0. | ||
| [tabs] | ||
| ====== | ||
| Common:: | ||
| + | ||
| -- | ||
| ```yml | ||
| # Common config fields, showing default values | ||
| label: "" | ||
| aws_bedrock_chat: | ||
| model: amazon.titan-text-express-v1 # No default (required) | ||
| prompt: "" # No default (optional) | ||
| system_prompt: "" # No default (optional) | ||
| ``` | ||
| -- | ||
| Advanced:: | ||
| + | ||
| -- | ||
| ```yml | ||
| # All config fields, showing default values | ||
| label: "" | ||
| aws_bedrock_chat: | ||
| region: "" | ||
| endpoint: "" | ||
| credentials: | ||
| profile: "" | ||
| id: "" | ||
| secret: "" | ||
| token: "" | ||
| from_ec2_role: false | ||
| role: "" | ||
| role_external_id: "" | ||
| model: amazon.titan-text-express-v1 # No default (required) | ||
| prompt: "" # No default (optional) | ||
| system_prompt: "" # No default (optional) | ||
| ``` | ||
| -- | ||
| ====== | ||
| This processor sends prompts to your chosen large language model (LLM) and generates text from the responses, using the AWS Bedrock API. | ||
| For more information, see the https://docs.aws.amazon.com/bedrock/latest/userguide[AWS Bedrock documentation^]. | ||
| == Fields | ||
| === `region` | ||
| The AWS region to target. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `endpoint` | ||
| Allows you to specify a custom endpoint for the AWS API. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `credentials` | ||
| Optional manual configuration of AWS credentials to use. More information can be found in xref:guides:cloud/aws.adoc[]. | ||
| *Type*: `object` | ||
| === `credentials.profile` | ||
| A profile from `~/.aws/credentials` to use. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `credentials.id` | ||
| The ID of credentials to use. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `credentials.secret` | ||
| The secret for the credentials being used. | ||
| [CAUTION] | ||
| ==== | ||
| This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info]. | ||
| ==== | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `credentials.token` | ||
| The token for the credentials being used, required when using short term credentials. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `credentials.from_ec2_role` | ||
| Use the credentials of a host EC2 machine configured to assume https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html[an IAM role associated with the instance^]. | ||
| *Type*: `bool` | ||
| *Default*: `false` | ||
| Requires version 4.2.0 or newer | ||
| === `credentials.role` | ||
| A role ARN to assume. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `credentials.role_external_id` | ||
| An external ID to provide when assuming a role. | ||
| *Type*: `string` | ||
| *Default*: `""` | ||
| === `model` | ||
| The model ID to use. For a full list see the https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html[AWS Bedrock documentation^]. | ||
| *Type*: `string` | ||
| ```yml | ||
| # Examples | ||
| model: amazon.titan-text-express-v1 | ||
| model: anthropic.claude-3-5-sonnet-20240620-v1:0 | ||
| model: cohere.command-text-v14 | ||
| model: meta.llama3-1-70b-instruct-v1:0 | ||
| model: mistral.mistral-large-2402-v1:0 | ||
| ``` | ||
| === `prompt` | ||
| The prompt you want to generate a response for. By default, the processor submits the entire payload as a string. | ||
| *Type*: `string` | ||
| === `system_prompt` | ||
| The system prompt to submit to the AWS Bedrock LLM. | ||
| *Type*: `string` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.