@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKendraRankingAsync extends AmazonKendraRanking
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.
ENDPOINT_PREFIX
createRescoreExecutionPlan, deleteRescoreExecutionPlan, describeRescoreExecutionPlan, getCachedResponseMetadata, listRescoreExecutionPlans, listTagsForResource, rescore, shutdown, tagResource, untagResource, updateRescoreExecutionPlan
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.
createRescoreExecutionPlanRequest
- 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.
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.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.
deleteRescoreExecutionPlanRequest
- 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.
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.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.
describeRescoreExecutionPlanRequest
- 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.
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.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.
listRescoreExecutionPlansRequest
- 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.
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.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.
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.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.
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.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.
rescoreRequest
- 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.
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.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.
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.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.
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.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.
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.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.
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.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.
updateRescoreExecutionPlanRequest
- 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.
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.