This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 0982f58426f731837269624a8824bb85f04cbadc Author: Andrea Cosentino <[email protected]> AuthorDate: Fri Mar 8 12:05:31 2024 +0100 CAMEL-20536 - Camel-AWS-Bedrock: Add the component for Bedrock Agent Signed-off-by: Andrea Cosentino <[email protected]> --- .../src/main/docs/aws-bedrock-agent-component.adoc | 102 +++++++++++++++++++++ 1 file changed, 102 insertions(+) diff --git a/components/camel-aws/camel-aws-bedrock/src/main/docs/aws-bedrock-agent-component.adoc b/components/camel-aws/camel-aws-bedrock/src/main/docs/aws-bedrock-agent-component.adoc new file mode 100644 index 00000000000..1ce7804ffc0 --- /dev/null +++ b/components/camel-aws/camel-aws-bedrock/src/main/docs/aws-bedrock-agent-component.adoc @@ -0,0 +1,102 @@ += AWS Bedrock Agent Component +:doctitle: AWS Bedrock Agent +:shortname: aws-bedrock-agent +:artifactid: camel-aws-bedrock +:description: Invoke Model of AWS Bedrock Agent Runtime service. +:since: 4.5 +:supportlevel: Preview +:tabs-sync-option: +:component-header: Only producer is supported +//Manually maintained attributes +:group: AWS +:camel-spring-boot-name: aws-bedrock + +*Since Camel {since}* + +*{component-header}* + +The AWS2 Bedrock component supports invoking a supported LLM model from +https://aws.amazon.com/bedrock/[AWS Bedrock] service. + +Prerequisites + +You must have a valid Amazon Web Services developer account, and be +signed up to use Amazon Bedrock. More information is available at +https://aws.amazon.com/bedrock/[Amazon Bedrock]. + + +== URI Format + +------------------------- +aws-bedrock-agent-runtime://label[?options] +------------------------- + +You can append query options to the URI in the following format: + +`?options=value&option2=value&...` + + +// component-configure options: START + +// component-configure options: END + +// component options: START +include::partial$component-configure-options.adoc[] +include::partial$component-endpoint-options.adoc[] +// component options: END + +// endpoint options: START + +// endpoint options: END + + +Required Bedrock component options + +You have to provide the bedrockRuntimeClient in the +Registry or your accessKey and secretKey to access +the https://aws.amazon.com/bedrock/[Amazon Bedrock] service. + +== Usage + +=== Static credentials, Default Credential Provider and Profile Credentials Provider + +You have the possibility of avoiding the usage of 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.accessKeyId` and `aws.secretKey`. + - Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_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_URI` is set. + - Amazon EC2 Instance profile credentials. + +You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name. + +Only one of static, default and profile credentials could be used at the same time. + +For more information about this you can look at https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS credentials documentation] + +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END + +== Dependencies + +Maven users will need to add the following dependency to their pom.xml. + +*pom.xml* + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws-bedrock</artifactId> + <version>${camel-version}</version> +</dependency> +--------------------------------------- + +where `$\{camel-version}` must be replaced by the actual version of Camel. + + +include::spring-boot:partial$starter.adoc[]
