Package-level declarations
Types
The request is denied because of missing access permissions. Check your permissions and retry your request.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
Contains the JSON-formatted string returned by the API invoked by the action group.
Contains details of the inline agent's action group.
Input for an agent collaborator. The input can be text or an action invocation result.
An agent collaborator invocation input.
Output from an agent collaborator.
Output from an agent collaborator. The output can be text or an action invocation result.
An event in which the prompt was analyzed in preparation for optimization.
Contains information about the API operation that the agent predicts should be called.
Information about a parameter to provide to the API request.
The request body to provide for the API request, as the agent elicited from the user.
Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
Contains citations for a part of an agent response.
There was an issue with a dependency due to a server issue. Retry your request.
Base class for all service related exceptions thrown by the BedrockAgentRuntime client
Settings for a model called with InvokeAgent.
Contains configurations for an Amazon Bedrock reranker model.
Contains configurations for a reranker model.
A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.
This property contains the document to chat with, along with its attributes.
The property contains the file to chat with, along with its attributes.
A citation event.
Contains information about the code interpreter being invoked.
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
List of inline collaborators.
Settings of an inline collaborator agent.
Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.
There was a conflict performing an operation. Resolve the conflict and retry your request.
A content block.
Contains the body of the API response.
A conversation history.
Contains details of the custom orchestration configured for the agent.
The trace behavior for the custom orchestration.
The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
There was an issue with a dependency. Check the resource configurations and retry the request.
The unique external source of the content contained in the wrapper object.
Contains the generation configuration of the external source wrapper object.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
Contains information about the failure of the interaction.
Contains information for a metadata field to include in or exclude from consideration when reranking.
The source file of the content contained in the wrapper object.
Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
Contains details about the response to the user.
Contains information about why a flow completed.
Contains the content of an flow execution input or output field.
Contains information about an error that occurred during an flow execution.
Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Contains information about the inputs provided to the flow at the start of a flow execution.
Contains information about the outputs produced by the flow during a flow execution.
Contains summary information about a flow execution, including its status, timestamps, and identifiers.
Contains information about a failure that occurred at the flow level during a flow execution.
Contains information about an input into the flow.
Represents an input field provided to a flow during a flow execution.
The content structure containing input information for multi-turn flow interactions.
Response object from the flow multi-turn node requesting additional information.
Contains information about the content in an output from prompt flow invocation.
Contains information about an output from prompt flow invoction.
Represents an output field produced by a flow during a flow execution.
The output of the flow.
Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.
Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
Contains information about the function that the agent predicts should be called.
Contains information about a parameter of the function.
Contains information about the function that was called from the action group and the response that was returned.
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Contains information about a query generated for a natural language query.
Contains metadata about a part of the generated response that is accompanied by a citation.
Contains configurations for response generation based on the knowledge base query results.
Assessment details of the content analyzed by Guardrails.
The configuration details for the guardrail.
The configuration details for the guardrail.
Details of the content filter used in the Guardrail.
The details of the policy assessment in the Guardrails filter.
The custom word details for the filter in the Guardrail.
A guardrail event.
The managed word details for the filter in the Guardrail.
The Guardrail filter to identify and remove personally identifiable information (PII).
The details for the regex filter used in the Guardrail.
The details of the sensitive policy assessment used in the Guardrail.
The details for a specific topic defined in the Guardrail.
The details of the policy assessment used in the Guardrail.
The trace details used in the Guardrail.
The assessment details for words defined in the Guardrail filter.
Image content for an invocation step.
Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Details about the source of an input image in the result from a function in the action group invocation.
The source for an image.
Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
The configuration for inference settings when generating responses using RetrieveAndGenerate.
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
Contains intermediate response for code interpreter if any files have been generated.
Contains a part of an agent response and citations for it.
The response from invoking the agent and associated citations and trace information.
Contains information to return from the action group that the agent has predicted to invoke.
Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
Settings for a model called with InvokeInlineAgent.
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
Contains information about the prompt to optimize.
An internal server error occurred. Retry your request.
Contains information pertaining to the action group or knowledge base that is being invoked.
Contains details about the API operation or function that the agent predicts should be called.
A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Payload content, such as text and images, for the invocation step.
Contains details about an invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Details of the knowledge base associated withe inline agent.
Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.
Contains details about the knowledge base to look up and the query to be made.
Contains details about the results from looking up the knowledge base.
Contains the query made to the knowledge base.
Contains configurations for knowledge base query. For more information, see Query configurations.
Details about a result from querying the knowledge base.
Contains details about the resource being queried.
Configurations for how to perform the search query and return results. For more information, see Query configurations.
Contains details of a session summary.
Details about a metadata attribute.
Contains configurations for the metadata to use in reranking.
The input for the pre-processing step.
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
The performance configuration for a model called with InvokeFlow.
Contains the content of a flow node's input or output field for a flow execution.
Contains information about a failure that occurred at a specific node during a flow execution.
Contains information about the inputs provided to a specific node during a flow execution.
Represents an input field provided to a node during a flow execution.
Contains information about the outputs produced by a specific node during a flow execution.
Represents an output field produced by a node during a flow execution.
Contains the result or output of an action group or knowledge base, or the response to the user.
Contains information about the optimized prompt.
An event in which the prompt was optimized.
The stream containing events in the prompt optimization process.
Settings for how the model processes the prompt prior to retrieval and generation.
The structure of the executor invoking the actions in custom orchestration.
The foundation model output from the orchestration step.
Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
Contains details of the response from code interpreter.
Contains details about a parameter in a function for an action group.
Contains a part of an agent response and citations for it.
Performance settings for a model.
The foundation model output from the post-processing step.
Details about the response from the Lambda parsing of the output from the post-processing step.
Details about the post-processing step, in which the agent shapes the response.
The foundation model output from the pre-processing step.
Details about the response from the Lambda parsing of the output from the pre-processing step.
Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent or InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
Contains the parameters in the request body.
Contains information about a natural language query to transform into SQL.
To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
Contains the raw output from the foundation model.
Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
Contains information about the reasoning that the model used to return the content in the content block.
Contains details about the agent's response to reprompt the input.
The parameters in the API request body.
Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.
Contains configurations for reranking.
Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.
Contains information about a query to submit to the reranker model.
Contains information about a document that was reranked.
Contains information about a source for reranking.
Contains information about a text document to rerank.
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
The response from invoking the agent and associated citations and trace information.
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
The Confluence data source location.
Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
Contains information about a column with a cell to return in retrieval.
Contains information about the location of a document in a custom data source.
The location of a result in Amazon Kendra.
Contains information about the data source location.
The S3 data source location.
The Salesforce data source location.
The SharePoint data source location.
Contains information about the SQL query used to retrieve the result.
The web URL/URLs data source location.
Contains details about the resource being queried.
Contains the query made to the knowledge base.
Contains the response generated from querying the knowledge base.
A retrieve and generate output event.
Contains configuration about the session with the knowledge base.
A retrieve and generate stream response output.
Contains metadata about a source cited for the generated response.
Contains information to return from the action group that the agent has predicted to invoke.
An action invocation result.
Invocation output from a routing classifier model.
A trace for a routing classifier.
The identifier information for an Amazon S3 bucket.
Information about the Amazon S3 bucket where the image is stored.
The unique wrapper object of the document from the S3 location.
Contains details of the s3 object where the source file is located.
Represents a condition that was satisfied during a condition node evaluation in a flow execution.
The number of requests exceeds the service quota. Resubmit your request later.
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.
Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Configurations for streaming.
Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
Contains information about the text prompt to optimize.
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
Contains configurations for transforming text to SQL.
Contains configurations for a knowledge base to use in transformation.
The number of requests exceeds the limit. Resubmit your request later.
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
Contains configurations for transforming the natural language query into SQL.
Input validation failed. Check your request parameters and retry the request.
Contains configurations for reranking with an Amazon Bedrock reranker model.
Contains configurations for an Amazon Bedrock reranker model.
Contains configurations for reranking the retrieved results.