Skip navigation links
A B C D E F G H I K M P R S T V W 

A

AbstractAWSBedrockAgentRuntime - Class in com.amazonaws.services.bedrockagentruntime
Abstract implementation of AWSBedrockAgentRuntime.
AbstractAWSBedrockAgentRuntime() - Constructor for class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime
 
AbstractAWSBedrockAgentRuntimeAsync - Class in com.amazonaws.services.bedrockagentruntime
Abstract implementation of AWSBedrockAgentRuntimeAsync.
AbstractAWSBedrockAgentRuntimeAsync() - Constructor for class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync
 
AccessDeniedException - Exception in com.amazonaws.services.bedrockagentruntime.model
The request is denied because of missing access permissions.
AccessDeniedException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.AccessDeniedException
Constructs a new AccessDeniedException with the specified error message.
asyncBuilder() - Static method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
 
AWSBedrockAgentRuntime - Interface in com.amazonaws.services.bedrockagentruntime
Interface for accessing Agents for Amazon Bedrock Runtime.
AWSBedrockAgentRuntimeAsync - Interface in com.amazonaws.services.bedrockagentruntime
Interface for accessing Agents for Amazon Bedrock Runtime asynchronously.
AWSBedrockAgentRuntimeAsyncClient - Class in com.amazonaws.services.bedrockagentruntime
Client for accessing Agents for Amazon Bedrock Runtime asynchronously.
AWSBedrockAgentRuntimeAsyncClientBuilder - Class in com.amazonaws.services.bedrockagentruntime
Fluent builder for AWSBedrockAgentRuntimeAsync.
AWSBedrockAgentRuntimeClient - Class in com.amazonaws.services.bedrockagentruntime
Client for accessing Agents for Amazon Bedrock Runtime.
AWSBedrockAgentRuntimeClientBuilder - Class in com.amazonaws.services.bedrockagentruntime
Fluent builder for AWSBedrockAgentRuntime.
AWSBedrockAgentRuntimeException - Exception in com.amazonaws.services.bedrockagentruntime.model
Base exception for all service exceptions thrown by Agents for Amazon Bedrock Runtime
AWSBedrockAgentRuntimeException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.AWSBedrockAgentRuntimeException
Constructs a new AWSBedrockAgentRuntimeException with the specified error message.

B

BadGatewayException - Exception in com.amazonaws.services.bedrockagentruntime.model
There was an issue with a dependency due to a server issue.
BadGatewayException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.BadGatewayException
Constructs a new BadGatewayException with the specified error message.
build(AwsAsyncClientParams) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClientBuilder
Construct an asynchronous implementation of AWSBedrockAgentRuntimeAsync using the current builder configuration.
build(AwsSyncClientParams) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClientBuilder
Construct a synchronous implementation of AWSBedrockAgentRuntime using the current builder configuration.
builder() - Static method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient
 

C

Citation - Class in com.amazonaws.services.bedrockagentruntime.model
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
Citation() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.Citation
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
 
clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
 
com.amazonaws.services.bedrockagentruntime - package com.amazonaws.services.bedrockagentruntime
Contains APIs related to model invocation and querying of knowledge bases.
com.amazonaws.services.bedrockagentruntime.model - package com.amazonaws.services.bedrockagentruntime.model
 
configFactory - Static variable in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient
Client configuration factory providing ClientConfigurations tailored to this client
ConflictException - Exception in com.amazonaws.services.bedrockagentruntime.model
There was a conflict performing an operation.
ConflictException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.ConflictException
Constructs a new ConflictException with the specified error message.

D

defaultClient() - Static method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClientBuilder
 
defaultClient() - Static method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClientBuilder
 
DependencyFailedException - Exception in com.amazonaws.services.bedrockagentruntime.model
There was an issue with a dependency.
DependencyFailedException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.DependencyFailedException
Constructs a new DependencyFailedException with the specified error message.

E

ENDPOINT_PREFIX - Static variable in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime
The region metadata service name for computing region endpoints.
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
 
equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
 

F

fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocationType
Use this in place of valueOf.
fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateType
Use this in place of valueOf.
fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.SearchType
Use this in place of valueOf.

G

GeneratedResponsePart - Class in com.amazonaws.services.bedrockagentruntime.model
Contains metadata about a part of the generated response that is accompanied by a citation.
GeneratedResponsePart() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
 
GenerationConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model
Contains configurations for response generation based on the knowledge base query results.
GenerationConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
 
