- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
BedrockAgentRuntimeClient
Contains APIs related to model invocation and querying of knowledge bases.
Installation
npm install @aws-sdk/client-bedrock-agent-runtime
yarn add @aws-sdk/client-bedrock-agent-runtime
pnpm add @aws-sdk/client-bedrock-agent-runtime
BedrockAgentRuntimeClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
DeleteAgentMemoryCommand | Deletes memory from the specified memory identifier. |
GenerateQueryCommand | Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide. |
GetAgentMemoryCommand | Gets the sessions stored in the memory of the agent. |
InvokeAgentCommand | Sends a prompt for the agent to process and respond to. Note the following fields for the request:
The response contains both chunk and trace attributes. The final response is returned in the
|
InvokeFlowCommand | Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide . The CLI doesn't support streaming operations in Amazon Bedrock, including |
InvokeInlineAgentCommand | Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
|
OptimizePromptCommand | Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide . |
RerankCommand | Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model . |
RetrieveAndGenerateCommand | Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile . The response only cites sources that are relevant to the query. |
RetrieveAndGenerateStreamCommand | Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format. The CLI doesn't support streaming operations in Amazon Bedrock, including This operation requires permission for the |
RetrieveCommand | Queries a knowledge base and retrieves information from it. |
BedrockAgentRuntimeClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
eventStreamSerdeProvider Optional | EventStreamSerdeProvider | The function that provides necessary utilities for generating and parsing event stream |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: BedrockAgentRuntimeClientConfig