AWS Bedrock Text Sink
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Sends a prompt to a text model in Amazon Bedrock, such as Amazon Titan or Anthropic Claude, for each message, and gives the answer of the model.
Use it to summarize, classify, translate or write text with a large language model, for example to summarize support tickets or draft replies. To answer questions from your own documents in a Bedrock knowledge base, use aws-bedrock-agent-runtime-sink.
Input: the body is the request of the model, as JSON text in the format of the chosen model, not the bare prompt. For Amazon Titan, for example {"inputText":"Summarize: …","textGenerationConfig":{"maxTokenCount":500}}. For Claude 3, the Messages format, for example {"anthropic_version":"bedrock-2023-05-31","max_tokens":500,"messages":[{"role":"user","content":"Summarize: …"}]}. With operation set to converse, the body is the prompt itself, as text, such as Summarize: …, whatever the model.
Output: when it is used inside a route, the body afterwards is the answer, in a form that depends on the model: for Titan the response as JSON text, with the generated text in results; for Claude 3 the response as parsed JSON, with the generated text in content; for the older Claude models only the generated text, as text. With converse, the generated text, as text, and the CamelAwsBedrockConverseStopReason header says why the model stopped, such as end_turn, or guardrail_intervened when the guardrail blocked the prompt or the answer: the body is then the message that the guardrail is configured to give.
Good to know: with invokeTextModel, the request and response formats are those of the model provider, described for each model in the Amazon Bedrock documentation; a body in another format fails. A guardrail (guardrailIdentifier) works only with converse. Each message is one call of the model. To reach AWS through an HTTP proxy, set proxyHost and proxyPort, and set proxyProtocol to HTTP for a proxy that takes plain HTTP, such as Squid. Headers that start with CamelAwsBedrock are removed from the message first, so they cannot change what the Kamelet does.
Configuration Options
The following table summarizes the configuration options available for the aws-bedrock-text-sink Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
Model ID | Required The ID of the Bedrock text model to call. The body must be a request in the format of this model: Amazon Titan ( Enum values: * amazon.titan-text-express-v1 * amazon.titan-text-lite-v1 * ai21.j2-ultra-v1 * ai21.j2-mid-v1 * anthropic.claude-instant-v1 * anthropic.claude-v2 * anthropic.claude-v2:1 * anthropic.claude-3-sonnet-20240229-v1:0 | string | |||
AWS Region | Required The AWS region of Amazon Bedrock to use, such as Enum values: * us-east-1 * us-west-1 * ap-southeast-1 * ap-northeast-1 * eu-central-1 | string | us-east-1 | ||
Access Key | The access key ID of an IAM user, which AWS gives when you create an access key for the user (in the AWS console: IAM, Users, Security credentials). Use it together with | string | |||
Guardrail Identifier | The ID or ARN of an Amazon Bedrock guardrail that checks the prompt and the answer, for example to block a topic or to hide personal data. Only used when | string | gr-abc123xyz | ||
Guardrail Trace | If true, Bedrock reports what the guardrail found, in the | boolean | |||
Guardrail Version | The version of the guardrail in | string | 1 | ||
Operation | How the model is called. Enum values: * invokeTextModel * converse | string | invokeTextModel | ||
Endpoint Overwrite | If true, the requests go to the address in | boolean | false | ||
Profile Credentials Name | The name of the profile to use from the AWS credentials file. Only used when | string | |||
Proxy Host | The host name or IP address of an HTTP proxy to send the calls to AWS through, such as the proxy of a company network. Used only together with | string | proxy.example.com | ||
Proxy Port | The port of the proxy in | integer | 3128 | ||
Proxy Protocol | How to talk to the proxy itself: Enum values: * HTTP * HTTPS | string | HTTP | ||
Secret Key | The secret access key that goes with | string | |||
Session Token | The session token of temporary credentials, which AWS gives together with their access key and secret key. Only used when | string | |||
Overwrite Endpoint URI | The address to send the requests to instead of the usual AWS address, such as | string | http://localhost:4566 | ||
Default Credentials Provider | If true, the credentials are found the way the AWS SDK finds them: from the | boolean | false | ||
Profile Credentials Provider | If true, the credentials are read from a profile of the AWS credentials file ( | boolean | false | ||
Session Credentials | If true, it logs in with temporary credentials, such as those of an assumed IAM role: | boolean | false |
Dependencies
At runtime, the aws-bedrock-text-sink Kamelet relies upon the presence of the following dependencies:
-
camel:jackson3
-
camel:aws-bedrock
-
camel:kamelet
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:aws-bedrock-text-sink" You can now run it directly through the following command
camel run route.yaml AWS Bedrock Text Sink Kamelet Description
Authentication methods
In this Kamelet you can avoid using explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.
The order of evaluation for Default Credentials Provider is the following:
-
Java system properties -
aws.accessKeyIdandaws.secretKey. -
Environment variables -
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEY. -
Web Identity Token from AWS STS.
-
The shared credentials and config files.
-
Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable
AWS_CONTAINER_CREDENTIALS_RELATIVE_URIis set. -
Amazon EC2 Instance profile credentials.
You can also use the Profile Credentials Provider, by setting the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.
Only one of access key/secret key or default credentials provider could be used
For more information, see the AWS credentials documentation
Through an HTTP Proxy
Where AWS can be reached only through an HTTP proxy, as in many company networks, set proxyHost and proxyPort to the proxy. proxyProtocol is how the Kamelet talks to the proxy itself, not to AWS: it is HTTPS when it is not set, so set it to HTTP for a proxy that takes plain HTTP, such as Squid. The calls to AWS stay encrypted, as the proxy only passes them on. The Kamelet has no option for a proxy user or password.
The step that sends to the Kamelet, in a route:
- to:
uri: "kamelet:aws-bedrock-text-sink"
parameters:
modelId: "anthropic.claude-v2"
region: "eu-west-1"
useDefaultCredentialsProvider: true
proxyHost: "proxy.example.com"
proxyPort: 3128
proxyProtocol: "HTTP"