@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KendraRankingAsyncClient extends AwsClient
builder()
method.
Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateRescoreExecutionPlanResponse> createRescoreExecutionPlan(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 - default CompletableFuture<CreateRescoreExecutionPlanResponse> createRescoreExecutionPlan(Consumer<CreateRescoreExecutionPlanRequest.Builder> 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.
This is a convenience which creates an instance of the CreateRescoreExecutionPlanRequest.Builder avoiding
the need to create one manually via CreateRescoreExecutionPlanRequest.builder()
createRescoreExecutionPlanRequest - A Consumer that will call methods on CreateRescoreExecutionPlanRequest.Builder to create a
request.default CompletableFuture<DeleteRescoreExecutionPlanResponse> deleteRescoreExecutionPlan(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 - default CompletableFuture<DeleteRescoreExecutionPlanResponse> deleteRescoreExecutionPlan(Consumer<DeleteRescoreExecutionPlanRequest.Builder> deleteRescoreExecutionPlanRequest)
Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used
for provisioning the Rescore API.
This is a convenience which creates an instance of the DeleteRescoreExecutionPlanRequest.Builder avoiding
the need to create one manually via DeleteRescoreExecutionPlanRequest.builder()
deleteRescoreExecutionPlanRequest - A Consumer that will call methods on DeleteRescoreExecutionPlanRequest.Builder to create a
request.default CompletableFuture<DescribeRescoreExecutionPlanResponse> describeRescoreExecutionPlan(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 - default CompletableFuture<DescribeRescoreExecutionPlanResponse> describeRescoreExecutionPlan(Consumer<DescribeRescoreExecutionPlanRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeRescoreExecutionPlanRequest.Builder
avoiding the need to create one manually via DescribeRescoreExecutionPlanRequest.builder()
describeRescoreExecutionPlanRequest - A Consumer that will call methods on DescribeRescoreExecutionPlanRequest.Builder to create
a request.default CompletableFuture<ListRescoreExecutionPlansResponse> listRescoreExecutionPlans(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 - default CompletableFuture<ListRescoreExecutionPlansResponse> listRescoreExecutionPlans(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest)
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource
used for provisioning the Rescore API.
This is a convenience which creates an instance of the ListRescoreExecutionPlansRequest.Builder avoiding
the need to create one manually via ListRescoreExecutionPlansRequest.builder()
listRescoreExecutionPlansRequest - A Consumer that will call methods on ListRescoreExecutionPlansRequest.Builder to create a
request.default ListRescoreExecutionPlansPublisher listRescoreExecutionPlansPaginator(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest)
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource
used for provisioning the Rescore API.
This is a variant of
listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansPublisher publisher = client.listRescoreExecutionPlansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansPublisher publisher = client.listRescoreExecutionPlansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation.
listRescoreExecutionPlansRequest - default ListRescoreExecutionPlansPublisher listRescoreExecutionPlansPaginator(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest)
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource
used for provisioning the Rescore API.
This is a variant of
listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansPublisher publisher = client.listRescoreExecutionPlansPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansPublisher publisher = client.listRescoreExecutionPlansPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation.
This is a convenience which creates an instance of the ListRescoreExecutionPlansRequest.Builder avoiding
the need to create one manually via ListRescoreExecutionPlansRequest.builder()
listRescoreExecutionPlansRequest - A Consumer that will call methods on ListRescoreExecutionPlansRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request. 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.default CompletableFuture<RescoreResponse> rescore(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 - default CompletableFuture<RescoreResponse> rescore(Consumer<RescoreRequest.Builder> 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.
This is a convenience which creates an instance of the RescoreRequest.Builder avoiding the need to create
one manually via RescoreRequest.builder()
rescoreRequest - A Consumer that will call methods on RescoreRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(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.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. 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.default CompletableFuture<UntagResourceResponse> untagResource(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.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. 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.default CompletableFuture<UpdateRescoreExecutionPlanResponse> updateRescoreExecutionPlan(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 - default CompletableFuture<UpdateRescoreExecutionPlanResponse> updateRescoreExecutionPlan(Consumer<UpdateRescoreExecutionPlanRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateRescoreExecutionPlanRequest.Builder avoiding
the need to create one manually via UpdateRescoreExecutionPlanRequest.builder()
updateRescoreExecutionPlanRequest - A Consumer that will call methods on UpdateRescoreExecutionPlanRequest.Builder to create a
request.default KendraRankingServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic KendraRankingAsyncClient create()
KendraRankingAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KendraRankingAsyncClientBuilder builder()
KendraRankingAsyncClient.Copyright © 2023. All rights reserved.