A B C D E F G H I K M O P Q 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

ByteContentDoc - Class in com.amazonaws.services.bedrockagentruntime.model

This property contains the document to chat with, along with its attributes.

ByteContentDoc() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

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

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryResult

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

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

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

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

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

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

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

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

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span

clone() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

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

deleteAgentMemory(DeleteAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime

deleteAgentMemory(DeleteAgentMemoryRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime

Deletes memory from the specified memory identifier.

deleteAgentMemory(DeleteAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient

Deletes memory from the specified memory identifier.

deleteAgentMemoryAsync(DeleteAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync

deleteAgentMemoryAsync(DeleteAgentMemoryRequest, AsyncHandler<DeleteAgentMemoryRequest, DeleteAgentMemoryResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync

deleteAgentMemoryAsync(DeleteAgentMemoryRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync

Deletes memory from the specified memory identifier.

deleteAgentMemoryAsync(DeleteAgentMemoryRequest, AsyncHandler<DeleteAgentMemoryRequest, DeleteAgentMemoryResult>) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync

Deletes memory from the specified memory identifier.

deleteAgentMemoryAsync(DeleteAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient

deleteAgentMemoryAsync(DeleteAgentMemoryRequest, AsyncHandler<DeleteAgentMemoryRequest, DeleteAgentMemoryResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient

DeleteAgentMemoryRequest - Class in com.amazonaws.services.bedrockagentruntime.model

DeleteAgentMemoryRequest() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

DeleteAgentMemoryResult - Class in com.amazonaws.services.bedrockagentruntime.model

DeleteAgentMemoryResult() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryResult

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

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryResult

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

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

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

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

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

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

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

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

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

equals(Object) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart

ExternalSource - Class in com.amazonaws.services.bedrockagentruntime.model

The unique external source of the content contained in the wrapper object.

ExternalSource() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

ExternalSourcesGenerationConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model

Contains the generation configuration of the external source wrapper object.

ExternalSourcesGenerationConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

ExternalSourcesRetrieveAndGenerateConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model

The configurations of the external source wrapper object in the retrieveAndGenerate function.

ExternalSourcesRetrieveAndGenerateConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

ExternalSourceType - Enum in com.amazonaws.services.bedrockagentruntime.model

F

fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.ExternalSourceType

Use this in place of valueOf.

fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.GuadrailAction

Use this in place of valueOf.

fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.MemoryType

Use this in place of valueOf.

fromValue(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.QueryTransformationType

Use this in place of valueOf.

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

getAgentAliasId() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of an alias of an agent.

getAgentAliasId() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of an alias of an agent.

getAgentId() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of the agent to which the alias belongs.

getAgentId() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of the agent to which the alias belongs.

getAgentMemory(GetAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntime

getAgentMemory(GetAgentMemoryRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime

Gets the sessions stored in the memory of the agent.

getAgentMemory(GetAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient

Gets the sessions stored in the memory of the agent.

getAgentMemoryAsync(GetAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync

getAgentMemoryAsync(GetAgentMemoryRequest, AsyncHandler<GetAgentMemoryRequest, GetAgentMemoryResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync

getAgentMemoryAsync(GetAgentMemoryRequest) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync

Gets the sessions stored in the memory of the agent.

getAgentMemoryAsync(GetAgentMemoryRequest, AsyncHandler<GetAgentMemoryRequest, GetAgentMemoryResult>) - Method in interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync

Gets the sessions stored in the memory of the agent.

getAgentMemoryAsync(GetAgentMemoryRequest) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient

getAgentMemoryAsync(GetAgentMemoryRequest, AsyncHandler<GetAgentMemoryRequest, GetAgentMemoryResult>) - Method in class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient

GetAgentMemoryRequest - Class in com.amazonaws.services.bedrockagentruntime.model

GetAgentMemoryRequest() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

GetAgentMemoryResult - Class in com.amazonaws.services.bedrockagentruntime.model

GetAgentMemoryResult() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

getAndAll() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

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

getByteContent() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The identifier, contentType, and data of the external source wrapper object.

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.

getConfluenceLocation() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The Confluence data source location.

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.

getContentType() - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The MIME type of the document contained in the wrapper object.

getData() - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The byte value of the file to upload, encoded as a Base-64 string.

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.

getExternalSourcesConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

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

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

getGenerationConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

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

getGuardrailAction() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult

Specifies if there is a guardrail intervention in the response.

getGuardrailConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

The configuration details for the guardrail.

getGuardrailConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration

The configuration details for the guardrail.

getGuardrailId() - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

The unique identifier for the guardrail.

getGuardrailVersion() - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

The version of the guardrail.

getIdentifier() - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The file name of the document contained in the wrapper object.

getInferenceConfig() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

getInferenceConfig() - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

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.

getMaxItems() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The maximum number of items to return in the response.

getMaxTokens() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

The maximum number of tokens to generate in the output text.

getMemoryContents() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

Contains details of the sessions stored in the memory

getMemoryId() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of the memory.

getMemoryId() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of the memory.

getMemoryId() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The unique identifier of the memory where the session summary is stored.

getMemoryType() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The type of memory.

getModelArn() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The modelArn used with the external source wrapper object in the retrieveAndGenerate function.

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

If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

getNextToken() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

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 are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

getOrchestrationConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

Settings for how the model processes the prompt prior to retrieval and generation.

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

Contain the textPromptTemplate string for the external source wrapper object.

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.

getQueryTransformationConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

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

The S3 location of the external source wrapper object.

getS3Location() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The S3 data source location.

getSalesforceLocation() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The Salesforce data source location.

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.

getSessionExpiryTime() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The time when the memory duration for the session is set to end.

getSessionId() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The identifier for this session.

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.

getSessionStartTime() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The start time for this session.

getSessionSummary() - Method in class com.amazonaws.services.bedrockagentruntime.model.Memory

Contains summary of a session.

getSharePointLocation() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The SharePoint data source location.

getSources() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The document used with the external source wrapper object in the retrieveAndGenerate function.

getSourceType() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The source type of the external source wrapper object.

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.

getStopSequences() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens.

getSummaryText() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The summarized text for this session.

getTemperature() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options.

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.

getTextInferenceConfig() - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

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.

getTopP() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A probability distribution threshold which controls what the model considers for the set of possible next tokens.

getType() - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

The type of transformation to apply to the prompt.

getType() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The type of data source location.

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 for the data source location.

getUri() - Method in class com.amazonaws.services.bedrockagentruntime.model.S3ObjectDoc

The file location of the S3 wrapper object.

getUrl() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

The Confluence host URL for the data source location.

getUrl() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSalesforceLocation

The Salesforce host URL for the data source location.

getUrl() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

The SharePoint site URL for the data source location.

getUrl() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

The web URL/URLs for the data source location.

getVectorSearchConfiguration() - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration

Contains details about how the results from the vector search should be returned.

getWebLocation() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The web URL/URLs data source location.

GuadrailAction - Enum in com.amazonaws.services.bedrockagentruntime.model

GuardrailConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model

The configuration details for the guardrail.

GuardrailConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

H

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryResult

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

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

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

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

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

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

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

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

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.Span

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

hashCode() - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart

I

InferenceConfig - Class in com.amazonaws.services.bedrockagentruntime.model

The configuration for inference settings when generating responses using RetrieveAndGenerate.

InferenceConfig() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

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 knowledge base query.

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

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.Citation

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

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

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

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

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.PromptTemplate

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

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

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

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

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

marshall(ProtocolMarshaller) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextResponsePart

Memory - Class in com.amazonaws.services.bedrockagentruntime.model

Contains sessions summaries.

Memory() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.Memory

MemorySessionSummary - Class in com.amazonaws.services.bedrockagentruntime.model

Contains details of a session summary.

MemorySessionSummary() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

MemoryType - Enum in com.amazonaws.services.bedrockagentruntime.model

O

OrchestrationConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model

Settings for how the model processes the prompt prior to retrieval and generation.

OrchestrationConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

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

Q

QueryTransformationConfiguration - Class in com.amazonaws.services.bedrockagentruntime.model

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION .

QueryTransformationConfiguration() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

QueryTransformationType - Enum in com.amazonaws.services.bedrockagentruntime.model

R

ResourceNotFoundException - Exception in com.amazonaws.services.bedrockagentruntime.model

The specified resource Amazon Resource Name (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

RetrievalResultConfluenceLocation - Class in com.amazonaws.services.bedrockagentruntime.model

The Confluence data source location.

RetrievalResultConfluenceLocation() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

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 data source location.

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

The S3 data source location.

RetrievalResultS3Location() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultS3Location

RetrievalResultSalesforceLocation - Class in com.amazonaws.services.bedrockagentruntime.model

The Salesforce data source location.

RetrievalResultSalesforceLocation() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSalesforceLocation

RetrievalResultSharePointLocation - Class in com.amazonaws.services.bedrockagentruntime.model

The SharePoint data source location.

RetrievalResultSharePointLocation() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

RetrievalResultWebLocation - Class in com.amazonaws.services.bedrockagentruntime.model

The web URL/URLs data source location.

RetrievalResultWebLocation() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

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

S3ObjectDoc - Class in com.amazonaws.services.bedrockagentruntime.model

The unique wrapper object of the document from the S3 location.

S3ObjectDoc() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.S3ObjectDoc

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.

setAgentAliasId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of an alias of an agent.

setAgentAliasId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of an alias of an agent.

setAgentId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of the agent to which the alias belongs.

setAgentId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of the agent to which the alias belongs.

setAndAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

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

setByteContent(ByteContentDoc) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The identifier, contentType, and data of the external source wrapper object.

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.

setConfluenceLocation(RetrievalResultConfluenceLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The Confluence data source location.

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.

setContentType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The MIME type of the document contained in the wrapper object.

setData(ByteBuffer) - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The byte value of the file to upload, encoded as a Base-64 string.

setEnd(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span

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

setExternalSourcesConfiguration(ExternalSourcesRetrieveAndGenerateConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

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(ExternalSourcesGenerationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

setGenerationConfiguration(GenerationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

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

setGuardrailAction(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult

Specifies if there is a guardrail intervention in the response.

setGuardrailConfiguration(GuardrailConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

The configuration details for the guardrail.

setGuardrailConfiguration(GuardrailConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration

The configuration details for the guardrail.

setGuardrailId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

The unique identifier for the guardrail.

setGuardrailVersion(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

The version of the guardrail.

setIdentifier(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The file name of the document contained in the wrapper object.

setInferenceConfig(InferenceConfig) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

setInferenceConfig(InferenceConfig) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

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.

setMaxItems(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The maximum number of items to return in the response.

setMaxTokens(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

The maximum number of tokens to generate in the output text.

setMemoryContents(Collection<Memory>) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

Contains details of the sessions stored in the memory

setMemoryId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of the memory.

setMemoryId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of the memory.

setMemoryId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The unique identifier of the memory where the session summary is stored.

setMemoryType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The type of memory.

setModelArn(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The modelArn used with the external source wrapper object in the retrieveAndGenerate function.

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

If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

setNextToken(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

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 are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

setOrchestrationConfiguration(OrchestrationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

Settings for how the model processes the prompt prior to retrieval and generation.

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

Contain the textPromptTemplate string for the external source wrapper object.

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.

setQueryTransformationConfiguration(QueryTransformationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

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(S3ObjectDoc) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The S3 location of the external source wrapper object.

setS3Location(RetrievalResultS3Location) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The S3 data source location.

setSalesforceLocation(RetrievalResultSalesforceLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The Salesforce data source location.

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.

setSessionExpiryTime(Date) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The time when the memory duration for the session is set to end.

setSessionId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The identifier for this session.

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.

setSessionStartTime(Date) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The start time for this session.

setSessionSummary(MemorySessionSummary) - Method in class com.amazonaws.services.bedrockagentruntime.model.Memory

Contains summary of a session.

setSharePointLocation(RetrievalResultSharePointLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The SharePoint data source location.

setSources(Collection<ExternalSource>) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The document used with the external source wrapper object in the retrieveAndGenerate function.

setSourceType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The source type of the external source wrapper object.

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.

setStopSequences(Collection<String>) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens.

setSummaryText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The summarized text for this session.

setTemperature(Float) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options.

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.

setTextInferenceConfig(TextInferenceConfig) - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

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.

setTopP(Float) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A probability distribution threshold which controls what the model considers for the set of possible next tokens.

setType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

The type of transformation to apply to the prompt.

setType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The type of data source location.

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 for the data source location.

setUri(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.S3ObjectDoc

The file location of the S3 wrapper object.

setUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

The Confluence host URL for the data source location.

setUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSalesforceLocation

The Salesforce host URL for the data source location.

setUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

The SharePoint site URL for the data source location.

setUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

The web URL/URLs for the data source location.

setVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration

Contains details about how the results from the vector search should be returned.

setWebLocation(RetrievalResultWebLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The web URL/URLs data source location.

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

TextInferenceConfig - Class in com.amazonaws.services.bedrockagentruntime.model

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation.

TextInferenceConfig() - Constructor for class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

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

Returns a string representation of this object.

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

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryResult

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

Returns a string representation of this object.

toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.ExternalSourceType

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

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

Returns a string representation of this object.

toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.GuadrailAction

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

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

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

Returns a string representation of this object.

toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.MemoryType

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

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

Returns a string representation of this object.

toString() - Method in enum com.amazonaws.services.bedrockagentruntime.model.QueryTransformationType

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

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

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

Returns a string representation of this object.

toString() - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

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 class com.amazonaws.services.bedrockagentruntime.model.S3ObjectDoc

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

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

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.GuadrailAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.MemoryType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.amazonaws.services.bedrockagentruntime.model.QueryTransformationType

Returns the enum constant of this type with the specified name.

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

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

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

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

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

withAgentAliasId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of an alias of an agent.

withAgentAliasId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of an alias of an agent.

withAgentId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of the agent to which the alias belongs.

withAgentId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of the agent to which the alias belongs.

withAndAll(RetrievalFilter...) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

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

withAndAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

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

withByteContent(ByteContentDoc) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The identifier, contentType, and data of the external source wrapper object.

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.

withConfluenceLocation(RetrievalResultConfluenceLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The Confluence data source location.

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.

withContentType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The MIME type of the document contained in the wrapper object.

withData(ByteBuffer) - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The byte value of the file to upload, encoded as a Base-64 string.

withEnd(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.Span

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

withExternalSourcesConfiguration(ExternalSourcesRetrieveAndGenerateConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

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(ExternalSourcesGenerationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

withGenerationConfiguration(GenerationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

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

withGuardrailAction(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult

Specifies if there is a guardrail intervention in the response.

withGuardrailAction(GuadrailAction) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrieveAndGenerateResult

Specifies if there is a guardrail intervention in the response.

withGuardrailConfiguration(GuardrailConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

The configuration details for the guardrail.

withGuardrailConfiguration(GuardrailConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration

The configuration details for the guardrail.

withGuardrailId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

The unique identifier for the guardrail.

withGuardrailVersion(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GuardrailConfiguration

The version of the guardrail.

withIdentifier(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ByteContentDoc

The file name of the document contained in the wrapper object.

withInferenceConfig(InferenceConfig) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

withInferenceConfig(InferenceConfig) - Method in class com.amazonaws.services.bedrockagentruntime.model.GenerationConfiguration

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

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.

withMaxItems(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The maximum number of items to return in the response.

withMaxTokens(Integer) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

The maximum number of tokens to generate in the output text.

withMemoryContents(Memory...) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

Contains details of the sessions stored in the memory

withMemoryContents(Collection<Memory>) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

Contains details of the sessions stored in the memory

withMemoryId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.DeleteAgentMemoryRequest

The unique identifier of the memory.

withMemoryId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The unique identifier of the memory.

withMemoryId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The unique identifier of the memory where the session summary is stored.

withMemoryType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The type of memory.

withMemoryType(MemoryType) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryRequest

The type of memory.

withModelArn(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The modelArn used with the external source wrapper object in the retrieveAndGenerate function.

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

If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

withNextToken(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.GetAgentMemoryResult

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

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 are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

withOrAll(Collection<RetrievalFilter>) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

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

withOrchestrationConfiguration(OrchestrationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

Settings for how the model processes the prompt prior to retrieval and generation.

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

Contain the textPromptTemplate string for the external source wrapper object.

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.

withQueryTransformationConfiguration(QueryTransformationConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.OrchestrationConfiguration

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

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(S3ObjectDoc) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The S3 location of the external source wrapper object.

withS3Location(RetrievalResultS3Location) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The S3 data source location.

withSalesforceLocation(RetrievalResultSalesforceLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The Salesforce data source location.

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.

withSessionExpiryTime(Date) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The time when the memory duration for the session is set to end.

withSessionId(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The identifier for this session.

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.

withSessionStartTime(Date) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The start time for this session.

withSessionSummary(MemorySessionSummary) - Method in class com.amazonaws.services.bedrockagentruntime.model.Memory

Contains summary of a session.

withSharePointLocation(RetrievalResultSharePointLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The SharePoint data source location.

withSources(ExternalSource...) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The document used with the external source wrapper object in the retrieveAndGenerate function.

withSources(Collection<ExternalSource>) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSourcesRetrieveAndGenerateConfiguration

The document used with the external source wrapper object in the retrieveAndGenerate function.

withSourceType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The source type of the external source wrapper object.

withSourceType(ExternalSourceType) - Method in class com.amazonaws.services.bedrockagentruntime.model.ExternalSource

The source type of the external source wrapper object.

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.

withStopSequences(String...) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens.

withStopSequences(Collection<String>) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens.

withSummaryText(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.MemorySessionSummary

The summarized text for this session.

withTemperature(Float) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options.

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.

withTextInferenceConfig(TextInferenceConfig) - Method in class com.amazonaws.services.bedrockagentruntime.model.InferenceConfig

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

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.

withTopP(Float) - Method in class com.amazonaws.services.bedrockagentruntime.model.TextInferenceConfig

A probability distribution threshold which controls what the model considers for the set of possible next tokens.

withType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

The type of transformation to apply to the prompt.

withType(QueryTransformationType) - Method in class com.amazonaws.services.bedrockagentruntime.model.QueryTransformationConfiguration

The type of transformation to apply to the prompt.

withType(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The type of data source location.

withType(RetrievalResultLocationType) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The type of data source location.

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 for the data source location.

withUri(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.S3ObjectDoc

The file location of the S3 wrapper object.

withUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultConfluenceLocation

The Confluence host URL for the data source location.

withUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSalesforceLocation

The Salesforce host URL for the data source location.

withUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultSharePointLocation

The SharePoint site URL for the data source location.

withUrl(String) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultWebLocation

The web URL/URLs for the data source location.

withVectorSearchConfiguration(KnowledgeBaseVectorSearchConfiguration) - Method in class com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration

Contains details about how the results from the vector search should be returned.

withWebLocation(RetrievalResultWebLocation) - Method in class com.amazonaws.services.bedrockagentruntime.model.RetrievalResultLocation

The web URL/URLs data source location.

A B C D E F G H I K M O P Q R S T V W