Module Smaws_Client_KendraRanking.Types

type nonrec error_message = string
type nonrec validation_exception = {
  1. message : error_message option;
}

The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.

type nonrec rescore_execution_plan_id = string
type nonrec rescore_execution_plan_name = string
type nonrec description = string
type nonrec rescore_capacity_unit = int
type nonrec capacity_units_configuration = {
  1. rescore_capacity_units : rescore_capacity_unit;
    (*

    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.

    *)
}

Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can add and remove capacity units to fit your usage requirements.

type nonrec update_rescore_execution_plan_request = {
  1. capacity_units : capacity_units_configuration option;
    (*

    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.

    *)
  2. description : description option;
    (*

    A new description for the rescore execution plan.

    *)
  3. name : rescore_execution_plan_name option;
    (*

    A new name for the rescore execution plan.

    *)
  4. id : rescore_execution_plan_id;
    (*

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

    *)
}
type nonrec throttling_exception = {
  1. message : error_message option;
}

The request was denied due to request throttling. Please reduce the number of requests and try again.

type nonrec service_quota_exceeded_exception = {
  1. message : error_message option;
}

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.

type nonrec resource_not_found_exception = {
  1. message : error_message option;
}

The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.

type nonrec internal_server_exception = {
  1. message : error_message option;
}

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.

type nonrec conflict_exception = {
  1. message : error_message option;
}

A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.

type nonrec access_denied_exception = {
  1. message : error_message option;
}

You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

type nonrec untag_resource_response = unit
type nonrec amazon_resource_name = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    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.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

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

    *)
}

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.

type nonrec resource_unavailable_exception = {
  1. message : error_message option;
}

The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.

type nonrec tokens = string
type nonrec title_tokens_list = tokens list
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value;
    (*

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

    *)
  2. key : tag_key;
    (*

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

    *)
}

A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    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.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

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

    *)
}

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.

type nonrec search_query = string
type nonrec document_id = string
type nonrec float_ = float
type nonrec rescore_result_item = {
  1. score : float_ option;
    (*

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

    *)
  2. document_id : document_id option;
    (*

    The identifier of the document from the search service.

    *)
}

A result item for a document with a new relevancy score.

type nonrec rescore_result_item_list = rescore_result_item list
type nonrec rescore_id = string
type nonrec rescore_result = {
  1. result_items : rescore_result_item_list option;
    (*

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

    *)
  2. rescore_id : rescore_id option;
    (*

    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.

    *)
}
type nonrec group_id = string
type nonrec document_title = string
type nonrec document_body = string
type nonrec body_tokens_list = tokens list
type nonrec document = {
  1. original_score : 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.

    *)
  2. tokenized_body : body_tokens_list option;
    (*

    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.

    *)
  3. tokenized_title : title_tokens_list option;
    (*

    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.

    *)
  4. body : document_body option;
    (*

    The body text of the search service's document.

    *)
  5. title : document_title option;
    (*

    The title of the search service's document.

    *)
  6. group_id : group_id option;
    (*

    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.

    *)
  7. id : document_id;
    (*

    The identifier of the document from the search service.

    *)
}

Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.

type nonrec document_list = document list
type nonrec rescore_request = {
  1. documents : document_list;
    (*

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

    *)
  2. search_query : search_query;
    (*

    The input query from the search service.

    *)
  3. rescore_execution_plan_id : rescore_execution_plan_id;
    (*

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

    *)
}
type nonrec rescore_execution_plan_status =
  1. | FAILED
  2. | DELETING
  3. | ACTIVE
  4. | UPDATING
  5. | CREATING
type nonrec rescore_execution_plan_summary = {
  1. status : rescore_execution_plan_status option;
    (*

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

    *)
  2. updated_at : timestamp option;
    (*

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

    *)
  3. created_at : timestamp option;
    (*

    The Unix timestamp when the rescore execution plan was created.

    *)
  4. id : rescore_execution_plan_id option;
    (*

    The identifier of the rescore execution plan.

    *)
  5. name : rescore_execution_plan_name option;
    (*

    The name of the rescore execution plan.

    *)
}

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

type nonrec rescore_execution_plan_summary_list = rescore_execution_plan_summary list
type nonrec rescore_execution_plan_arn = string
type nonrec next_token = string
type nonrec max_results_integer_for_list_rescore_execution_plans_request = int
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

    A list of tags associated with the rescore execution plan.

    *)
}

If the action is successful, the service sends back an HTTP 200 response.

type nonrec list_tags_for_resource_request = {
  1. resource_ar_n : amazon_resource_name;
    (*

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

    *)
}

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.

type nonrec list_rescore_execution_plans_response = {
  1. next_token : next_token option;
    (*

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

    *)
  2. summary_items : rescore_execution_plan_summary_list option;
    (*

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

    *)
}
type nonrec list_rescore_execution_plans_request = {
  1. max_results : max_results_integer_for_list_rescore_execution_plans_request option;
    (*

    The maximum number of rescore execution plans to return.

    *)
  2. next_token : next_token option;
    (*

    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.

    *)
}
type nonrec describe_rescore_execution_plan_response = {
  1. error_message : error_message option;
    (*

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

    *)
  2. status : rescore_execution_plan_status option;
    (*

    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.

    *)
  3. updated_at : timestamp option;
    (*

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

    *)
  4. created_at : timestamp option;
    (*

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

    *)
  5. capacity_units : capacity_units_configuration option;
    (*

    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.

    *)
  6. description : description option;
    (*

    The description for the rescore execution plan.

    *)
  7. name : rescore_execution_plan_name option;
    (*

    The name for the rescore execution plan.

    *)
  8. arn : rescore_execution_plan_arn option;
    (*

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

    *)
  9. id : rescore_execution_plan_id option;
    (*

    The identifier of the rescore execution plan.

    *)
}
type nonrec describe_rescore_execution_plan_request = {
  1. id : rescore_execution_plan_id;
    (*

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

    *)
}
type nonrec delete_rescore_execution_plan_request = {
  1. id : rescore_execution_plan_id;
    (*

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

    *)
}
type nonrec create_rescore_execution_plan_response = {
  1. arn : rescore_execution_plan_arn;
    (*

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

    *)
  2. id : rescore_execution_plan_id;
    (*

    The identifier of the rescore execution plan.

    *)
}
type nonrec client_token_name = string
type nonrec create_rescore_execution_plan_request = {
  1. client_token : client_token_name option;
    (*

    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.

    *)
  2. tags : tag_list option;
    (*

    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: _ . : / = + - @.

    *)
  3. capacity_units : capacity_units_configuration option;
    (*

    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.

    *)
  4. description : description option;
    (*

    A description for the rescore execution plan.

    *)
  5. name : rescore_execution_plan_name;
    (*

    A name for the rescore execution plan.

    *)
}