AWS.KendraRanking — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service's results.

Sending a Request Using KendraRanking

var kendraranking = new AWS.KendraRanking();
kendraranking.createRescoreExecutionPlan(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the KendraRanking object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kendraranking = new AWS.KendraRanking({apiVersion: '2022-10-19'});

You can also set the API version globally in AWS.config.apiVersions using the kendraranking service identifier:

AWS.config.apiVersions = {
  kendraranking: '2022-10-19',
  // other service API versions
};

var kendraranking = new AWS.KendraRanking();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.KendraRanking(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createRescoreExecutionPlan(params = {}, callback) ⇒ AWS.Request

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.

deleteRescoreExecutionPlan(params = {}, callback) ⇒ AWS.Request

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

describeRescoreExecutionPlan(params = {}, callback) ⇒ AWS.Request

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

listRescoreExecutionPlans(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

rescore(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

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.

updateRescoreExecutionPlan(params = {}, callback) ⇒ AWS.Request

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.