| ActionGroupInvocationInput |
Contains information about the action group being invoked.
|
| ActionGroupInvocationOutput |
Contains the JSON-formatted string returned by the API invoked by the action group.
|
| ApiInvocationInput |
Contains information about the API operation that the agent predicts should be called.
|
| ApiParameter |
Information about a parameter to provide to the API request.
|
| ApiRequestBody |
The request body to provide for the API request, as the agent elicited from the user.
|
| ApiResult |
Contains information about the API operation that was called from the action group and the response body that was
returned.
|
| Attribution |
Contains citations for a part of an agent response.
|
| BedrockAgentRuntimeException.BuilderImpl |
|
| BedrockAgentRuntimeRequest |
|
| BedrockAgentRuntimeRequest.BuilderImpl |
|
| BedrockAgentRuntimeResponse |
|
| BedrockAgentRuntimeResponse.BuilderImpl |
|
| BedrockAgentRuntimeResponseMetadata |
|
| ByteContentDoc |
This property contains the document to chat with, along with its attributes.
|
| ByteContentFile |
The property contains the file to chat with, along with its attributes.
|
| Citation |
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside
information about the source.
|
| CodeInterpreterInvocationInput |
Contains information about the code interpreter being invoked.
|
| CodeInterpreterInvocationOutput |
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
|
| ContentBody |
Contains the body of the API response.
|
| DeleteAgentMemoryRequest |
|
| DeleteAgentMemoryResponse |
|
| ExternalSource |
The unique external source of the content contained in the wrapper object.
|
| ExternalSourcesGenerationConfiguration |
Contains the generation configuration of the external source wrapper object.
|
| ExternalSourcesRetrieveAndGenerateConfiguration |
The configurations of the external source wrapper object in the retrieveAndGenerate function.
|
| FailureTrace |
Contains information about the failure of the interaction.
|
| FilePart |
Contains intermediate response for code interpreter if any files have been generated.
|
| FilePart.BuilderImpl |
|
| FileSource |
The source file of the content contained in the wrapper object.
|
| FilterAttribute |
Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata
attribute.
|
| FinalResponse |
Contains details about the response to the user.
|
| FlowCompletionEvent |
Contains information about why a flow completed.
|
| FlowCompletionEvent.BuilderImpl |
|
| FlowInput |
Contains information about an input into the prompt flow and where to send it.
|
| FlowInputContent |
Contains information about an input into the flow.
|
| FlowOutputContent |
Contains information about the content in an output from prompt flow invocation.
|
| FlowOutputEvent |
Contains information about an output from prompt flow invoction.
|
| FlowOutputEvent.BuilderImpl |
|
| FunctionInvocationInput |
Contains information about the function that the agent predicts should be called.
|
| FunctionParameter |
Contains information about a parameter of the function.
|
| FunctionResult |
Contains information about the function that was called from the action group and the response that was returned.
|
| GeneratedResponsePart |
Contains metadata about a part of the generated response that is accompanied by a citation.
|
| GenerationConfiguration |
Contains configurations for response generation based on the knowledge base query results.
|
| GetAgentMemoryRequest |
|
| GetAgentMemoryResponse |
|
| GuardrailAssessment |
Assessment details of the content analyzed by Guardrails.
|
| GuardrailConfiguration |
The configuration details for the guardrail.
|
| GuardrailContentFilter |
Details of the content filter used in the Guardrail.
|
| GuardrailContentPolicyAssessment |
The details of the policy assessment in the Guardrails filter.
|
| GuardrailCustomWord |
The custom word details for the filter in the Guardrail.
|
| GuardrailManagedWord |
The managed word details for the filter in the Guardrail.
|
| GuardrailPiiEntityFilter |
The Guardrail filter to identify and remove personally identifiable information (PII).
|
| GuardrailRegexFilter |
The details for the regex filter used in the Guardrail.
|
| GuardrailSensitiveInformationPolicyAssessment |
The details of the sensitive policy assessment used in the Guardrail.
|
| GuardrailTopic |
The details for a specific topic defined in the Guardrail.
|
| GuardrailTopicPolicyAssessment |
The details of the policy assessment used in the Guardrail.
|
| GuardrailTrace |
The trace details used in the Guardrail.
|
| GuardrailWordPolicyAssessment |
The assessment details for words defined in the Guardrail filter.
|
| InferenceConfig |
The configuration for inference settings when generating responses using RetrieveAndGenerate.
|
| InferenceConfiguration |
Specifications about the inference parameters that were provided alongside the prompt.
|
| InputFile |
Contains details of the source files.
|
| InvocationInput |
Contains information pertaining to the action group or knowledge base that is being invoked.
|
| InvocationInputMember |
Contains details about the API operation or function that the agent predicts should be called.
|
| InvocationResultMember |
A result from the invocation of an action.
|
| InvokeAgentRequest |
|
| InvokeAgentResponse |
|
| InvokeFlowRequest |
|
| InvokeFlowResponse |
|
| KnowledgeBaseConfiguration |
Configurations to apply to a knowledge base attached to the agent during query.
|
| KnowledgeBaseLookupInput |
Contains details about the knowledge base to look up and the query to be made.
|
| KnowledgeBaseLookupOutput |
Contains details about the results from looking up the knowledge base.
|
| KnowledgeBaseQuery |
Contains the query made to the knowledge base.
|
| KnowledgeBaseRetrievalConfiguration |
Contains configurations for knowledge base query.
|
| KnowledgeBaseRetrievalResult |
Details about a result from querying the knowledge base.
|
| KnowledgeBaseRetrieveAndGenerateConfiguration |
Contains details about the resource being queried.
|
| KnowledgeBaseVectorSearchConfiguration |
Configurations for how to perform the search query and return results.
|
| Memory |
Contains sessions summaries.
|
| MemorySessionSummary |
Contains details of a session summary.
|
| Metadata |
Provides details of the foundation model.
|
| ModelInvocationInput |
The input for the pre-processing step.
|
| Observation |
Contains the result or output of an action group or knowledge base, or the response to the user.
|
| OrchestrationConfiguration |
Settings for how the model processes the prompt prior to retrieval and generation.
|
| OrchestrationModelInvocationOutput |
The foundation model output from the orchestration step.
|
| OrchestrationTrace |
Details about the orchestration step, in which the agent determines the order in which actions are executed and which
knowledge bases are retrieved.
|
| OutputFile |
Contains details of the response from code interpreter.
|
| Parameter |
A parameter for the API request or function.
|
| PayloadPart |
Contains a part of an agent response and citations for it.
|
| PayloadPart.BuilderImpl |
|
| PostProcessingModelInvocationOutput |
The foundation model output from the post-processing step.
|
| PostProcessingParsedResponse |
Details about the response from the Lambda parsing of the output from the post-processing step.
|
| PostProcessingTrace |
Details about the post-processing step, in which the agent shapes the response.
|
| PreProcessingModelInvocationOutput |
The foundation model output from the pre-processing step.
|
| PreProcessingParsedResponse |
Details about the response from the Lambda parsing of the output from the pre-processing step.
|
| PreProcessingTrace |
Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
|
| PromptTemplate |
Contains the template for the prompt that's sent to the model for response generation.
|
| PropertyParameters |
Contains the parameters in the request body.
|
| QueryTransformationConfiguration |
To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION
.
|
| Rationale |
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.
|
| RawResponse |
Contains the raw output from the foundation model.
|
| RepromptResponse |
Contains details about the agent's response to reprompt the input.
|
| RequestBody |
The parameters in the API request body.
|
| RetrievalFilter |
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results.
|
| RetrievalResultConfluenceLocation |
The Confluence data source location.
|
| RetrievalResultContent |
Contains the cited text from the data source.
|
| RetrievalResultLocation |
Contains information about the data source location.
|
| RetrievalResultS3Location |
The S3 data source location.
|
| RetrievalResultSalesforceLocation |
The Salesforce data source location.
|
| RetrievalResultSharePointLocation |
The SharePoint data source location.
|
| RetrievalResultWebLocation |
The web URL/URLs data source location.
|
| RetrieveAndGenerateConfiguration |
Contains details about the resource being queried.
|
| RetrieveAndGenerateInput |
Contains the query made to the knowledge base.
|
| RetrieveAndGenerateOutput |
Contains the response generated from querying the knowledge base.
|
| RetrieveAndGenerateRequest |
|
| RetrieveAndGenerateResponse |
|
| RetrieveAndGenerateSessionConfiguration |
Contains configuration about the session with the knowledge base.
|
| RetrievedReference |
Contains metadata about a source cited for the generated response.
|
| RetrieveRequest |
|
| RetrieveResponse |
|
| ReturnControlPayload |
Contains information to return from the action group that the agent has predicted to invoke.
|
| ReturnControlPayload.BuilderImpl |
|
| S3ObjectDoc |
The unique wrapper object of the document from the S3 location.
|
| S3ObjectFile |
Contains details of the s3 object where the source file is located.
|
| SessionState |
Contains parameters that specify various attributes that persist across a session or prompt.
|
| Span |
Contains information about where the text with a citation begins and ends in the generated output.
|
| TextInferenceConfig |
Configuration settings for text generation using a language model via the RetrieveAndGenerate operation.
|
| TextResponsePart |
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
|
| Trace |
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases.
|
| TracePart |
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.
|
| TracePart.BuilderImpl |
|
| Usage |
Contains information of the usage of the foundation model.
|