Class: AWS.KendraRanking

var params = {
  Id: 'STRING_VALUE' /* required */
};
kendraranking.deleteRescoreExecutionPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Id — (String)

    The identifier of the rescore execution plan that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Id: 'STRING_VALUE' /* required */
};
kendraranking.describeRescoreExecutionPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Id — (String)

    The identifier of the rescore execution plan that you want to get information on.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Id — (String)

      The identifier of the rescore execution plan.

    • Arn — (String)

      The Amazon Resource Name (ARN) of the rescore execution plan.

    • Name — (String)

      The name for the rescore execution plan.

    • Description — (String)

      The description for the rescore execution plan.

    • CapacityUnits — (map)

      The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.

      • RescoreCapacityUnits — required — (Integer)

        The amount of extra capacity for your rescore execution plan.

        A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.

    • CreatedAt — (Date)

      The Unix timestamp of when the rescore execution plan was created.

    • UpdatedAt — (Date)

      The Unix timestamp of when the rescore execution plan was last updated.

    • Status — (String)

      The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"
    • ErrorMessage — (String)

      When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kendraranking.listRescoreExecutionPlans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.

  • MaxResults — (Integer)

    The maximum number of rescore execution plans to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SummaryItems — (Array<map>)

      An array of summary information for one or more rescore execution plans.

      • Name — (String)

        The name of the rescore execution plan.

      • Id — (String)

        The identifier of the rescore execution plan.

      • CreatedAt — (Date)

        The Unix timestamp when the rescore execution plan was created.

      • UpdatedAt — (Date)

        The Unix timestamp when the rescore execution plan was last updated.

      • Status — (String)

        The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
    • NextToken — (String)

      If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
kendraranking.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      A list of tags associated with the rescore execution plan.

      • Key — required — (String)

        The key for the tag. Keys are not case sensitive and must be unique.

      • Value — required — (String)

        The value associated with the tag. The value can be an empty string but it can't be null.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Documents: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      OriginalScore: 'NUMBER_VALUE', /* required */
      Body: 'STRING_VALUE',
      GroupId: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      TokenizedBody: [
        'STRING_VALUE',
        /* more items */
      ],
      TokenizedTitle: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  RescoreExecutionPlanId: 'STRING_VALUE', /* required */
  SearchQuery: 'STRING_VALUE' /* required */
};
kendraranking.rescore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RescoreExecutionPlanId — (String)

    The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

  • SearchQuery — (String)

    The input query from the search service.

  • Documents — (Array<map>)

    The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

    • Id — required — (String)

      The identifier of the document from the search service.

    • GroupId — (String)

      The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.

    • Title — (String)

      The title of the search service's document.

    • Body — (String)

      The body text of the search service's document.

    • TokenizedTitle — (Array<String>)

      The title of the search service's document represented as a list of tokens or words. You must choose to provide Title or TokenizedTitle. You cannot provide both.

    • TokenizedBody — (Array<String>)

      The body text of the search service's document represented as a list of tokens or words. You must choose to provide Body or TokenizedBody. You cannot provide both.

    • OriginalScore — required — (Float)

      The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RescoreId — (String)

      The identifier associated with the scores that Amazon Kendra Intelligent Ranking gives to the results. Amazon Kendra Intelligent Ranking rescores or re-ranks the results for the search service.

    • ResultItems — (Array<map>)

      A list of result items for documents with new relevancy scores. The results are in descending order.

      • DocumentId — (String)

        The identifier of the document from the search service.

      • Score — (Float)

        The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kendraranking.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the rescore execution plan to tag.

  • Tags — (Array<map>)

    A list of tag keys to add to a rescore execution plan. If a tag already exists, the existing value is replaced with the new value.

    • Key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique.

    • Value — required — (String)

      The value associated with the tag. The value can be an empty string but it can't be null.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kendraranking.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

    The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag.

  • TagKeys — (Array<String>)

    A list of tag keys to remove from the rescore execution plan. If a tag key does not exist on the resource, it is ignored.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Id: 'STRING_VALUE', /* required */
  CapacityUnits: {
    RescoreCapacityUnits: 'NUMBER_VALUE' /* required */
  },
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
kendraranking.updateRescoreExecutionPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Id — (String)

    The identifier of the rescore execution plan that you want to update.

  • Name — (String)

    A new name for the rescore execution plan.

  • Description — (String)

    A new description for the rescore execution plan.

  • CapacityUnits — (map)

    You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.

    • RescoreCapacityUnits — required — (Integer)

      The amount of extra capacity for your rescore execution plan.

      A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.