| Class | Description |
|---|---|
| ByteContentDoc |
This property contains the document 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.
|
| DeleteAgentMemoryRequest | |
| DeleteAgentMemoryResult | |
| 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.
|
| 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 | |
| GetAgentMemoryResult | |
| GuardrailConfiguration |
The configuration details for the guardrail.
|
| InferenceConfig |
The configuration for inference settings when generating responses using RetrieveAndGenerate.
|
| 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.
|
| OrchestrationConfiguration |
Settings for how the model processes the prompt prior to retrieval and generation.
|
| PromptTemplate |
Contains the template for the prompt that's sent to the model for response generation.
|
| QueryTransformationConfiguration |
To split up the prompt and retrieve multiple sources, set the transformation type to
QUERY_DECOMPOSITION
. |
| 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 | |
| RetrieveAndGenerateResult | |
| RetrieveAndGenerateSessionConfiguration |
Contains configuration about the session with the knowledge base.
|
| RetrievedReference |
Contains metadata about a source cited for the generated response.
|
| RetrieveRequest | |
| RetrieveResult | |
| S3ObjectDoc |
The unique wrapper object of the document from the S3 location.
|
| 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.
|
| Enum | Description |
|---|---|
| ExternalSourceType | |
| GuadrailAction | |
| MemoryType | |
| QueryTransformationType | |
| RetrievalResultLocationType | |
| RetrieveAndGenerateType | |
| SearchType |
| Exception | Description |
|---|---|
| AccessDeniedException |
The request is denied because of missing access permissions.
|
| AWSBedrockAgentRuntimeException |
Base exception for all service exceptions thrown by Agents for Amazon Bedrock Runtime
|
| BadGatewayException |
There was an issue with a dependency due to a server issue.
|
| ConflictException |
There was a conflict performing an operation.
|
| DependencyFailedException |
There was an issue with a dependency.
|
| InternalServerException |
An internal server error occurred.
|
| ResourceNotFoundException |
The specified resource Amazon Resource Name (ARN) was not found.
|
| ServiceQuotaExceededException |
The number of requests exceeds the service quota.
|
| ThrottlingException |
The number of requests exceeds the limit.
|
| ValidationException |
Input validation failed.
|