com.amazonaws.services.kendraranking.AmazonKendraRankingAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendraranking Show documentation
/*
* 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.kendraranking;
import javax.annotation.Generated;
import com.amazonaws.services.kendraranking.model.*;
/**
* Interface for accessing Kendra Ranking 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.kendraranking.AbstractAmazonKendraRankingAsync} instead.
*
*
*
* Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search
* service's results.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKendraRankingAsync extends AmazonKendraRanking {
/**
*
* Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
* for provisioning the Rescore API. You set the number of capacity units that you require for Amazon
* Kendra Intelligent Ranking to rescore or re-rank a search service's results.
*
*
* For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java
* SDKs, see Semantically ranking
* a search service's results.
*
*
* @param createRescoreExecutionPlanRequest
* @return A Java Future containing the result of the CreateRescoreExecutionPlan operation returned by the service.
* @sample AmazonKendraRankingAsync.CreateRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future createRescoreExecutionPlanAsync(
CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest);
/**
*
* Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
* for provisioning the Rescore API. You set the number of capacity units that you require for Amazon
* Kendra Intelligent Ranking to rescore or re-rank a search service's results.
*
*
* For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java
* SDKs, see Semantically ranking
* a search service's results.
*
*
* @param createRescoreExecutionPlanRequest
* @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 CreateRescoreExecutionPlan operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.CreateRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future createRescoreExecutionPlanAsync(
CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
* for provisioning the Rescore API.
*
*
* @param deleteRescoreExecutionPlanRequest
* @return A Java Future containing the result of the DeleteRescoreExecutionPlan operation returned by the service.
* @sample AmazonKendraRankingAsync.DeleteRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteRescoreExecutionPlanAsync(
DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest);
/**
*
* Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
* for provisioning the Rescore API.
*
*
* @param deleteRescoreExecutionPlanRequest
* @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 DeleteRescoreExecutionPlan operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.DeleteRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteRescoreExecutionPlanAsync(
DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking
* resource used for provisioning the Rescore API.
*
*
* @param describeRescoreExecutionPlanRequest
* @return A Java Future containing the result of the DescribeRescoreExecutionPlan operation returned by the
* service.
* @sample AmazonKendraRankingAsync.DescribeRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future describeRescoreExecutionPlanAsync(
DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest);
/**
*
* Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking
* resource used for provisioning the Rescore API.
*
*
* @param describeRescoreExecutionPlanRequest
* @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 DescribeRescoreExecutionPlan operation returned by the
* service.
* @sample AmazonKendraRankingAsyncHandler.DescribeRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future describeRescoreExecutionPlanAsync(
DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource
* used for provisioning the Rescore API.
*
*
* @param listRescoreExecutionPlansRequest
* @return A Java Future containing the result of the ListRescoreExecutionPlans operation returned by the service.
* @sample AmazonKendraRankingAsync.ListRescoreExecutionPlans
* @see AWS API Documentation
*/
java.util.concurrent.Future listRescoreExecutionPlansAsync(
ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest);
/**
*
* Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource
* used for provisioning the Rescore API.
*
*
* @param listRescoreExecutionPlansRequest
* @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 ListRescoreExecutionPlans operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.ListRescoreExecutionPlans
* @see AWS API Documentation
*/
java.util.concurrent.Future listRescoreExecutionPlansAsync(
ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource
* that can have tags associated with it.
*
*
* @param listTagsForResourceRequest
* The request information for listing tags associated with a rescore execution plan. A rescore execution
* plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonKendraRankingAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource
* that can have tags associated with it.
*
*
* @param listTagsForResourceRequest
* The request information for listing tags associated with a rescore execution plan. A rescore execution
* plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
* @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 ListTagsForResource operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic
* search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.
*
*
* @param rescoreRequest
* @return A Java Future containing the result of the Rescore operation returned by the service.
* @sample AmazonKendraRankingAsync.Rescore
* @see AWS API
* Documentation
*/
java.util.concurrent.Future rescoreAsync(RescoreRequest rescoreRequest);
/**
*
* Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic
* search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.
*
*
* @param rescoreRequest
* @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 Rescore operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.Rescore
* @see AWS API
* Documentation
*/
java.util.concurrent.Future rescoreAsync(RescoreRequest rescoreRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra
* Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the
* existing value is replaced with the new value.
*
*
* @param tagResourceRequest
* The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra
* Intelligent Ranking resource used for provisioning the Rescore API.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonKendraRankingAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra
* Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the
* existing value is replaced with the new value.
*
*
* @param tagResourceRequest
* The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra
* Intelligent Ranking resource used for provisioning the Rescore API.
* @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 TagResource operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking
* resource used for provisioning the Rescore operation.
*
*
* @param untagResourceRequest
* The request information to remove a tag from a rescore execution plan. A rescore execution plan is an
* Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonKendraRankingAsync.UntagResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking
* resource used for provisioning the Rescore operation.
*
*
* @param untagResourceRequest
* The request information to remove a tag from a rescore execution plan. A rescore execution plan is an
* Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.
* @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 UntagResource operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.UntagResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
* for provisioning the Rescore API. You can update the number of capacity units you require for Amazon
* Kendra Intelligent Ranking to rescore or re-rank a search service's results.
*
*
* @param updateRescoreExecutionPlanRequest
* @return A Java Future containing the result of the UpdateRescoreExecutionPlan operation returned by the service.
* @sample AmazonKendraRankingAsync.UpdateRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future updateRescoreExecutionPlanAsync(
UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest);
/**
*
* Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
* for provisioning the Rescore API. You can update the number of capacity units you require for Amazon
* Kendra Intelligent Ranking to rescore or re-rank a search service's results.
*
*
* @param updateRescoreExecutionPlanRequest
* @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 UpdateRescoreExecutionPlan operation returned by the service.
* @sample AmazonKendraRankingAsyncHandler.UpdateRescoreExecutionPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future updateRescoreExecutionPlanAsync(
UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}