<?php
// This file was auto-generated from sdk-root/src/data/kendra-ranking/2022-10-19/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>Amazon Kendra Intelligent Ranking uses Amazon Kendra semantic search capabilities to intelligently re-rank a search service\'s results.</p>', 'operations' => [ 'CreateRescoreExecutionPlan' => '<p>Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> 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.</p> <p>For an example of using the <code>CreateRescoreExecutionPlan</code> API, including using the Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html">Semantically ranking a search service\'s results</a>.</p>', 'DeleteRescoreExecutionPlan' => '<p>Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>', 'DescribeRescoreExecutionPlan' => '<p>Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>', 'ListRescoreExecutionPlans' => '<p>Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>', 'ListTagsForResource' => '<p>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.</p>', 'Rescore' => '<p>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.</p>', 'TagResource' => '<p>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 <code>Rescore</code> API. If the tag already exists, the existing value is replaced with the new value.</p>', 'UntagResource' => '<p>Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> operation.</p>', 'UpdateRescoreExecutionPlan' => '<p>Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> 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.</p>', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '<p>You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>', 'refs' => [], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$ResourceARN' => '<p>The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for.</p>', 'TagResourceRequest$ResourceARN' => '<p>The Amazon Resource Name (ARN) of the rescore execution plan to tag.</p>', 'UntagResourceRequest$ResourceARN' => '<p>The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag.</p>', ], ], 'BodyTokensList' => [ 'base' => NULL, 'refs' => [ 'Document$TokenizedBody' => '<p>The body text of the search service\'s document represented as a list of tokens or words. You must choose to provide <code>Body</code> or <code>TokenizedBody</code>. You cannot provide both.</p>', ], ], 'CapacityUnitsConfiguration' => [ 'base' => '<p>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 <code>Rescore</code> API. You can add and remove capacity units to fit your usage requirements.</p>', 'refs' => [ 'CreateRescoreExecutionPlanRequest$CapacityUnits' => '<p>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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>.</p>', 'DescribeRescoreExecutionPlanResponse$CapacityUnits' => '<p>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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>.</p>', 'UpdateRescoreExecutionPlanRequest$CapacityUnits' => '<p>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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>.</p>', ], ], 'ClientTokenName' => [ 'base' => NULL, 'refs' => [ 'CreateRescoreExecutionPlanRequest$ClientToken' => '<p>A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the <code>CreateRescoreExecutionPlanRequest</code> API with the same client token will create only one rescore execution plan.</p>', ], ], 'ConflictException' => [ 'base' => '<p>A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.</p>', 'refs' => [], ], 'CreateRescoreExecutionPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRescoreExecutionPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRescoreExecutionPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRescoreExecutionPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRescoreExecutionPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'CreateRescoreExecutionPlanRequest$Description' => '<p>A description for the rescore execution plan.</p>', 'DescribeRescoreExecutionPlanResponse$Description' => '<p>The description for the rescore execution plan.</p>', 'UpdateRescoreExecutionPlanRequest$Description' => '<p>A new description for the rescore execution plan.</p>', ], ], 'Document' => [ 'base' => '<p>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.</p>', 'refs' => [ 'DocumentList$member' => NULL, ], ], 'DocumentBody' => [ 'base' => NULL, 'refs' => [ 'Document$Body' => '<p>The body text of the search service\'s document.</p>', ], ], 'DocumentId' => [ 'base' => NULL, 'refs' => [ 'Document$Id' => '<p>The identifier of the document from the search service.</p>', 'RescoreResultItem$DocumentId' => '<p>The identifier of the document from the search service.</p>', ], ], 'DocumentList' => [ 'base' => NULL, 'refs' => [ 'RescoreRequest$Documents' => '<p>The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.</p>', ], ], 'DocumentTitle' => [ 'base' => NULL, 'refs' => [ 'Document$Title' => '<p>The title of the search service\'s document.</p>', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'DescribeRescoreExecutionPlanResponse$ErrorMessage' => '<p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>', 'InternalServerException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ResourceUnavailableException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'ValidationException$Message' => NULL, ], ], 'Float' => [ 'base' => NULL, 'refs' => [ 'Document$OriginalScore' => '<p>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.</p>', 'RescoreResultItem$Score' => '<p>The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.</p>', ], ], 'GroupId' => [ 'base' => NULL, 'refs' => [ 'Document$GroupId' => '<p>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.</p>', ], ], 'InternalServerException' => [ 'base' => '<p>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 <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>', 'refs' => [], ], 'ListRescoreExecutionPlansRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRescoreExecutionPlansResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => '<p>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 <code>Rescore</code> API.</p>', 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response.</p>', 'refs' => [], ], 'MaxResultsIntegerForListRescoreExecutionPlansRequest' => [ 'base' => NULL, 'refs' => [ 'ListRescoreExecutionPlansRequest$MaxResults' => '<p>The maximum number of rescore execution plans to return.</p>', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListRescoreExecutionPlansRequest$NextToken' => '<p>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.</p>', 'ListRescoreExecutionPlansResponse$NextToken' => '<p>If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.</p>', ], ], 'RescoreCapacityUnit' => [ 'base' => NULL, 'refs' => [ 'CapacityUnitsConfiguration$RescoreCapacityUnits' => '<p>The amount of extra capacity for your rescore execution plan.</p> <p>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.</p>', ], ], 'RescoreExecutionPlanArn' => [ 'base' => NULL, 'refs' => [ 'CreateRescoreExecutionPlanResponse$Arn' => '<p>The Amazon Resource Name (ARN) of the rescore execution plan.</p>', 'DescribeRescoreExecutionPlanResponse$Arn' => '<p>The Amazon Resource Name (ARN) of the rescore execution plan.</p>', ], ], 'RescoreExecutionPlanId' => [ 'base' => NULL, 'refs' => [ 'CreateRescoreExecutionPlanResponse$Id' => '<p>The identifier of the rescore execution plan.</p>', 'DeleteRescoreExecutionPlanRequest$Id' => '<p>The identifier of the rescore execution plan that you want to delete.</p>', 'DescribeRescoreExecutionPlanRequest$Id' => '<p>The identifier of the rescore execution plan that you want to get information on.</p>', 'DescribeRescoreExecutionPlanResponse$Id' => '<p>The identifier of the rescore execution plan.</p>', 'RescoreExecutionPlanSummary$Id' => '<p>The identifier of the rescore execution plan.</p>', 'RescoreRequest$RescoreExecutionPlanId' => '<p>The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>', 'UpdateRescoreExecutionPlanRequest$Id' => '<p>The identifier of the rescore execution plan that you want to update.</p>', ], ], 'RescoreExecutionPlanName' => [ 'base' => NULL, 'refs' => [ 'CreateRescoreExecutionPlanRequest$Name' => '<p>A name for the rescore execution plan.</p>', 'DescribeRescoreExecutionPlanResponse$Name' => '<p>The name for the rescore execution plan.</p>', 'RescoreExecutionPlanSummary$Name' => '<p>The name of the rescore execution plan.</p>', 'UpdateRescoreExecutionPlanRequest$Name' => '<p>A new name for the rescore execution plan.</p>', ], ], 'RescoreExecutionPlanStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeRescoreExecutionPlanResponse$Status' => '<p>The current status of the rescore execution plan. When the value is <code>ACTIVE</code>, the rescore execution plan is ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.</p>', 'RescoreExecutionPlanSummary$Status' => '<p>The current status of the rescore execution plan. When the value is <code>ACTIVE</code>, the rescore execution plan is ready for use.</p>', ], ], 'RescoreExecutionPlanSummary' => [ 'base' => '<p>Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>', 'refs' => [ 'RescoreExecutionPlanSummaryList$member' => NULL, ], ], 'RescoreExecutionPlanSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListRescoreExecutionPlansResponse$SummaryItems' => '<p>An array of summary information for one or more rescore execution plans.</p>', ], ], 'RescoreId' => [ 'base' => NULL, 'refs' => [ 'RescoreResult$RescoreId' => '<p>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.</p>', ], ], 'RescoreRequest' => [ 'base' => NULL, 'refs' => [], ], 'RescoreResult' => [ 'base' => NULL, 'refs' => [], ], 'RescoreResultItem' => [ 'base' => '<p>A result item for a document with a new relevancy score.</p>', 'refs' => [ 'RescoreResultItemList$member' => NULL, ], ], 'RescoreResultItemList' => [ 'base' => NULL, 'refs' => [ 'RescoreResult$ResultItems' => '<p>A list of result items for documents with new relevancy scores. The results are in descending order.</p>', ], ], 'ResourceNotFoundException' => [ 'base' => '<p>The resource you want to use doesn\'t exist. Please check you have provided the correct resource and try again.</p>', 'refs' => [], ], 'ResourceUnavailableException' => [ 'base' => '<p>The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.</p>', 'refs' => [], ], 'SearchQuery' => [ 'base' => NULL, 'refs' => [ 'RescoreRequest$SearchQuery' => '<p>The input query from the search service.</p>', ], ], 'ServiceQuotaExceededException' => [ 'base' => '<p>You have exceeded the set limits for your Amazon Kendra Intelligent Ranking service. Please see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about an increase of limits.</p>', 'refs' => [], ], 'Tag' => [ 'base' => '<p>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 <code>Rescore</code> 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: _ . : / = + - @.</p>', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '<p>The key for the tag. Keys are not case sensitive and must be unique.</p>', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '<p>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.</p>', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateRescoreExecutionPlanRequest$Tags' => '<p>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: _ . : / = + - @.</p>', 'ListTagsForResourceResponse$Tags' => '<p>A list of tags associated with the rescore execution plan.</p>', 'TagResourceRequest$Tags' => '<p>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.</p>', ], ], 'TagResourceRequest' => [ 'base' => '<p>The request information for tagging a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>', 'refs' => [], ], 'TagResourceResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '<p>The value associated with the tag. The value can be an empty string but it can\'t be null.</p>', ], ], 'ThrottlingException' => [ 'base' => '<p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DescribeRescoreExecutionPlanResponse$CreatedAt' => '<p>The Unix timestamp of when the rescore execution plan was created.</p>', 'DescribeRescoreExecutionPlanResponse$UpdatedAt' => '<p>The Unix timestamp of when the rescore execution plan was last updated.</p>', 'RescoreExecutionPlanSummary$CreatedAt' => '<p>The Unix timestamp when the rescore execution plan was created.</p>', 'RescoreExecutionPlanSummary$UpdatedAt' => '<p>The Unix timestamp when the rescore execution plan was last updated.</p>', ], ], 'TitleTokensList' => [ 'base' => NULL, 'refs' => [ 'Document$TokenizedTitle' => '<p>The title of the search service\'s document represented as a list of tokens or words. You must choose to provide <code>Title</code> or <code>TokenizedTitle</code>. You cannot provide both.</p>', ], ], 'Tokens' => [ 'base' => NULL, 'refs' => [ 'BodyTokensList$member' => NULL, 'TitleTokensList$member' => NULL, ], ], 'UntagResourceRequest' => [ 'base' => '<p>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 <code>Rescore</code> API.</p>', 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => '<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>', 'refs' => [], ], 'UpdateRescoreExecutionPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '<p>The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.</p>', 'refs' => [], ], ],];
