rerank async ¶

async def rerank(
    self,
    queries: "capo_bedrock_agent_runtime.types.rerank_queries_list.RerankQueriesList",
    sources: "capo_bedrock_agent_runtime.types.rerank_sources_list.RerankSourcesList",
    reranking_configuration: "capo_bedrock_agent_runtime.types.reranking_configuration.RerankingConfiguration",
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
    next_token: Optional[
        "capo_bedrock_agent_runtime.types.next_token.NextToken"
    ] = None,
) -> "capo_bedrock_agent_runtime.types.rerank_response.RerankResponse":
    """<p>Reranks the relevance of sources based on queries. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>.</p>

    Args:
        queries: <p>An array of objects, each of which contains information about a query to submit to the reranker model.</p>
        sources: <p>An array of objects, each of which contains information about the sources to rerank.</p>
        reranking_configuration: <p>Contains configurations for reranking.</p>
        next_token: <p>If the total number of results was greater than could fit in a response, a token is returned in the <code>nextToken</code> field. You can enter that token in this field to return the next batch of results.</p>

    Raises:
        capo_bedrock_agent_runtime.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
        capo_bedrock_agent_runtime.errors.bad_gateway_exception.BadGatewayException: <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
        capo_bedrock_agent_runtime.errors.dependency_failed_exception.DependencyFailedException: <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
        capo_bedrock_agent_runtime.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent_runtime.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent_runtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent_runtime.types.rerank_request.RerankRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent_runtime.types.rerank_response.RerankResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.rerank

        (
            output,
            http_response,
        ) = await capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.rerank.async_rerank(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agent_runtime.types.rerank_request.RerankRequest",
    ) -> dict[str, Any]:
        import capo_bedrock_agent_runtime.types.rerank_request

        return capo_bedrock_agent_runtime.types.rerank_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_bedrock_agent_runtime.types.rerank_response.RerankResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent_runtime.types.rerank_response

        return capo_bedrock_agent_runtime.types.rerank_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "Rerank", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_bedrock_agent_runtime.types.rerank_request.RerankRequest = {
        "queries": queries,
        "sources": sources,
        "reranking_configuration": reranking_configuration,
    }
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output