Creating an Amazon Bedrock - Converse API connection
To communicate with Amazon Bedrock, create a connection to the Amazon Bedrock - Converse API analytics source. Create the connection in the Create page of the Analytics activity center, Data load editor, or Script.
Configurable settings
For full details about configuring externally controlled parameters, see:
-
Using the Converse API: Learn about configuration parameters specific to the Converse API.
-
Inference request parameters and response fields for foundation models: Learn about configuration parameters specific to the model you are using.
| Field | Description and options |
|---|---|
| Model ID or ARN |
Enter the ID or ARN of the model you want to use. This information can be found on the model card page in the Amazon Bedrock console. Models hosted on Amazon Bedrock Marketplace are supported. After you have deployed a model, its ARN can be obtained from the Amazon Bedrock console. Cross-region inference (CRIS) is supported for the model you are using. Not all models are available in every region. |
| AWS Region | Choose the appropriate geographical region where the AWS resources are hosted. |
| Use FIPS Endpoint (US Regions Only) | Select whether communication between the connection and AWS uses encryption compliant with some version of the Federal Information Processing Standard (FIPS). |
| Authentication Method | Choose how the connection is authenticated. You can select AWS Auth v4 Signature (default) or Bedrock API Key. |
| AWS Access Key |
Applicable when the Authentication Method is set to AWS Auth v4 Signature (default). Enter the AWS Access Key ID, which is one part of the access key pair (the other being the secret key) that you will need to provide as credentials to authenticate the AWS account. |
| AWS Secret Key |
Applicable when the Authentication Method is set to AWS Auth v4 Signature (default). Enter the AWS Secret Key, which is one part of the access key pair (the other being the Access Key ID) that you will need to provide as credentials to authenticate the AWS account. |
| Bedrock API Key |
Applicable when the Authentication Method is set to Bedrock API Key. Enter the API key from Amazon Bedrock. |
| System Prompt | Optional parameter. This is a text field in which you can insert contextual information and additional guidelines that you want the provide to the model before you provide it with the prompt. For more information, refer to the official Converse API documentation. |
| Maximum Token Count | Set the length of the response generated by the model. |
| Temperature |
Control the randomness of the response from the model. Generally, the lower the value, the lower the randomness. The settings to use depend on how this parameter is configured for the specific model you are using. For more information, see the Amazon Bedrock documentation. |
|
Top P |
Control how probable the token usage is. Generally, a lower value leads to higher exclusion of less probable tokens. The settings to use depend on how this parameter is configured for the specific model you are using. For more information, see the Amazon Bedrock documentation. |
| Configuration - Guardrails |
The Amazon Bedrock - Converse API connector supports guardrails configured within the Amazon Bedrock console. Guardrails are applied to requests. Guardrails help protect users of the model against malicious and inappropriate content. The following settings can be configured:
Guardrails are not available for all Amazon Bedrock models. |
| Association Field |
Specify an association field, a field from the input data table containing a unique identifier. It is required to include this field in the source data when making an endpoint request for the results table returned to be associated with the source field table using a key. The designated field will be returned as a field in the response and enable the response to be associated with the source data in the data model. This can be any field with a unique ID, either from the source data or as part of the table load process. |
| Name | The name of the connection. The default name is used if you do not enter a name. |
Creating a new connection
You can create a connection to the analytic connector from the Analytics activity center, from Data load editor in an existing app, or from Script in an existing script. Follow the steps below to create a connection.
Do the following:
-
Access the connector through Data load editor or Script.
-
Click Create new connection.
-
Under Space, select the space where the connection will be located.
-
Select Amazon Bedrock - Converse API from the list of data connectors.
-
Fill out the connection dialog fields.
-
Click Create.
Your connection is now listed under Data connections in Data load editor or Script.
Once you have created the connection, you can use it to load data with the requests and the platform's responses to them. Additionally, you can use it in chart expressions. For more information, see: