Interface KendraRankingClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic KendraRankingClientBuilder
builder()
Create a builder that can be used to configure and create aKendraRankingClient
.static KendraRankingClient
create()
Create aKendraRankingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createRescoreExecutionPlan
(Consumer<CreateRescoreExecutionPlanRequest.Builder> createRescoreExecutionPlanRequest) Creates a rescore execution plan.createRescoreExecutionPlan
(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest) Creates a rescore execution plan.deleteRescoreExecutionPlan
(Consumer<DeleteRescoreExecutionPlanRequest.Builder> deleteRescoreExecutionPlanRequest) Deletes a rescore execution plan.deleteRescoreExecutionPlan
(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest) Deletes a rescore execution plan.describeRescoreExecutionPlan
(Consumer<DescribeRescoreExecutionPlanRequest.Builder> describeRescoreExecutionPlanRequest) Gets information about a rescore execution plan.describeRescoreExecutionPlan
(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest) Gets information about a rescore execution plan.listRescoreExecutionPlans
(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest) Lists your rescore execution plans.listRescoreExecutionPlans
(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) Lists your rescore execution plans.listRescoreExecutionPlansPaginator
(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest) This is a variant oflistRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation.listRescoreExecutionPlansPaginator
(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) This is a variant oflistRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of tags associated with a specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of tags associated with a specified resource.default RescoreResponse
rescore
(Consumer<RescoreRequest.Builder> rescoreRequest) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).default RescoreResponse
rescore
(RescoreRequest rescoreRequest) Rescores or re-ranks search results from a search service such as OpenSearch (self managed).The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a specified tag to a specified rescore execution plan.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds a specified tag to a specified rescore execution plan.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a rescore execution plan.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from a rescore execution plan.updateRescoreExecutionPlan
(Consumer<UpdateRescoreExecutionPlanRequest.Builder> updateRescoreExecutionPlanRequest) Updates a rescore execution plan.updateRescoreExecutionPlan
(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest) Updates a rescore execution plan.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createRescoreExecutionPlan
default CreateRescoreExecutionPlanResponse createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest) throws AccessDeniedException, ConflictException, ServiceQuotaExceededException, ThrottlingException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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:
- Result of the CreateRescoreExecutionPlan operation returned by the service.
- See Also:
-
createRescoreExecutionPlan
default CreateRescoreExecutionPlanResponse createRescoreExecutionPlan(Consumer<CreateRescoreExecutionPlanRequest.Builder> createRescoreExecutionPlanRequest) throws AccessDeniedException, ConflictException, ServiceQuotaExceededException, ThrottlingException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaCreateRescoreExecutionPlanRequest.builder()
- Parameters:
createRescoreExecutionPlanRequest
- AConsumer
that will call methods onCreateRescoreExecutionPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateRescoreExecutionPlan operation returned by the service.
- See Also:
-
deleteRescoreExecutionPlan
default DeleteRescoreExecutionPlanResponse deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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:
- Result of the DeleteRescoreExecutionPlan operation returned by the service.
- See Also:
-
deleteRescoreExecutionPlan
default DeleteRescoreExecutionPlanResponse deleteRescoreExecutionPlan(Consumer<DeleteRescoreExecutionPlanRequest.Builder> deleteRescoreExecutionPlanRequest) throws AccessDeniedException, ValidationException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaDeleteRescoreExecutionPlanRequest.builder()
- Parameters:
deleteRescoreExecutionPlanRequest
- AConsumer
that will call methods onDeleteRescoreExecutionPlanRequest.Builder
to create a request.- Returns:
- Result of the DeleteRescoreExecutionPlan operation returned by the service.
- See Also:
-
describeRescoreExecutionPlan
default DescribeRescoreExecutionPlanResponse describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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:
- Result of the DescribeRescoreExecutionPlan operation returned by the service.
- See Also:
-
describeRescoreExecutionPlan
default DescribeRescoreExecutionPlanResponse describeRescoreExecutionPlan(Consumer<DescribeRescoreExecutionPlanRequest.Builder> describeRescoreExecutionPlanRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaDescribeRescoreExecutionPlanRequest.builder()
- Parameters:
describeRescoreExecutionPlanRequest
- AConsumer
that will call methods onDescribeRescoreExecutionPlanRequest.Builder
to create a request.- Returns:
- Result of the DescribeRescoreExecutionPlan operation returned by the service.
- See Also:
-
listRescoreExecutionPlans
default ListRescoreExecutionPlansResponse listRescoreExecutionPlans(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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:
- Result of the ListRescoreExecutionPlans operation returned by the service.
- See Also:
-
listRescoreExecutionPlans
default ListRescoreExecutionPlansResponse listRescoreExecutionPlans(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaListRescoreExecutionPlansRequest.builder()
- Parameters:
listRescoreExecutionPlansRequest
- AConsumer
that will call methods onListRescoreExecutionPlansRequest.Builder
to create a request.- Returns:
- Result of the ListRescoreExecutionPlans operation returned by the service.
- See Also:
-
listRescoreExecutionPlansPaginator
default ListRescoreExecutionPlansIterable listRescoreExecutionPlansPaginator(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException This is a variant of
listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client .listRescoreExecutionPlansPaginator(request); for (software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
listRescoreExecutionPlansRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRescoreExecutionPlansPaginator
default ListRescoreExecutionPlansIterable listRescoreExecutionPlansPaginator(Consumer<ListRescoreExecutionPlansRequest.Builder> listRescoreExecutionPlansRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException This is a variant of
listRescoreExecutionPlans(software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client .listRescoreExecutionPlansPaginator(request); for (software.amazon.awssdk.services.kendraranking.model.ListRescoreExecutionPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kendraranking.paginators.ListRescoreExecutionPlansIterable responses = client.listRescoreExecutionPlansPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListRescoreExecutionPlansRequest.builder()
- Parameters:
listRescoreExecutionPlansRequest
- AConsumer
that will call methods onListRescoreExecutionPlansRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 theRescore
API.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.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 theRescore
API.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
rescore
default RescoreResponse rescore(RescoreRequest rescoreRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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:
- Result of the Rescore operation returned by the service.
- See Also:
-
rescore
default RescoreResponse rescore(Consumer<RescoreRequest.Builder> rescoreRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaRescoreRequest.builder()
- Parameters:
rescoreRequest
- AConsumer
that will call methods onRescoreRequest.Builder
to create a request.- Returns:
- Result of the Rescore operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 theRescore
API.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.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 theRescore
API.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 theRescore
API.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceUnavailableException, ThrottlingException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.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 theRescore
API.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateRescoreExecutionPlan
default UpdateRescoreExecutionPlanResponse updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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:
- Result of the UpdateRescoreExecutionPlan operation returned by the service.
- See Also:
-
updateRescoreExecutionPlan
default UpdateRescoreExecutionPlanResponse updateRescoreExecutionPlan(Consumer<UpdateRescoreExecutionPlanRequest.Builder> updateRescoreExecutionPlanRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ServiceQuotaExceededException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, KendraRankingException 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 viaUpdateRescoreExecutionPlanRequest.builder()
- Parameters:
updateRescoreExecutionPlanRequest
- AConsumer
that will call methods onUpdateRescoreExecutionPlanRequest.Builder
to create a request.- Returns:
- Result of the UpdateRescoreExecutionPlan operation returned by the service.
- See Also:
-
create
Create aKendraRankingClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aKendraRankingClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-