com.amazonaws.services.bedrockagentruntime

Class AWSBedrockAgentRuntimeAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient

com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsyncClient

All Implemented Interfaces:

AWSBedrockAgentRuntime, AWSBedrockAgentRuntimeAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBedrockAgentRuntimeAsyncClient
extends AWSBedrockAgentRuntimeClient
implements AWSBedrockAgentRuntimeAsync

Client for accessing Agents for Amazon Bedrock Runtime asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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

Field Summary

Fields inherited from class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSBedrockAgentRuntimeAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<RetrieveAndGenerateResult>	retrieveAndGenerateAsync(RetrieveAndGenerateRequest request) Queries a knowledge base and generates responses based on the retrieved results.
Future<RetrieveAndGenerateResult>	retrieveAndGenerateAsync(RetrieveAndGenerateRequest request, AsyncHandler<RetrieveAndGenerateRequest,RetrieveAndGenerateResult> asyncHandler) Queries a knowledge base and generates responses based on the retrieved results.
Future<RetrieveResult>	retrieveAsync(RetrieveRequest request) Queries a knowledge base and retrieves information from it.
Future<RetrieveResult>	retrieveAsync(RetrieveRequest request, AsyncHandler<RetrieveRequest,RetrieveResult> asyncHandler) Queries a knowledge base and retrieves information from it.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient

builder, getCachedResponseMetadata, retrieve, retrieveAndGenerate

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime

getCachedResponseMetadata, retrieve, retrieveAndGenerate

Method Detail

asyncBuilder

public static AWSBedrockAgentRuntimeAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

retrieveAsync

public Future<RetrieveResult> retrieveAsync(RetrieveRequest request)

Description copied from interface: AWSBedrockAgentRuntimeAsync

Queries a knowledge base and retrieves information from it.

Specified by:

retrieveAsync in interface AWSBedrockAgentRuntimeAsync

Returns:

A Java Future containing the result of the Retrieve operation returned by the service.

See Also:

AWS API Documentation

retrieveAsync

public Future<RetrieveResult> retrieveAsync(RetrieveRequest request,
                                            AsyncHandler<RetrieveRequest,RetrieveResult> asyncHandler)

Description copied from interface: AWSBedrockAgentRuntimeAsync

Queries a knowledge base and retrieves information from it.

Specified by:

retrieveAsync in interface AWSBedrockAgentRuntimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the Retrieve operation returned by the service.

See Also:

AWS API Documentation

retrieveAndGenerateAsync

public Future<RetrieveAndGenerateResult> retrieveAndGenerateAsync(RetrieveAndGenerateRequest request)

Description copied from interface: AWSBedrockAgentRuntimeAsync

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

Specified by:

retrieveAndGenerateAsync in interface AWSBedrockAgentRuntimeAsync

Returns:

A Java Future containing the result of the RetrieveAndGenerate operation returned by the service.

See Also:

AWS API Documentation

retrieveAndGenerateAsync

public Future<RetrieveAndGenerateResult> retrieveAndGenerateAsync(RetrieveAndGenerateRequest request,
                                                                  AsyncHandler<RetrieveAndGenerateRequest,RetrieveAndGenerateResult> asyncHandler)

Description copied from interface: AWSBedrockAgentRuntimeAsync

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

Specified by:

retrieveAndGenerateAsync in interface AWSBedrockAgentRuntimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RetrieveAndGenerate operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSBedrockAgentRuntime

Overrides:

shutdown in class AWSBedrockAgentRuntimeClient