rescore ¶

def rescore(
    self,
    rescore_execution_plan_id: "capo_kendra_ranking.types.rescore_execution_plan_id.RescoreExecutionPlanId",
    search_query: "capo_kendra_ranking.types.search_query.SearchQuery",
    documents: "capo_kendra_ranking.types.document_list.DocumentList",
    *,
    config_overrides: Optional[KendraRankingClientConfig] = None,
) -> "capo_kendra_ranking.types.rescore_result.RescoreResult":
    """<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>

    Args:
        rescore_execution_plan_id: <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>
        search_query: <p>The input query from the search service.</p>
        documents: <p>The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.</p>

    Raises:
        capo_kendra_ranking.errors.access_denied_exception.AccessDeniedException: <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>
        capo_kendra_ranking.errors.conflict_exception.ConflictException: <p>A conflict occurred with the request. Please fix any inconsistencies with your resources and try again.</p>
        capo_kendra_ranking.errors.internal_server_exception.InternalServerException: <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>
        capo_kendra_ranking.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn't exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra_ranking.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra_ranking.errors.validation_exception.ValidationException: <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>
        capo_kendra_ranking.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra_ranking.types.rescore_request.RescoreRequest]",
    ) -> OperationResponse[
        "capo_kendra_ranking.types.rescore_result.RescoreResult"
    ]:
        import capo_kendra_ranking._operations.aws_kendra_reranking_frontend_service.rescore

        output, http_response = (
            capo_kendra_ranking._operations.aws_kendra_reranking_frontend_service.rescore.rescore(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("Rescore")
    )
    input_: capo_kendra_ranking.types.rescore_request.RescoreRequest = {
        "rescore_execution_plan_id": rescore_execution_plan_id,
        "search_query": search_query,
        "documents": documents,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output