@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKendraRanking
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonKendraRanking
instead.
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 |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateRescoreExecutionPlanResult |
createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest createRescoreExecutionPlanRequest)
Creates a rescore execution plan.
|
DeleteRescoreExecutionPlanResult |
deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest deleteRescoreExecutionPlanRequest)
Deletes a rescore execution plan.
|
DescribeRescoreExecutionPlanResult |
describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest describeRescoreExecutionPlanRequest)
Gets information about a rescore execution plan.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListRescoreExecutionPlansResult |
listRescoreExecutionPlans(ListRescoreExecutionPlansRequest listRescoreExecutionPlansRequest)
Lists your rescore execution plans.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
RescoreResult |
rescore(RescoreRequest rescoreRequest)
Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds a specified tag to a specified rescore execution plan.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a rescore execution plan.
|
UpdateRescoreExecutionPlanResult |
updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest updateRescoreExecutionPlanRequest)
Updates a rescore execution plan.
|
static final String ENDPOINT_PREFIX
CreateRescoreExecutionPlanResult 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
- AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ConflictException
- A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.DeleteRescoreExecutionPlanResult 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
- AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ConflictException
- A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.ResourceNotFoundException
- The resource you want to use doesn't exist. Please check you have provided the correct resource and try
again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.DescribeRescoreExecutionPlanResult 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
- ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ResourceNotFoundException
- The resource you want to use doesn't exist. Please check you have provided the correct resource and try
again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.ListRescoreExecutionPlansResult 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
- ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.ListTagsForResourceResult 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.ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ResourceUnavailableException
- The resource you want to use is unavailable. Please check you have provided the correct resource
information and try again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.RescoreResult 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
- ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ConflictException
- A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ResourceNotFoundException
- The resource you want to use doesn't exist. Please check you have provided the correct resource and try
again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.TagResourceResult 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.ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ResourceUnavailableException
- The resource you want to use is unavailable. Please check you have provided the correct resource
information and try again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.UntagResourceResult 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.ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ResourceUnavailableException
- The resource you want to use is unavailable. Please check you have provided the correct resource
information and try again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.UpdateRescoreExecutionPlanResult 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
- ValidationException
- The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please
provide the correct input and try again.ResourceNotFoundException
- The resource you want to use doesn't exist. Please check you have provided the correct resource and try
again.ThrottlingException
- The request was denied due to request throttling. Please reduce the number of requests and try again.AccessDeniedException
- You don’t have sufficient access to perform this action. Please ensure you have the required permission
policies and user accounts and try again.ServiceQuotaExceededException
- You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see Quotas for more information, or
contact Support to inquire about an increase of limits.ConflictException
- A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.InternalServerException
- An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service.
Please wait a few minutes and try again, or contact Support for help.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.