com.amazonaws.services.kendraranking

Class AbstractAmazonKendraRanking

java.lang.Object

com.amazonaws.services.kendraranking.AbstractAmazonKendraRanking

All Implemented Interfaces:

AmazonKendraRanking

Direct Known Subclasses:

AbstractAmazonKendraRankingAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonKendraRanking
extends Object
implements AmazonKendraRanking

Abstract implementation of AmazonKendraRanking. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonKendraRanking()

Method Summary

Modifier and Type	Method and Description
CreateRescoreExecutionPlanResult	createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest request) Creates a rescore execution plan.
DeleteRescoreExecutionPlanResult	deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest request) Deletes a rescore execution plan.
DescribeRescoreExecutionPlanResult	describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest request) 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 request) Lists your rescore execution plans.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Gets a list of tags associated with a specified resource.
RescoreResult	rescore(RescoreRequest request) 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 request) Adds a specified tag to a specified rescore execution plan.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from a rescore execution plan.
UpdateRescoreExecutionPlanResult	updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest request) Updates a rescore execution plan.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonKendraRanking

protected AbstractAmazonKendraRanking()

Method Detail

createRescoreExecutionPlan

public CreateRescoreExecutionPlanResult createRescoreExecutionPlan(CreateRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRanking

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.

Specified by:

createRescoreExecutionPlan in interface AmazonKendraRanking

Returns:

Result of the CreateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

deleteRescoreExecutionPlan

public DeleteRescoreExecutionPlanResult deleteRescoreExecutionPlan(DeleteRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRanking

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

Specified by:

deleteRescoreExecutionPlan in interface AmazonKendraRanking

Returns:

Result of the DeleteRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

describeRescoreExecutionPlan

public DescribeRescoreExecutionPlanResult describeRescoreExecutionPlan(DescribeRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRanking

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

Specified by:

describeRescoreExecutionPlan in interface AmazonKendraRanking

Returns:

Result of the DescribeRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

listRescoreExecutionPlans

public ListRescoreExecutionPlansResult listRescoreExecutionPlans(ListRescoreExecutionPlansRequest request)

Description copied from interface: AmazonKendraRanking

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

Specified by:

listRescoreExecutionPlans in interface AmazonKendraRanking

Returns:

Result of the ListRescoreExecutionPlans operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonKendraRanking

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.

Specified by:

listTagsForResource in interface AmazonKendraRanking

Parameters:

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.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

rescore

public RescoreResult rescore(RescoreRequest request)

Description copied from interface: AmazonKendraRanking

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.

Specified by:

rescore in interface AmazonKendraRanking

Returns:

Result of the Rescore operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonKendraRanking

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.

Specified by:

tagResource in interface AmazonKendraRanking

Parameters:

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.

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonKendraRanking

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.

Specified by:

untagResource in interface AmazonKendraRanking

Parameters:

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.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateRescoreExecutionPlan

public UpdateRescoreExecutionPlanResult updateRescoreExecutionPlan(UpdateRescoreExecutionPlanRequest request)

Description copied from interface: AmazonKendraRanking

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.

Specified by:

updateRescoreExecutionPlan in interface AmazonKendraRanking

Returns:

Result of the UpdateRescoreExecutionPlan operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonKendraRanking

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonKendraRanking

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonKendraRanking

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AmazonKendraRanking

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.