getAndAll() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
getCachedResponseMetadata(AmazonWebServiceRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime
 
getCachedResponseMetadata(AmazonWebServiceRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
getCachedResponseMetadata(AmazonWebServiceRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
getCitations() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
getContent() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Contains a chunk of text from a data source in the knowledge base.
getContent() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Contains the cited text from the data source.
getEnd() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Where the text with a citation ends in the generated output.
getExecutorService() - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
Returns the executor service used by this client to execute async requests.
getFilter() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
getGeneratedResponsePart() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains the generated response and metadata
getGenerationConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configurations for response generation based on the knowwledge base query results.
getInput() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains the query to be made to the knowledge base.
getKmsKeyArn() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
The ARN of the KMS key encrypting the session.
getKnowledgeBaseConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
Contains details about the resource being queried.
getKnowledgeBaseId() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
The unique identifier of the knowledge base that is queried and the foundation model used for generation.
getKnowledgeBaseId() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
The unique identifier of the knowledge base to query.
getLocation() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Contains information about the location of the data source.
getLocation() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Contains information about the location of the data source.
getModelArn() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
The ARN of the foundation model used to generate a response.
getNextToken() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
If there are more results than can fit in the response, the response returns a nextToken.
getNextToken() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
If there are more results than can fit in the response, the response returns a nextToken.
getNumberOfResults() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
The number of source chunks to retrieve.
getOrAll() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
getOutput() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
Contains the response generated from querying the knowledge base.
getOverrideSearchType() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
By default, Amazon Bedrock decides a search strategy for you.
getPromptTemplate() - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
Contains the template for the prompt that's sent to the model for response generation.
getResourceName() - Method in exception com.amazonaws.services.bedrockagentruntime.model.BadGatewayException
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
getResourceName() - Method in exception com.amazonaws.services.bedrockagentruntime.model.DependencyFailedException
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
getRetrievalConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configurations for how to retrieve and return the knowledge base query.
getRetrievalConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Contains configurations for the knowledge base query and retrieval process.
getRetrievalQuery() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Contains the query to send the knowledge base.
getRetrievalResults() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
A list of results from querying the knowledge base.
getRetrieveAndGenerateConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains configurations for the knowledge base query and retrieval process.
getRetrievedReferences() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains metadata about the sources cited for the generated response.
getS3Location() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
Contains the S3 location of the data source.
getScore() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
The level of relevance of the result to the query.
getSessionConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains details about the session with the knowledge base.
getSessionId() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
The unique identifier of the session.
getSessionId() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
The unique identifier of the session.
getSpan() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
Contains information about where the text with a citation begins and ends in the generated output.
getStart() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Where the text with a citation starts in the generated output.
getText() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
The text of the query made to the knowledge base.
getText() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
The cited text from the data source.
getText() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
The query made to the knowledge base.
getText() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
The response generated from querying the knowledge base.
getText() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
The part of the generated text that contains a citation.
getTextPromptTemplate() - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
The template for the prompt that's sent to the model for response generation.
getTextResponsePart() - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
Contains metadata about a textual part of the generated response that is accompanied by a citation.
getType() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
The type of the location of the data source.
getType() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
The type of resource that is queried by the request.
getUri() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
The S3 URI of the data source.
getVectorSearchConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
Contains details about how the results from the vector search should be returned.

H

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
 
hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
 

I

InternalServerException - Exception in com.amazonaws.services.bedrockagentruntime.model
An internal server error occurred.
InternalServerException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.InternalServerException
Constructs a new InternalServerException with the specified error message.

K

KnowledgeBaseQuery - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the query made to the knowledge base.
KnowledgeBaseQuery() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
 
KnowledgeBaseRetrievalConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model
Contains configurations for the knowledge base query and retrieval process.
KnowledgeBaseRetrievalConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
 
KnowledgeBaseRetrievalResult - Class in com.amazonaws.services.bedrockagentruntime.model
Details about a result from querying the knowledge base.
KnowledgeBaseRetrievalResult() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
 
KnowledgeBaseRetrieveAndGenerateConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model
Contains details about the resource being queried.
KnowledgeBaseRetrieveAndGenerateConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
 
KnowledgeBaseVectorSearchConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model
Configurations for how to perform the search query and return results.
KnowledgeBaseVectorSearchConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
 

M

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
 
marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
 

P

PromptTemplate - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the template for the prompt that's sent to the model for response generation.
PromptTemplate() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
 

R

ResourceNotFoundException - Exception in com.amazonaws.services.bedrockagentruntime.model
The specified resource ARN was not found.
ResourceNotFoundException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.ResourceNotFoundException
Constructs a new ResourceNotFoundException with the specified error message.
RetrievalFilter - Class in com.amazonaws.services.bedrockagentruntime.model
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results.
RetrievalFilter() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
 
RetrievalResultContent - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the cited text from the data source.
RetrievalResultContent() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
 
RetrievalResultLocation - Class in com.amazonaws.services.bedrockagentruntime.model
Contains information about the location of the data source.
RetrievalResultLocation() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
 
RetrievalResultLocationType - Enum in com.amazonaws.services.bedrockagentruntime.model
 
RetrievalResultS3Location - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the S3 location of the data source.
RetrievalResultS3Location() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
 
retrieve(RetrieveRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime
 
retrieve(RetrieveRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime
Queries a knowledge base and retrieves information from it.
retrieve(RetrieveRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient
Queries a knowledge base and retrieves information from it.
retrieveAndGenerate(RetrieveAndGenerateRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime
 
retrieveAndGenerate(RetrieveAndGenerateRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime
Queries a knowledge base and generates responses based on the retrieved results.
retrieveAndGenerate(RetrieveAndGenerateRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient
Queries a knowledge base and generates responses based on the retrieved results.
retrieveAndGenerateAsync(RetrieveAndGenerateRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync
 
retrieveAndGenerateAsync(RetrieveAndGenerateRequest, AsyncHandler<RetrieveAndGenerateRequest, RetrieveAndGenerateResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync
 
retrieveAndGenerateAsync(RetrieveAndGenerateRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync
Queries a knowledge base and generates responses based on the retrieved results.
retrieveAndGenerateAsync(RetrieveAndGenerateRequest, AsyncHandler<RetrieveAndGenerateRequest, RetrieveAndGenerateResult>) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync
Queries a knowledge base and generates responses based on the retrieved results.
retrieveAndGenerateAsync(RetrieveAndGenerateRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
 
retrieveAndGenerateAsync(RetrieveAndGenerateRequest, AsyncHandler<RetrieveAndGenerateRequest, RetrieveAndGenerateResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
 
RetrieveAndGenerateConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model
Contains details about the resource being queried.
RetrieveAndGenerateConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
 
RetrieveAndGenerateInput - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the query made to the knowledge base.
RetrieveAndGenerateInput() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
 
RetrieveAndGenerateOutput - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the response generated from querying the knowledge base.
RetrieveAndGenerateOutput() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
 
RetrieveAndGenerateRequest - Class in com.amazonaws.services.bedrockagentruntime.model
 
RetrieveAndGenerateRequest() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
 
RetrieveAndGenerateResult - Class in com.amazonaws.services.bedrockagentruntime.model
 
RetrieveAndGenerateResult() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
 
RetrieveAndGenerateSessionConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model
Contains configuration about the session with the knowledge base.
RetrieveAndGenerateSessionConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
 
RetrieveAndGenerateType - Enum in com.amazonaws.services.bedrockagentruntime.model
 
retrieveAsync(RetrieveRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync
 
retrieveAsync(RetrieveRequest, AsyncHandler<RetrieveRequest, RetrieveResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync
 
retrieveAsync(RetrieveRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync
Queries a knowledge base and retrieves information from it.
retrieveAsync(RetrieveRequest, AsyncHandler<RetrieveRequest, RetrieveResult>) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync
Queries a knowledge base and retrieves information from it.
retrieveAsync(RetrieveRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
 
retrieveAsync(RetrieveRequest, AsyncHandler<RetrieveRequest, RetrieveResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
 
RetrievedReference - Class in com.amazonaws.services.bedrockagentruntime.model
Contains metadata about a source cited for the generated response.
RetrievedReference() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
 
RetrieveRequest - Class in com.amazonaws.services.bedrockagentruntime.model
 
RetrieveRequest() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
 
RetrieveResult - Class in com.amazonaws.services.bedrockagentruntime.model
 
RetrieveResult() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
 

S

SearchType - Enum in com.amazonaws.services.bedrockagentruntime.model
 
ServiceQuotaExceededException - Exception in com.amazonaws.services.bedrockagentruntime.model
The number of requests exceeds the service quota.
ServiceQuotaExceededException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.ServiceQuotaExceededException
Constructs a new ServiceQuotaExceededException with the specified error message.
setAndAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
setCitations(Collection<Citation>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
setContent(RetrievalResultContent) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Contains a chunk of text from a data source in the knowledge base.
setContent(RetrievalResultContent) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Contains the cited text from the data source.
setEnd(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Where the text with a citation ends in the generated output.
setFilter(RetrievalFilter) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
setGeneratedResponsePart(GeneratedResponsePart) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains the generated response and metadata
setGenerationConfiguration(GenerationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configurations for response generation based on the knowwledge base query results.
setInput(RetrieveAndGenerateInput) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains the query to be made to the knowledge base.
setKmsKeyArn(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
The ARN of the KMS key encrypting the session.
setKnowledgeBaseConfiguration(KnowledgeBaseRetrieveAndGenerateConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
Contains details about the resource being queried.
setKnowledgeBaseId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
The unique identifier of the knowledge base that is queried and the foundation model used for generation.
setKnowledgeBaseId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
The unique identifier of the knowledge base to query.
setLocation(RetrievalResultLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Contains information about the location of the data source.
setLocation(RetrievalResultLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Contains information about the location of the data source.
setModelArn(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
The ARN of the foundation model used to generate a response.
setNextToken(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
If there are more results than can fit in the response, the response returns a nextToken.
setNextToken(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
If there are more results than can fit in the response, the response returns a nextToken.
setNumberOfResults(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
The number of source chunks to retrieve.
setOrAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
setOutput(RetrieveAndGenerateOutput) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
Contains the response generated from querying the knowledge base.
setOverrideSearchType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
By default, Amazon Bedrock decides a search strategy for you.
setPromptTemplate(PromptTemplate) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
Contains the template for the prompt that's sent to the model for response generation.
setResourceName(String) - Method in exception com.amazonaws.services.bedrockagentruntime.model.BadGatewayException
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
setResourceName(String) - Method in exception com.amazonaws.services.bedrockagentruntime.model.DependencyFailedException
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configurations for how to retrieve and return the knowledge base query.
setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Contains configurations for the knowledge base query and retrieval process.
setRetrievalQuery(KnowledgeBaseQuery) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Contains the query to send the knowledge base.
setRetrievalResults(Collection<KnowledgeBaseRetrievalResult>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
A list of results from querying the knowledge base.
setRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains configurations for the knowledge base query and retrieval process.
setRetrievedReferences(Collection<RetrievedReference>) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains metadata about the sources cited for the generated response.
setS3Location(RetrievalResultS3Location) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
Contains the S3 location of the data source.
setScore(Double) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
The level of relevance of the result to the query.
setSessionConfiguration(RetrieveAndGenerateSessionConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains details about the session with the knowledge base.
setSessionId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
The unique identifier of the session.
setSessionId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
The unique identifier of the session.
setSpan(Span) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
Contains information about where the text with a citation begins and ends in the generated output.
setStart(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Where the text with a citation starts in the generated output.
setText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
The text of the query made to the knowledge base.
setText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
The cited text from the data source.
setText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
The query made to the knowledge base.
setText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
The response generated from querying the knowledge base.
setText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
The part of the generated text that contains a citation.
setTextPromptTemplate(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
The template for the prompt that's sent to the model for response generation.
setTextResponsePart(TextResponsePart) - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
Contains metadata about a textual part of the generated response that is accompanied by a citation.
setType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
The type of the location of the data source.
setType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
The type of resource that is queried by the request.
setUri(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
The S3 URI of the data source.
setVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
Contains details about how the results from the vector search should be returned.
shutdown() - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime
 
shutdown() - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime
Shuts down this client object, releasing any resources that might be held open.
shutdown() - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient
Shuts down the client, releasing all managed resources.
shutdown() - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient
 
Span - Class in com.amazonaws.services.bedrockagentruntime.model
Contains information about where the text with a citation begins and ends in the generated output.
Span() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.Span
 
standard() - Static method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClientBuilder
 
standard() - Static method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClientBuilder
 

T

TextResponsePart - Class in com.amazonaws.services.bedrockagentruntime.model
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
TextResponsePart() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
 
ThrottlingException - Exception in com.amazonaws.services.bedrockagentruntime.model
The number of requests exceeds the limit.
ThrottlingException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.ThrottlingException
Constructs a new ThrottlingException with the specified error message.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
Returns a string representation of this object.
toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocationType
 
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
Returns a string representation of this object.
toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateType
 
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
Returns a string representation of this object.
toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.SearchType
 
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Returns a string representation of this object.
toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
Returns a string representation of this object.

V

ValidationException - Exception in com.amazonaws.services.bedrockagentruntime.model
Input validation failed.
ValidationException(String) - Constructor for exception com.amazonaws.services.bedrockagentruntime.model.ValidationException
Constructs a new ValidationException with the specified error message.
valueOf(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.SearchType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.amazonaws.services.bedrockagentruntime.model.SearchType
Returns an array containing the constants of this enum type, in the order they are declared.

W

withAndAll(RetrievalFilter...) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
withAndAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
withCitations(Citation...) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
withCitations(Collection<Citation>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
withContent(RetrievalResultContent) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Contains a chunk of text from a data source in the knowledge base.
withContent(RetrievalResultContent) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Contains the cited text from the data source.
withEnd(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Where the text with a citation ends in the generated output.
withFilter(RetrievalFilter) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
Specifies the filters to use on the metadata in the knowledge base data sources before returning results.
withGeneratedResponsePart(GeneratedResponsePart) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains the generated response and metadata
withGenerationConfiguration(GenerationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configurations for response generation based on the knowwledge base query results.
withInput(RetrieveAndGenerateInput) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains the query to be made to the knowledge base.
withKmsKeyArn(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateSessionConfiguration
The ARN of the KMS key encrypting the session.
withKnowledgeBaseConfiguration(KnowledgeBaseRetrieveAndGenerateConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
Contains details about the resource being queried.
withKnowledgeBaseId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
The unique identifier of the knowledge base that is queried and the foundation model used for generation.
withKnowledgeBaseId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
The unique identifier of the knowledge base to query.
withLocation(RetrievalResultLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
Contains information about the location of the data source.
withLocation(RetrievalResultLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievedReference
Contains information about the location of the data source.
withModelArn(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
The ARN of the foundation model used to generate a response.
withNextToken(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
If there are more results than can fit in the response, the response returns a nextToken.
withNextToken(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
If there are more results than can fit in the response, the response returns a nextToken.
withNumberOfResults(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
The number of source chunks to retrieve.
withOrAll(RetrievalFilter...) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
withOrAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter
Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
withOutput(RetrieveAndGenerateOutput) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
Contains the response generated from querying the knowledge base.
withOverrideSearchType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
By default, Amazon Bedrock decides a search strategy for you.
withOverrideSearchType(SearchType) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseVectorSearchConfiguration
By default, Amazon Bedrock decides a search strategy for you.
withPromptTemplate(PromptTemplate) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration
Contains the template for the prompt that's sent to the model for response generation.
withResourceName(String) - Method in exception com.amazonaws.services.bedrockagentruntime.model.BadGatewayException
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
withResourceName(String) - Method in exception com.amazonaws.services.bedrockagentruntime.model.DependencyFailedException
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configurations for how to retrieve and return the knowledge base query.
withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Contains configurations for the knowledge base query and retrieval process.
withRetrievalQuery(KnowledgeBaseQuery) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest
Contains the query to send the knowledge base.
withRetrievalResults(KnowledgeBaseRetrievalResult...) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
A list of results from querying the knowledge base.
withRetrievalResults(Collection<KnowledgeBaseRetrievalResult>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveResult
A list of results from querying the knowledge base.
withRetrieveAndGenerateConfiguration(RetrieveAndGenerateConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains configurations for the knowledge base query and retrieval process.
withRetrievedReferences(RetrievedReference...) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains metadata about the sources cited for the generated response.
withRetrievedReferences(Collection<RetrievedReference>) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation
Contains metadata about the sources cited for the generated response.
withS3Location(RetrievalResultS3Location) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
Contains the S3 location of the data source.
withScore(Double) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult
The level of relevance of the result to the query.
withSessionConfiguration(RetrieveAndGenerateSessionConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
Contains details about the session with the knowledge base.
withSessionId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateRequest
The unique identifier of the session.
withSessionId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult
The unique identifier of the session.
withSpan(Span) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
Contains information about where the text with a citation begins and ends in the generated output.
withStart(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span
Where the text with a citation starts in the generated output.
withText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseQuery
The text of the query made to the knowledge base.
withText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultContent
The cited text from the data source.
withText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateInput
The query made to the knowledge base.
withText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateOutput
The response generated from querying the knowledge base.
withText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart
The part of the generated text that contains a citation.
withTextPromptTemplate(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate
The template for the prompt that's sent to the model for response generation.
withTextResponsePart(TextResponsePart) - Method in class com.amazonaws.services.bedrockagentruntime.model.GeneratedResponsePart
Contains metadata about a textual part of the generated response that is accompanied by a citation.
withType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
The type of the location of the data source.
withType(RetrievalResultLocationType) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation
The type of the location of the data source.
withType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
The type of resource that is queried by the request.
withType(RetrieveAndGenerateType) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration
The type of resource that is queried by the request.
withUri(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location
The S3 URI of the data source.
withVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration
Contains details about how the results from the vector search should be returned.
A B C D E F G H I K M P R S T V W 
Skip navigation links

Copyright © 2024. All rights reserved.