- 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.
- 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
-
- 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.
- 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.