Serialized Form

Package com.amazonaws.services.bedrockagentruntime.model

Class com.amazonaws.services.bedrockagentruntime.model.AccessDeniedException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.AWSBedrockAgentRuntimeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.BadGatewayException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceName

String resourceName

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

Class com.amazonaws.services.bedrockagentruntime.model.Citation extends Object implements Serializable

Serialized Fields

generatedResponsePart

GeneratedResponsePart generatedResponsePart

Contains the generated response and metadata

retrievedReferences

List<E> retrievedReferences

Contains metadata about the sources cited for the generated response.

Class com.amazonaws.services.bedrockagentruntime.model.ConflictException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.DependencyFailedException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceName

String resourceName

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

Class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart extends Object implements Serializable

Serialized Fields

textResponsePart

TextResponsePart textResponsePart

Contains metadata about a textual part of the generated response that is accompanied by a citation.

Class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration extends Object implements Serializable

Serialized Fields

promptTemplate

PromptTemplate promptTemplate

Contains the template for the prompt that's sent to the model for response generation.

Class com.amazonaws.services.bedrockagentruntime.model.InternalServerException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery extends Object implements Serializable

Serialized Fields

text

String text

The text of the query made to the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration extends Object implements Serializable

Serialized Fields

vectorSearchConfiguration

KnowledgeBaseVectorSearchConfiguration vectorSearchConfiguration

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

Class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult extends Object implements Serializable

Serialized Fields

content

RetrievalResultContent content

Contains a chunk of text from a data source in the knowledge base.

location

RetrievalResultLocation location

Contains information about the location of the data source.

score

Double score

The level of relevance of the result to the query.

Class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration extends Object implements Serializable

Serialized Fields

generationConfiguration

GenerationConfiguration generationConfiguration

Contains configurations for response generation based on the knowwledge base query results.

knowledgeBaseId

String knowledgeBaseId

The unique identifier of the knowledge base that is queried and the foundation model used for generation.

modelArn

String modelArn

The ARN of the foundation model used to generate a response.

retrievalConfiguration

KnowledgeBaseRetrievalConfiguration retrievalConfiguration

Contains configurations for how to retrieve and return the knowledge base query.

Class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration extends Object implements Serializable

Serialized Fields

filter

RetrievalFilter filter

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

numberOfResults

Integer numberOfResults

The number of source chunks to retrieve.

overrideSearchType

String overrideSearchType

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate extends Object implements Serializable

Serialized Fields

textPromptTemplate

String textPromptTemplate

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

• Knowledge base prompt templates

• Use XML tags with Anthropic Claude models

Class com.amazonaws.services.bedrockagentruntime.model.ResourceNotFoundException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter extends Object implements Serializable

Serialized Fields

andAll

List<E> andAll

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

orAll

List<E> orAll

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

Class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent extends Object implements Serializable

Serialized Fields

text

String text

The cited text from the data source.

Class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation extends Object implements Serializable

Serialized Fields

s3Location

RetrievalResultS3Location s3Location

Contains the S3 location of the data source.

type

String type

The type of the location of the data source.

Class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location extends Object implements Serializable

Serialized Fields

uri

String uri

The S3 URI of the data source.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration extends Object implements Serializable

Serialized Fields

knowledgeBaseConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration knowledgeBaseConfiguration

Contains details about the resource being queried.

type

String type

The type of resource that is queried by the request.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput extends Object implements Serializable

Serialized Fields

text

String text

The query made to the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput extends Object implements Serializable

Serialized Fields

text

String text

The response generated from querying the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

input

RetrieveAndGenerateInput input

Contains the query to be made to the knowledge base.

retrieveAndGenerateConfiguration

RetrieveAndGenerateConfiguration retrieveAndGenerateConfiguration

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

sessionConfiguration

RetrieveAndGenerateSessionConfiguration sessionConfiguration

Contains details about the session with the knowledge base.

sessionId

String sessionId

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

citations

List<E> citations

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

output

RetrieveAndGenerateOutput output

Contains the response generated from querying the knowledge base.

sessionId

String sessionId

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration extends Object implements Serializable

Serialized Fields

kmsKeyArn

String kmsKeyArn

The ARN of the KMS key encrypting the session.

Class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference extends Object implements Serializable

Serialized Fields

content

RetrievalResultContent content

Contains the cited text from the data source.

location

RetrievalResultLocation location

Contains information about the location of the data source.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

knowledgeBaseId

String knowledgeBaseId

The unique identifier of the knowledge base to query.

nextToken

String nextToken

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

retrievalConfiguration

KnowledgeBaseRetrievalConfiguration retrievalConfiguration

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

retrievalQuery

KnowledgeBaseQuery retrievalQuery

Contains the query to send the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

nextToken

String nextToken

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

retrievalResults

List<E> retrievalResults

A list of results from querying the knowledge base.

Class com.amazonaws.services.bedrockagentruntime.model.ServiceQuotaExceededException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.Span extends Object implements Serializable

Serialized Fields

end

Integer end

Where the text with a citation ends in the generated output.

start

Integer start

Where the text with a citation starts in the generated output.

Class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart extends Object implements Serializable

Serialized Fields

span

Span span

Contains information about where the text with a citation begins and ends in the generated output.

text

String text

The part of the generated text that contains a citation.

Class com.amazonaws.services.bedrockagentruntime.model.ThrottlingException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.bedrockagentruntime.model.ValidationException extends AWSBedrockAgentRuntimeException implements Serializable

serialVersionUID:

1L