com.amazonaws.services.kendraranking

Interface AmazonKendraRankingAsync

All Superinterfaces:

AmazonKendraRanking

All Known Implementing Classes:

AbstractAmazonKendraRankingAsync, AmazonKendraRankingAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKendraRankingAsync
extends AmazonKendraRanking

Interface for accessing Kendra Ranking 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.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKendraRankingAsync instead.

Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.

Field Summary

Fields inherited from interface com.amazonaws.services.kendraranking.AmazonKendraRanking

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CreateRescoreExecutionPlanResult>	createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest) Creates a rescore execution plan.
Future<CreateRescoreExecutionPlanResult>	createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest, AsyncHandler<CreateRescoreExecutionPlanRequest,CreateRescoreExecutionPlanResult> asyncHandler) Creates a rescore execution plan.
Future<DeleteRescoreExecutionPlanResult>	deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest) Deletes a rescore execution plan.
Future<DeleteRescoreExecutionPlanResult>	deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest, AsyncHandler<DeleteRescoreExecutionPlanRequest,DeleteRescoreExecutionPlanResult> asyncHandler) Deletes a rescore execution plan.
Future<DescribeRescoreExecutionPlanResult>	describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest) Gets information about a rescore execution plan.
Future<DescribeRescoreExecutionPlanResult>	describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest, AsyncHandler<DescribeRescoreExecutionPlanRequest,DescribeRescoreExecutionPlanResult> asyncHandler) Gets information about a rescore execution plan.
Future<ListRescoreExecutionPlansResult>	listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) Lists your rescore execution plans.
Future<ListRescoreExecutionPlansResult>	listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest, AsyncHandler<ListRescoreExecutionPlansRequest,ListRescoreExecutionPlansResult> asyncHandler) Lists your rescore execution plans.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with a specified resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Gets a list of tags associated with a specified resource.
Future<RescoreResult>	rescoreAsync(RescoreRequest rescoreRequest) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
Future<RescoreResult>	rescoreAsync(RescoreRequest rescoreRequest, AsyncHandler<RescoreRequest,RescoreResult> asyncHandler) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest) Adds a specified tag to a specified rescore execution plan.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds a specified tag to a specified rescore execution plan.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest) Removes a tag from a rescore execution plan.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes a tag from a rescore execution plan.
Future<UpdateRescoreExecutionPlanResult>	updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest) Updates a rescore execution plan.
Future<UpdateRescoreExecutionPlanResult>	updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest, AsyncHandler<UpdateRescoreExecutionPlanRequest,UpdateRescoreExecutionPlanResult> asyncHandler) Updates a rescore execution plan.

Methods inherited from interface com.amazonaws.services.kendraranking.AmazonKendraRanking

createRescoreExecutionPlan, deleteRescoreExecutionPlan, describeRescoreExecutionPlan, getCachedResponseMetadata, listRescoreExecutionPlans, listTagsForResource, rescore, shutdown, tagResource, untagResource, updateRescoreExecutionPlan

Method Detail

createRescoreExecutionPlanAsync

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

Parameters:

createRescoreExecutionPlanRequest -

Returns:

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

See Also:

AWS API Documentation

createRescoreExecutionPlanAsync

Future<CreateRescoreExecutionPlanResult> createRescoreExecutionPlanAsync(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest,
                                                                         AsyncHandler<CreateRescoreExecutionPlanRequest,CreateRescoreExecutionPlanResult> asyncHandler)

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.

Parameters:

createRescoreExecutionPlanRequest -

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 CreateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

deleteRescoreExecutionPlanAsync

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

Parameters:

deleteRescoreExecutionPlanRequest -

Returns:

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

See Also:

AWS API Documentation

deleteRescoreExecutionPlanAsync

Future<DeleteRescoreExecutionPlanResult> deleteRescoreExecutionPlanAsync(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest,
                                                                         AsyncHandler<DeleteRescoreExecutionPlanRequest,DeleteRescoreExecutionPlanResult> asyncHandler)

Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Parameters:

deleteRescoreExecutionPlanRequest -

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 DeleteRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

describeRescoreExecutionPlanAsync

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

Parameters:

describeRescoreExecutionPlanRequest -

Returns:

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

See Also:

AWS API Documentation

describeRescoreExecutionPlanAsync

Future<DescribeRescoreExecutionPlanResult> describeRescoreExecutionPlanAsync(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest,
                                                                             AsyncHandler<DescribeRescoreExecutionPlanRequest,DescribeRescoreExecutionPlanResult> 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.

Parameters:

describeRescoreExecutionPlanRequest -

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 DescribeRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

listRescoreExecutionPlansAsync

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

Parameters:

listRescoreExecutionPlansRequest -

Returns:

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

See Also:

AWS API Documentation

listRescoreExecutionPlansAsync

Future<ListRescoreExecutionPlansResult> listRescoreExecutionPlansAsync(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest,
                                                                       AsyncHandler<ListRescoreExecutionPlansRequest,ListRescoreExecutionPlansResult> asyncHandler)

Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Parameters:

listRescoreExecutionPlansRequest -

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 ListRescoreExecutionPlans operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

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

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> 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.

Parameters:

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.

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 ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

rescoreAsync

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

Parameters:

rescoreRequest -

Returns:

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

See Also:

AWS API Documentation

rescoreAsync

Future<RescoreResult> rescoreAsync(RescoreRequest rescoreRequest,
                                   AsyncHandler<RescoreRequest,RescoreResult> 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.

Parameters:

rescoreRequest -

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 Rescore operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

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

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> 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.

Parameters:

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.

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 TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

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

Parameters:

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.

Returns:

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

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> 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.

Parameters:

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.

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 UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateRescoreExecutionPlanAsync

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

Parameters:

updateRescoreExecutionPlanRequest -

Returns:

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

See Also:

AWS API Documentation

updateRescoreExecutionPlanAsync

Future<UpdateRescoreExecutionPlanResult> updateRescoreExecutionPlanAsync(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest,
                                                                         AsyncHandler<UpdateRescoreExecutionPlanRequest,UpdateRescoreExecutionPlanResult> 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.

Parameters:

updateRescoreExecutionPlanRequest -

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 UpdateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation