com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeAsync Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.bedrockagentruntime;

import javax.annotation.Generated;

import com.amazonaws.services.bedrockagentruntime.model.*;

/**
 * Interface 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 {@code AsyncHandler} can be used to
 * receive notification when an asynchronous operation completes.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.bedrockagentruntime.AbstractAWSBedrockAgentRuntimeAsync} instead.
 * 
 * 
 * 

 * Contains APIs related to model invocation and querying of knowledge bases.
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBedrockAgentRuntimeAsync extends AWSBedrockAgentRuntime {

    /**
     * 
     * Deletes memory from the specified memory identifier.
     * 
     * 
     * @param deleteAgentMemoryRequest
     * @return A Java Future containing the result of the DeleteAgentMemory operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsync.DeleteAgentMemory
     * @see AWS API Documentation
     */
    java.util.concurrent.Future deleteAgentMemoryAsync(DeleteAgentMemoryRequest deleteAgentMemoryRequest);

    /**
     * 
     * Deletes memory from the specified memory identifier.
     * 
     * 
     * @param deleteAgentMemoryRequest
     * @param 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.
     * @return A Java Future containing the result of the DeleteAgentMemory operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsyncHandler.DeleteAgentMemory
     * @see AWS API Documentation
     */
    java.util.concurrent.Future deleteAgentMemoryAsync(DeleteAgentMemoryRequest deleteAgentMemoryRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Gets the sessions stored in the memory of the agent.
     * 
     * 
     * @param getAgentMemoryRequest
     * @return A Java Future containing the result of the GetAgentMemory operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsync.GetAgentMemory
     * @see AWS API Documentation
     */
    java.util.concurrent.Future getAgentMemoryAsync(GetAgentMemoryRequest getAgentMemoryRequest);

    /**
     * 
     * Gets the sessions stored in the memory of the agent.
     * 
     * 
     * @param getAgentMemoryRequest
     * @param 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.
     * @return A Java Future containing the result of the GetAgentMemory operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsyncHandler.GetAgentMemory
     * @see AWS API Documentation
     */
    java.util.concurrent.Future getAgentMemoryAsync(GetAgentMemoryRequest getAgentMemoryRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Queries a knowledge base and retrieves information from it.
     * 
     * 
     * @param retrieveRequest
     * @return A Java Future containing the result of the Retrieve operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsync.Retrieve
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future retrieveAsync(RetrieveRequest retrieveRequest);

    /**
     * 
     * Queries a knowledge base and retrieves information from it.
     * 
     * 
     * @param retrieveRequest
     * @param 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.
     * @return A Java Future containing the result of the Retrieve operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsyncHandler.Retrieve
     * @see AWS
     *      API Documentation
     */
    java.util.concurrent.Future retrieveAsync(RetrieveRequest retrieveRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources
     * that are relevant to the query.
     * 
     * 
     * @param retrieveAndGenerateRequest
     * @return A Java Future containing the result of the RetrieveAndGenerate operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsync.RetrieveAndGenerate
     * @see AWS API Documentation
     */
    java.util.concurrent.Future retrieveAndGenerateAsync(RetrieveAndGenerateRequest retrieveAndGenerateRequest);

    /**
     * 
     * Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources
     * that are relevant to the query.
     * 
     * 
     * @param retrieveAndGenerateRequest
     * @param 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.
     * @return A Java Future containing the result of the RetrieveAndGenerate operation returned by the service.
     * @sample AWSBedrockAgentRuntimeAsyncHandler.RetrieveAndGenerate
     * @see AWS API Documentation
     */
    java.util.concurrent.Future retrieveAndGenerateAsync(RetrieveAndGenerateRequest retrieveAndGenerateRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

}