Package software.amazon.awssdk.services.bedrockagentruntime

Interface BedrockAgentRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BedrockAgentRuntimeClient
extends AwsClient

Service client for accessing Agents for Amazon Bedrock Runtime. This can be created using the static builder() method.

Contains APIs related to model invocation and querying of knowledge bases.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static BedrockAgentRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a BedrockAgentRuntimeClient.
static BedrockAgentRuntimeClient	create()	Create a BedrockAgentRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default RetrieveResponse	retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)	Queries a knowledge base and retrieves information from it.
default RetrieveResponse	retrieve(RetrieveRequest retrieveRequest)	Queries a knowledge base and retrieves information from it.
default RetrieveAndGenerateResponse	retrieveAndGenerate(Consumer<RetrieveAndGenerateRequest.Builder> retrieveAndGenerateRequest)	Queries a knowledge base and generates responses based on the retrieved results.
default RetrieveAndGenerateResponse	retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest)	Queries a knowledge base and generates responses based on the retrieved results.
default RetrieveIterable	retrievePaginator(Consumer<RetrieveRequest.Builder> retrieveRequest)	This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.
default RetrieveIterable	retrievePaginator(RetrieveRequest retrieveRequest)	This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.
default BedrockAgentRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

retrieve

default RetrieveResponse retrieve(RetrieveRequest retrieveRequest)
                           throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and retrieves information from it.

Parameters:

retrieveRequest -

Returns:

Result of the Retrieve operation returned by the service.

See Also:

• AWS API Documentation

retrieve

default RetrieveResponse retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)
                           throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and retrieves information from it.

This is a convenience which creates an instance of the RetrieveRequest.Builder avoiding the need to create one manually via RetrieveRequest.builder()

Parameters:

retrieveRequest - A Consumer that will call methods on RetrieveRequest.Builder to create a request.

Returns:

Result of the Retrieve operation returned by the service.

See Also:

• AWS API Documentation

retrievePaginator

default RetrieveIterable retrievePaginator(RetrieveRequest retrieveRequest)
                                    throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.

Parameters:

retrieveRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrievePaginator

default RetrieveIterable retrievePaginator(Consumer<RetrieveRequest.Builder> retrieveRequest)
                                    throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.

This is a convenience which creates an instance of the RetrieveRequest.Builder avoiding the need to create one manually via RetrieveRequest.builder()

Parameters:

retrieveRequest - A Consumer that will call methods on RetrieveRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrieveAndGenerate

default RetrieveAndGenerateResponse retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest)
                                                 throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.

Parameters:

retrieveAndGenerateRequest -

Returns:

Result of the RetrieveAndGenerate operation returned by the service.

See Also:

• AWS API Documentation

retrieveAndGenerate

default RetrieveAndGenerateResponse retrieveAndGenerate(Consumer<RetrieveAndGenerateRequest.Builder> retrieveAndGenerateRequest)
                                                 throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.

This is a convenience which creates an instance of the RetrieveAndGenerateRequest.Builder avoiding the need to create one manually via RetrieveAndGenerateRequest.builder()

Parameters:

retrieveAndGenerateRequest - A Consumer that will call methods on RetrieveAndGenerateRequest.Builder to create a request.

Returns:

Result of the RetrieveAndGenerate operation returned by the service.

See Also:

• AWS API Documentation

create

static BedrockAgentRuntimeClient create()

Create a BedrockAgentRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BedrockAgentRuntimeClientBuilder builder()

Create a builder that can be used to configure and create a BedrockAgentRuntimeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BedrockAgentRuntimeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration