"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from .basesdk import BaseSDK from enum import Enum from openrouter import components, errors, operations, utils from openrouter._hooks import HookContext from openrouter.types import OptionalNullable, UNSET from openrouter.utils import get_security_from_env from openrouter.utils.unmarshal_json_response import unmarshal_json_response from typing import Any, List, Mapping, Optional, Union class RerankAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" TEXT_EVENT_STREAM = "text/event-stream" class Rerank(BaseSDK): r"""Rerank endpoints""" def rerank( self, *, documents: Union[List[operations.Document], List[operations.DocumentTypedDict]], model: str, query: str, http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, provider: OptionalNullable[ Union[ components.ProviderPreferences, components.ProviderPreferencesTypedDict ] ] = UNSET, top_n: Optional[int] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, accept_header_override: Optional[RerankAcceptEnum] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> operations.CreateRerankResponse: r"""Submit a rerank request Submits a rerank request to the rerank router :param documents: The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. :param model: The rerank model to use :param query: The search query to rerank documents against :param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application. :param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard. :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. :param provider: :param top_n: Number of most relevant documents to return :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param accept_header_override: Override the default accept header for this method :param http_headers: Additional headers to set or replace on requests. """ base_url = None url_variables = None if timeout_ms is None: timeout_ms = self.sdk_configuration.timeout_ms if server_url is not None: base_url = server_url else: base_url = self._get_url(base_url, url_variables) request = operations.CreateRerankRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, request_body=operations.CreateRerankRequestBody( documents=utils.get_pydantic_model( documents, List[operations.Document] ), model=model, provider=utils.get_pydantic_model( provider, OptionalNullable[components.ProviderPreferences] ), query=query, top_n=top_n, ), ) req = self._build_request( method="POST", path="/rerank", base_url=base_url, url_variables=url_variables, request=request, request_body_required=True, request_has_path_params=False, request_has_query_params=True, user_agent_header="user-agent", accept_header_value=accept_header_override.value if accept_header_override is not None else "application/json;q=1, text/event-stream;q=0", http_headers=http_headers, _globals=operations.CreateRerankGlobals( http_referer=self.sdk_configuration.globals.http_referer, x_open_router_title=self.sdk_configuration.globals.x_open_router_title, x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories, ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( request.request_body, False, False, "json", operations.CreateRerankRequestBody, ), allow_empty_value=None, timeout_ms=timeout_ms, ) if retries == UNSET: if self.sdk_configuration.retry_config is not UNSET: retries = self.sdk_configuration.retry_config else: retries = utils.RetryConfig( "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True ) retry_config = None if isinstance(retries, utils.RetryConfig): retry_config = (retries, ["5XX"]) http_res = self.do_request( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", operation_id="createRerank", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), ), request=req, error_status_codes=[ "400", "401", "402", "404", "429", "4XX", "500", "502", "503", "524", "529", "5XX", ], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response( operations.CreateRerankResponseBody, http_res ) if utils.match_response(http_res, "200", "text/event-stream"): return http_res.text if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( errors.BadRequestResponseErrorData, http_res ) raise errors.BadRequestResponseError(response_data, http_res) if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( errors.UnauthorizedResponseErrorData, http_res ) raise errors.UnauthorizedResponseError(response_data, http_res) if utils.match_response(http_res, "402", "application/json"): response_data = unmarshal_json_response( errors.PaymentRequiredResponseErrorData, http_res ) raise errors.PaymentRequiredResponseError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( errors.NotFoundResponseErrorData, http_res ) raise errors.NotFoundResponseError(response_data, http_res) if utils.match_response(http_res, "429", "application/json"): response_data = unmarshal_json_response( errors.TooManyRequestsResponseErrorData, http_res ) raise errors.TooManyRequestsResponseError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( errors.InternalServerResponseErrorData, http_res ) raise errors.InternalServerResponseError(response_data, http_res) if utils.match_response(http_res, "502", "application/json"): response_data = unmarshal_json_response( errors.BadGatewayResponseErrorData, http_res ) raise errors.BadGatewayResponseError(response_data, http_res) if utils.match_response(http_res, "503", "application/json"): response_data = unmarshal_json_response( errors.ServiceUnavailableResponseErrorData, http_res ) raise errors.ServiceUnavailableResponseError(response_data, http_res) if utils.match_response(http_res, "524", "application/json"): response_data = unmarshal_json_response( errors.EdgeNetworkTimeoutResponseErrorData, http_res ) raise errors.EdgeNetworkTimeoutResponseError(response_data, http_res) if utils.match_response(http_res, "529", "application/json"): response_data = unmarshal_json_response( errors.ProviderOverloadedResponseErrorData, http_res ) raise errors.ProviderOverloadedResponseError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise errors.OpenRouterDefaultError( "API error occurred", http_res, http_res_text ) if utils.match_response(http_res, "5XX", "*"): http_res_text = utils.stream_to_text(http_res) raise errors.OpenRouterDefaultError( "API error occurred", http_res, http_res_text ) raise errors.OpenRouterDefaultError("Unexpected response received", http_res) async def rerank_async( self, *, documents: Union[List[operations.Document], List[operations.DocumentTypedDict]], model: str, query: str, http_referer: Optional[str] = None, x_open_router_title: Optional[str] = None, x_open_router_categories: Optional[str] = None, provider: OptionalNullable[ Union[ components.ProviderPreferences, components.ProviderPreferencesTypedDict ] ] = UNSET, top_n: Optional[int] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, accept_header_override: Optional[RerankAcceptEnum] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> operations.CreateRerankResponse: r"""Submit a rerank request Submits a rerank request to the rerank router :param documents: The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. :param model: The rerank model to use :param query: The search query to rerank documents against :param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application. :param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard. :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings. :param provider: :param top_n: Number of most relevant documents to return :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param accept_header_override: Override the default accept header for this method :param http_headers: Additional headers to set or replace on requests. """ base_url = None url_variables = None if timeout_ms is None: timeout_ms = self.sdk_configuration.timeout_ms if server_url is not None: base_url = server_url else: base_url = self._get_url(base_url, url_variables) request = operations.CreateRerankRequest( http_referer=http_referer, x_open_router_title=x_open_router_title, x_open_router_categories=x_open_router_categories, request_body=operations.CreateRerankRequestBody( documents=utils.get_pydantic_model( documents, List[operations.Document] ), model=model, provider=utils.get_pydantic_model( provider, OptionalNullable[components.ProviderPreferences] ), query=query, top_n=top_n, ), ) req = self._build_request_async( method="POST", path="/rerank", base_url=base_url, url_variables=url_variables, request=request, request_body_required=True, request_has_path_params=False, request_has_query_params=True, user_agent_header="user-agent", accept_header_value=accept_header_override.value if accept_header_override is not None else "application/json;q=1, text/event-stream;q=0", http_headers=http_headers, _globals=operations.CreateRerankGlobals( http_referer=self.sdk_configuration.globals.http_referer, x_open_router_title=self.sdk_configuration.globals.x_open_router_title, x_open_router_categories=self.sdk_configuration.globals.x_open_router_categories, ), security=self.sdk_configuration.security, get_serialized_body=lambda: utils.serialize_request_body( request.request_body, False, False, "json", operations.CreateRerankRequestBody, ), allow_empty_value=None, timeout_ms=timeout_ms, ) if retries == UNSET: if self.sdk_configuration.retry_config is not UNSET: retries = self.sdk_configuration.retry_config else: retries = utils.RetryConfig( "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True ) retry_config = None if isinstance(retries, utils.RetryConfig): retry_config = (retries, ["5XX"]) http_res = await self.do_request_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", operation_id="createRerank", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, components.Security ), ), request=req, error_status_codes=[ "400", "401", "402", "404", "429", "4XX", "500", "502", "503", "524", "529", "5XX", ], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response( operations.CreateRerankResponseBody, http_res ) if utils.match_response(http_res, "200", "text/event-stream"): return http_res.text if utils.match_response(http_res, "400", "application/json"): response_data = unmarshal_json_response( errors.BadRequestResponseErrorData, http_res ) raise errors.BadRequestResponseError(response_data, http_res) if utils.match_response(http_res, "401", "application/json"): response_data = unmarshal_json_response( errors.UnauthorizedResponseErrorData, http_res ) raise errors.UnauthorizedResponseError(response_data, http_res) if utils.match_response(http_res, "402", "application/json"): response_data = unmarshal_json_response( errors.PaymentRequiredResponseErrorData, http_res ) raise errors.PaymentRequiredResponseError(response_data, http_res) if utils.match_response(http_res, "404", "application/json"): response_data = unmarshal_json_response( errors.NotFoundResponseErrorData, http_res ) raise errors.NotFoundResponseError(response_data, http_res) if utils.match_response(http_res, "429", "application/json"): response_data = unmarshal_json_response( errors.TooManyRequestsResponseErrorData, http_res ) raise errors.TooManyRequestsResponseError(response_data, http_res) if utils.match_response(http_res, "500", "application/json"): response_data = unmarshal_json_response( errors.InternalServerResponseErrorData, http_res ) raise errors.InternalServerResponseError(response_data, http_res) if utils.match_response(http_res, "502", "application/json"): response_data = unmarshal_json_response( errors.BadGatewayResponseErrorData, http_res ) raise errors.BadGatewayResponseError(response_data, http_res) if utils.match_response(http_res, "503", "application/json"): response_data = unmarshal_json_response( errors.ServiceUnavailableResponseErrorData, http_res ) raise errors.ServiceUnavailableResponseError(response_data, http_res) if utils.match_response(http_res, "524", "application/json"): response_data = unmarshal_json_response( errors.EdgeNetworkTimeoutResponseErrorData, http_res ) raise errors.EdgeNetworkTimeoutResponseError(response_data, http_res) if utils.match_response(http_res, "529", "application/json"): response_data = unmarshal_json_response( errors.ProviderOverloadedResponseErrorData, http_res ) raise errors.ProviderOverloadedResponseError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise errors.OpenRouterDefaultError( "API error occurred", http_res, http_res_text ) if utils.match_response(http_res, "5XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise errors.OpenRouterDefaultError( "API error occurred", http_res, http_res_text ) raise errors.OpenRouterDefaultError("Unexpected response received", http_res)