Serialized Form (AWS Java SDK for Amazon Kendra Intelligent Ranking 1.12.398 API)

Package com.amazonaws.services.kendraranking.model
- Class com.amazonaws.services.kendraranking.model.AccessDeniedException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.AmazonKendraRankingException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.CapacityUnitsConfiguration extends Object implements Serializable
  - Serialized Fields
    - rescoreCapacityUnits
```
Integer rescoreCapacityUnits
```
      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.
- Class com.amazonaws.services.kendraranking.model.ConflictException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.CreateRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A name for the rescore execution plan.
    - description
```
String description
```
      A description for the rescore execution plan.
    - capacityUnits
```
CapacityUnitsConfiguration capacityUnits
```
      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.
    - tags
```
List<E> tags
```
      A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    - clientToken
```
String clientToken
```
      A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore execution plan.
- Class com.amazonaws.services.kendraranking.model.CreateRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the rescore execution plan.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the rescore execution plan.
- Class com.amazonaws.services.kendraranking.model.DeleteRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the rescore execution plan that you want to delete.
- Class com.amazonaws.services.kendraranking.model.DeleteRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.kendraranking.model.DescribeRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the rescore execution plan that you want to get information on.
- Class com.amazonaws.services.kendraranking.model.DescribeRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the rescore execution plan.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the rescore execution plan.
    - name
```
String name
```
      The name for the rescore execution plan.
    - description
```
String description
```
      The description for the rescore execution plan.
    - capacityUnits
```
CapacityUnitsConfiguration capacityUnits
```
      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.
    - createdAt
```
Date createdAt
```
      The Unix timestamp of when the rescore execution plan was created.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp of when the rescore execution plan was last updated.
    - status
```
String status
```
      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.
    - errorMessage
```
String errorMessage
```
      When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
- Class com.amazonaws.services.kendraranking.model.Document extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the document from the search service.
    - groupId
```
String groupId
```
      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 title
```
      The title of the search service's document.
    - body
```
String body
```
      The body text of the search service's document.
    - tokenizedTitle
```
List<E> tokenizedTitle
```
      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
```
List<E> tokenizedBody
```
      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
```
Float originalScore
```
      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.
- Class com.amazonaws.services.kendraranking.model.InternalServerException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.ListRescoreExecutionPlansRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      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 maxResults
```
      The maximum number of rescore execution plans to return.
- Class com.amazonaws.services.kendraranking.model.ListRescoreExecutionPlansResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - summaryItems
```
List<E> summaryItems
```
      An array of summary information for one or more rescore execution plans.
    - nextToken
```
String nextToken
```
      If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.
- Class com.amazonaws.services.kendraranking.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for.
- Class com.amazonaws.services.kendraranking.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      A list of tags associated with the rescore execution plan.
- Class com.amazonaws.services.kendraranking.model.RescoreExecutionPlanSummary extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rescore execution plan.
    - id
```
String id
```
      The identifier of the rescore execution plan.
    - createdAt
```
Date createdAt
```
      The Unix timestamp when the rescore execution plan was created.
    - updatedAt
```
Date updatedAt
```
      The Unix timestamp when the rescore execution plan was last updated.
    - status
```
String status
```
      The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use.
- Class com.amazonaws.services.kendraranking.model.RescoreRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rescoreExecutionPlanId
```
String rescoreExecutionPlanId
```
      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 searchQuery
```
      The input query from the search service.
    - documents
```
List<E> documents
```
      The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
- Class com.amazonaws.services.kendraranking.model.RescoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - rescoreId
```
String rescoreId
```
      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
```
List<E> resultItems
```
      A list of result items for documents with new relevancy scores. The results are in descending order.
- Class com.amazonaws.services.kendraranking.model.RescoreResultItem extends Object implements Serializable
  - Serialized Fields
    - documentId
```
String documentId
```
      The identifier of the document from the search service.
    - score
```
Float score
```
      The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.
- Class com.amazonaws.services.kendraranking.model.ResourceNotFoundException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.ResourceUnavailableException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.ServiceQuotaExceededException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key for the tag. Keys are not case sensitive and must be unique.
    - value
```
String value
```
      The value associated with the tag. The value can be an empty string but it can't be null.
- Class com.amazonaws.services.kendraranking.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the rescore execution plan to tag.
    - tags
```
List<E> tags
```
      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.
- Class com.amazonaws.services.kendraranking.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.kendraranking.model.ThrottlingException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.kendraranking.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag.
    - tagKeys
```
List<E> tagKeys
```
      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.
- Class com.amazonaws.services.kendraranking.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.kendraranking.model.UpdateRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the rescore execution plan that you want to update.
    - name
```
String name
```
      A new name for the rescore execution plan.
    - description
```
String description
```
      A new description for the rescore execution plan.
    - capacityUnits
```
CapacityUnitsConfiguration capacityUnits
```
      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.
- Class com.amazonaws.services.kendraranking.model.UpdateRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.kendraranking.model.ValidationException extends AmazonKendraRankingException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.amazonaws.services.kendraranking.model

Class com.amazonaws.services.kendraranking.model.AccessDeniedException extends AmazonKendraRankingException implements Serializable

Class com.amazonaws.services.kendraranking.model.AmazonKendraRankingException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.kendraranking.model.CapacityUnitsConfiguration extends Object implements Serializable

Serialized Fields

rescoreCapacityUnits

Class com.amazonaws.services.kendraranking.model.ConflictException extends AmazonKendraRankingException implements Serializable

Class com.amazonaws.services.kendraranking.model.CreateRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

description

capacityUnits

tags

clientToken

Class com.amazonaws.services.kendraranking.model.CreateRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

id

arn

Class com.amazonaws.services.kendraranking.model.DeleteRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

Class com.amazonaws.services.kendraranking.model.DeleteRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.kendraranking.model.DescribeRescoreExecutionPlanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

Class com.amazonaws.services.kendraranking.model.DescribeRescoreExecutionPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

id

arn

name

description

capacityUnits

createdAt

updatedAt

status

errorMessage

Class com.amazonaws.services.kendraranking.model.Document extends Object implements Serializable

Serialized Fields

id

groupId

title

body

tokenizedTitle

tokenizedBody

originalScore

Class com.amazonaws.services.kendraranking.model.InternalServerException extends AmazonKendraRankingException implements Serializable

Class com.amazonaws.services.kendraranking.model.ListRescoreExecutionPlansRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

maxResults

Class com.amazonaws.services.kendraranking.model.ListRescoreExecutionPlansResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

summaryItems

nextToken

Class com.amazonaws.services.kendraranking.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceARN

Class com.amazonaws.services.kendraranking.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

tags

Class com.amazonaws.services.kendraranking.model.RescoreExecutionPlanSummary extends Object implements Serializable

Serialized Fields

name

id

createdAt

updatedAt

status

Class com.amazonaws.services.kendraranking.model.RescoreRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

rescoreExecutionPlanId

searchQuery

documents

Class com.amazonaws.services.kendraranking.model.RescoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

rescoreId

resultItems

Class com.amazonaws.services.kendraranking.model.RescoreResultItem extends Object implements Serializable

Serialized Fields

documentId