Awso_bedrock_agent_runtime.ValuesSourceval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]The identifier information for an Amazon S3 bucket.
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.
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.
The parameters in the API request body.
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.
Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
Contains the JSON-formatted string returned by the API invoked by the action group.
/ @documentation("Description of the using the resource.")
Contains details about a parameter in a function for an action group.
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Contains details of the inline agent's action group.
Details about the source of an input image in the result from a function in the action group invocation.
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.
Contains the body of the API response. This data type is used in the following API operations: In the returnControlInvocationResults field of the InvokeAgent request
Contains information about the function that was called from the action group and the response that was returned. This data type is used in the following API operations: In the returnControlInvocationResults of the InvokeAgent request
Contains information about the API operation that was called from the action group and the response body that was returned. This data type is used in the following API operations: In the returnControlInvocationResults of the InvokeAgent request
A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context. This data type is used in the following API operations: InvokeAgent request
An action invocation result.
Input for an agent collaborator. The input can be text or an action invocation result.
An agent collaborator invocation input.
Contains information about a parameter of the function. This data type is used in the following API operations: In the returnControl field of the InvokeAgent response
Contains information about the function that the agent predicts should be called. This data type is used in the following API operations: In the returnControl field of the InvokeAgent response
Contains the parameters in the request body.
The request body to provide for the API request, as the agent elicited from the user. This data type is used in the following API operations: InvokeAgent response
Information about a parameter to provide to the API request. This data type is used in the following API operations: InvokeAgent response
Contains information about the API operation that the agent predicts should be called. This data type is used in the following API operations: In the returnControl field of the InvokeAgent response
Contains details about the API operation or function that the agent predicts should be called. This data type is used in the following API operations: In the returnControl field of the InvokeAgent response
Contains information to return from the action group that the agent has predicted to invoke. This data type is used in the following API operations: InvokeAgent response
Output from an agent collaborator. The output can be text or an action invocation result.
Output from an agent collaborator.
Contains the raw output from the foundation model.
Invocation output from a routing classifier model.
Contains details about the agent's response to reprompt the input.
The web URL/URLs data source location.
Contains information about the SQL query used to retrieve the result.
The SharePoint data source location.
The Salesforce data source location.
The S3 data source location. This data type is used in the following API operations: Retrieve response – in the s3Location field RetrieveAndGenerate response – in the s3Location field InvokeAgent response – in the s3Location field
The location of a result in Amazon Kendra.
Contains information about the location of a document in a custom data source.
The Confluence data source location.
Contains information about the data source location. This data type is used in the following API operations: Retrieve response – in the location field RetrieveAndGenerate response – in the location field InvokeAgent response – in the location field
Contains information about a video segment retrieved from a knowledge base, including its location and summary. This data type is used in the following API operations: Retrieve response – in the video field
Contains information about a column with a cell to return in retrieval.
Contains information about an audio segment retrieved from a knowledge base, including its location and transcription. This data type is used in the following API operations: Retrieve response – in the audio field
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. This data type is used in the following API operations: Retrieve response – in the content field RetrieveAndGenerate response – in the content field InvokeAgent response – in the content field
Contains metadata about a source cited for the generated response. This data type is used in the following API operations: RetrieveAndGenerate response – in the retrievedReferences field InvokeAgent response – in the retrievedReferences field
Contains details about the results from looking up the knowledge base.
Contains details about the response to the user.
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
Contains the result or output of an action group or knowledge base, or the response to the user.
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.
The input for the pre-processing step. The type matches the agent step. The text contains the prompt. The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
Contains details about the knowledge base to look up and the query to be made.
Contains information about the code interpreter being invoked.
Contains information pertaining to the action group or knowledge base that is being invoked.
A trace for a routing classifier.
Contains information about the reasoning that the model used to return the content in the content block.
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.
Details about the response from the Lambda parsing of the output from the pre-processing step.
The foundation model output from the pre-processing step.
Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
Details about the response from the Lambda parsing of the output from the post-processing step.
The foundation model output from the post-processing step.
Details about the post-processing step, in which the agent shapes the response.
Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
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.
The managed word details for the filter in the Guardrail.
The custom word details for the filter in the Guardrail.
The assessment details for words defined in the Guardrail filter.
The details for a specific topic defined in the Guardrail.
The details of the policy assessment used in the Guardrail.
The details for the regex filter used in the Guardrail.
The Guardrail filter to identify and remove personally identifiable information (PII).
The details of the sensitive policy assessment used in the Guardrail.
Details of the content filter used in the Guardrail.
The details of the policy assessment in the Guardrails filter.
Assessment details of the content analyzed by Guardrails.
The trace details used in the Guardrail.
Contains information about the failure of the interaction.
The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
The trace behavior for the custom orchestration.
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.
An event in which the prompt was analyzed in preparation for optimization.
Contains information about where the text with a citation begins and ends in the generated output. This data type is used in the following API operations: RetrieveAndGenerate response – in the span field InvokeAgent response – in the span field
Contains the part of the generated text that contains a citation, alongside where it begins and ends. This data type is used in the following API operations: RetrieveAndGenerate response – in the textResponsePart field InvokeAgent response – in the textResponsePart field
Contains metadata about a part of the generated response that is accompanied by a citation. This data type is used in the following API operations: InvokeAgent response – in the generatedResponsePart field RetrieveAndGenerate response – in the generatedResponsePart field
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source. This data type is used in the following API operations: InvokeAgent response – in the citations field RetrieveAndGenerate response – in the citations 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.
Performance settings for a model.
Settings for a model called with InvokeAgent.
Contains configurations for a reranker model.
Contains configurations for an Amazon Bedrock reranker model.
Information about the Amazon S3 bucket where the image is stored.
The source for an image.
Image content for an invocation step.
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. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
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 configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
Contains configurations for an Amazon Bedrock reranker model.
Contains information for a metadata field to include in or exclude from consideration when 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 configurations for the metadata to use in reranking.
Contains configurations for reranking with an Amazon Bedrock reranker model.
Contains configurations for reranking the retrieved results.
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. This data type is used in the following API operations: RetrieveAndGenerate request
module RetrievalFilter : sig ... endSpecifies 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. This data type is used in the following API operations: Retrieve request – in the filter field RetrieveAndGenerate request – in the filter field
module RetrievalFilterList : sig ... endDetails about a metadata attribute.
Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
Configurations for how to perform the search query and return results. For more information, see Query configurations. This data type is used in the following API operations: Retrieve request – in the vectorSearchConfiguration field RetrieveAndGenerate request – in the vectorSearchConfiguration field
Contains configurations for knowledge base query. For more information, see Query configurations. This data type is used in the following API operations: Retrieve request – in the retrievalConfiguration field RetrieveAndGenerate request – in the retrievalConfiguration field
Details of the knowledge base associated withe inline agent.
The configuration details for the guardrail.
Settings of an inline collaborator agent.
List of inline collaborators.
Represents a condition that was satisfied during a condition node evaluation in a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Time Stamp.
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. Flow executions is in preview release for Amazon Bedrock and is subject to change.
There was a conflict performing an operation. Resolve the conflict and retry your request.
A content block.
A conversation history.
Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions. Related APIs ListInvocations ListSessions GetSession
Input validation failed. Check your request parameters and retry the request.
The number of requests exceeds the limit. Resubmit your request later.
The number of requests exceeds the service quota. Resubmit your request later.
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
An internal server error occurred. Retry your request.
Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions. Related APIs ListInvocations ListSessions GetSession
Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions. By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption. You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation. Related APIs: ListSessions GetSession EndSession DeleteSession
Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions. By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption. You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation. Related APIs: ListSessions GetSession EndSession DeleteSession
The structure of the executor invoking the actions in custom orchestration.
Contains details of the custom orchestration configured for the agent.
Deletes memory from the specified memory identifier.
There was an issue with a dependency. Check the resource configurations and retry the request.
Deletes memory from the specified memory identifier.
Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
The unique wrapper object of the document from the S3 location.
The unique external source of the content contained in the wrapper object.
Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates. This data type is used in the following API operations: RetrieveAndGenerate request – in the filter field
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. The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
The configuration for inference settings when generating responses using RetrieveAndGenerate.
The configuration details for the guardrail.
Contains the generation configuration of the external source wrapper object.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
Contains details of the response from code interpreter.
Contains intermediate response for code interpreter if any files have been generated.
Contains details of the s3 object where the source file is located.
The source file of the content contained in the wrapper object.
Contains information about why a flow completed.
Contains the content of an flow execution input or output field. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about an error that occurred during an flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Represents the next node that receives output data.
Contains the content of a flow node's input or output field for a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Represents an output field produced by a node during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about the outputs produced by a specific node during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Represents the source of input data for a node field.
Represents an item in the execution chain for node input tracking.
Represents an input field provided to a node during a flow execution.
Contains information about the inputs provided to a specific node during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about a failure that occurred at a specific node during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains trace elements for node execution tracking.
Contains information about an internal trace of a specific node during execution.
Contains information about an action (operation) called by a node during execution.
Contains information about a failure that occurred at the flow level during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Represents an output field produced by a flow during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about the outputs produced by the flow during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Represents an input field provided to a flow during a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about the inputs provided to the flow at the start of a flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
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. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains summary information about a flow execution, including its status, timestamps, and identifiers. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about an input into the flow.
Contains information about an input into the prompt flow and where to send it.
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 the next node that receives output data from a flow trace.
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 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.
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.
Represents the source of input data for a flow trace node field.
Represents an item in the execution chain for flow trace node input tracking.
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 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 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 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 trace elements for flow execution tracking.
Contains information about a dependency trace event in the flow.
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 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 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.
The output of the flow.
Contains configurations for a knowledge base to use in transformation.
Contains configurations for transforming text to SQL.
Contains configurations for transforming the natural language query into SQL.
Contains information about a natural language query to transform into SQL.
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.
Contains information about a query generated for a natural language query.
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.
Contains configurations for response generation based on the knowledge base query results. This data type is used in the following API operations: RetrieveAndGenerate request
Max Results.
Gets the sessions stored in the memory of the agent.
Contains details of a session summary.
Gets the sessions stored in the memory of the agent.
Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
Retrieves the details of a specific 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.
Payload content, such as text and images, for the invocation step.
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.
Retrieves the details of a specific 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.
Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
A guardrail event.
Contains intermediate response for code interpreter if any files have been generated.
Contains a part of an agent response and citations for it.
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 information to return from the action group that the agent has predicted to invoke. This data type is used in the InvokeAgent response API operation.
The response from invoking the agent and associated citations and trace information.
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 the image data for multimodal knowledge base queries, including format and content. This data type is used in the following API operations: Retrieve request – in the image field
Contains information about the text prompt to optimize.
Contains information about the prompt to optimize.
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.
Configurations for streaming.
Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.
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.
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.
Sends a prompt for the agent to process and respond to. Note the following fields for the request: To continue the same conversation with an agent, use the same sessionId value in the request. To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement. End a conversation by setting endSession to true. In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. The response contains both chunk and trace attributes. The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction. The attribution object contains citations for parts of the response. If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response. If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field. Errors are also surfaced in the response.
Contains a part of an agent response and citations for it.
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 response from invoking the agent and associated citations and trace information.
Sends a prompt for the agent to process and respond to. Note the following fields for the request: To continue the same conversation with an agent, use the same sessionId value in the request. To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement. End a conversation by setting endSession to true. In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. The response contains both chunk and trace attributes. The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction. The attribution object contains citations for parts of the response. If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response. If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field. Errors are also surfaced in the response.
The performance configuration for a model called with InvokeFlow.
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 InvokeFlow.
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 InvokeFlow.
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request. Specify the following fields for security purposes. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request. Specify the following fields for security purposes. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Contains the query made to the knowledge base. This data type is used in the following API operations: Retrieve request – in the retrievalQuery field
Details about a result from querying the knowledge base. This data type is used in the following API operations: Retrieve response – in the retrievalResults field
To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
Settings for how the model processes the prompt prior to retrieval and generation.
Contains details about the resource being queried. This data type is used in the following API operations: Retrieve request – in the knowledgeBaseConfiguration field RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN). Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN). Flow executions is in preview release for Amazon Bedrock and is subject to change.
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
ARN of Taggable resources: [session]
List all the tags for the resource you specify.
List all the tags for the resource you specify.
Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
Contains information about the optimized prompt.
An event in which the prompt was optimized.
The stream containing events in the prompt optimization process.
Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions. Related APIs: GetInvocationStep ListInvocationSteps ListInvocations ListSessions
Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions. Related APIs: GetInvocationStep ListInvocationSteps ListInvocations ListSessions
Contains information about a text document to rerank.
Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.
Contains information about a query to submit to the reranker model.
Contains configurations for reranking.
Contains information about a source for reranking.
Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.
Contains information about a document that was reranked.
Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.
Contains details about the resource being queried. This data type is used in the following API operations: RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field
Contains the query made to the knowledge base. This data type is used in the following API operations: RetrieveAndGenerate request – in the input field
Contains the response generated from querying the knowledge base. This data type is used in the following API operations: RetrieveAndGenerate response – in the output field
A retrieve and generate output event.
Contains configuration about the session with the knowledge base. This data type is used in the following API operations: RetrieveAndGenerate request – in the sessionConfiguration field
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.
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.
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 InvokeModelWithResponseStream. This operation requires permission for the bedrock:RetrieveAndGenerate action.
A retrieve and generate stream response output.
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 InvokeModelWithResponseStream. This operation requires permission for the bedrock:RetrieveAndGenerate action.
Queries a knowledge base and retrieves information from it.
Queries a knowledge base and retrieves information from it.
Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks. This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks. This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.
Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
Remove tags from a resource.
Remove tags from a resource.
Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.