orq-ai-sdk 4.2.0rc49__py3-none-any.whl → 4.2.12__py3-none-any.whl

orq_ai_sdk/rerank.py

@@ -0,0 +1,330 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from orq_ai_sdk import models, utils
+from orq_ai_sdk._hooks import HookContext
+from orq_ai_sdk.models import creatererankop as models_creatererankop
+from orq_ai_sdk.types import OptionalNullable, UNSET
+from orq_ai_sdk.utils import get_security_from_env
+from orq_ai_sdk.utils.unmarshal_json_response import unmarshal_json_response
+from typing import List, Mapping, Optional, Union
+
+
+class Rerank(BaseSDK):
+    def create(
+        self,
+        *,
+        query: str,
+        documents: List[str],
+        model: str,
+        top_n: Optional[float] = None,
+        filename: OptionalNullable[str] = UNSET,
+        name: Optional[str] = None,
+        fallbacks: Optional[
+            Union[
+                List[models_creatererankop.CreateRerankFallbacks],
+                List[models_creatererankop.CreateRerankFallbacksTypedDict],
+            ]
+        ] = None,
+        retry: Optional[
+            Union[
+                models_creatererankop.CreateRerankRetry,
+                models_creatererankop.CreateRerankRetryTypedDict,
+            ]
+        ] = None,
+        cache: Optional[
+            Union[
+                models_creatererankop.CreateRerankCache,
+                models_creatererankop.CreateRerankCacheTypedDict,
+            ]
+        ] = None,
+        load_balancer: Optional[
+            Union[
+                models_creatererankop.CreateRerankLoadBalancer,
+                models_creatererankop.CreateRerankLoadBalancerTypedDict,
+            ]
+        ] = None,
+        timeout: Optional[
+            Union[
+                models_creatererankop.CreateRerankTimeout,
+                models_creatererankop.CreateRerankTimeoutTypedDict,
+            ]
+        ] = None,
+        orq: Optional[
+            Union[
+                models_creatererankop.CreateRerankOrq,
+                models_creatererankop.CreateRerankOrqTypedDict,
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateRerankResponseBody:
+        r"""Create rerank
+
+        Rerank a list of documents based on their relevance to a query.
+
+        :param query: The search query
+        :param documents: A list of texts that will be compared to the `query`. For optimal performance we recommend against sending more than 1,000 documents in a single request.
+        :param model: The identifier of the model to use
+        :param top_n: The number of most relevant documents or indices to return, defaults to the length of the documents
+        :param filename: The filename of the document to rerank
+        :param name: The name to display on the trace. If not specified, the default system name will be used.
+        :param fallbacks: Array of fallback models to use if primary model fails
+        :param retry: Retry configuration for the request
+        :param cache: Cache configuration for the request.
+        :param load_balancer: Load balancer configuration for the request.
+        :param timeout: Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
+        :param orq:
+        :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 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 timeout_ms is None:
+            timeout_ms = 600000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreateRerankRequestBody(
+            query=query,
+            documents=documents,
+            model=model,
+            top_n=top_n,
+            filename=filename,
+            name=name,
+            fallbacks=utils.get_pydantic_model(
+                fallbacks, Optional[List[models.CreateRerankFallbacks]]
+            ),
+            retry=utils.get_pydantic_model(retry, Optional[models.CreateRerankRetry]),
+            cache=utils.get_pydantic_model(cache, Optional[models.CreateRerankCache]),
+            load_balancer=utils.get_pydantic_model(
+                load_balancer, Optional[models.CreateRerankLoadBalancer]
+            ),
+            timeout=utils.get_pydantic_model(
+                timeout, Optional[models.CreateRerankTimeout]
+            ),
+            orq=utils.get_pydantic_model(orq, Optional[models.CreateRerankOrq]),
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/v2/router/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="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.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
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        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, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.CreateRerankResponseBody, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise models.APIError("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 models.APIError("API error occurred", http_res, http_res_text)
+
+        raise models.APIError("Unexpected response received", http_res)
+
+    async def create_async(
+        self,
+        *,
+        query: str,
+        documents: List[str],
+        model: str,
+        top_n: Optional[float] = None,
+        filename: OptionalNullable[str] = UNSET,
+        name: Optional[str] = None,
+        fallbacks: Optional[
+            Union[
+                List[models_creatererankop.CreateRerankFallbacks],
+                List[models_creatererankop.CreateRerankFallbacksTypedDict],
+            ]
+        ] = None,
+        retry: Optional[
+            Union[
+                models_creatererankop.CreateRerankRetry,
+                models_creatererankop.CreateRerankRetryTypedDict,
+            ]
+        ] = None,
+        cache: Optional[
+            Union[
+                models_creatererankop.CreateRerankCache,
+                models_creatererankop.CreateRerankCacheTypedDict,
+            ]
+        ] = None,
+        load_balancer: Optional[
+            Union[
+                models_creatererankop.CreateRerankLoadBalancer,
+                models_creatererankop.CreateRerankLoadBalancerTypedDict,
+            ]
+        ] = None,
+        timeout: Optional[
+            Union[
+                models_creatererankop.CreateRerankTimeout,
+                models_creatererankop.CreateRerankTimeoutTypedDict,
+            ]
+        ] = None,
+        orq: Optional[
+            Union[
+                models_creatererankop.CreateRerankOrq,
+                models_creatererankop.CreateRerankOrqTypedDict,
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateRerankResponseBody:
+        r"""Create rerank
+
+        Rerank a list of documents based on their relevance to a query.
+
+        :param query: The search query
+        :param documents: A list of texts that will be compared to the `query`. For optimal performance we recommend against sending more than 1,000 documents in a single request.
+        :param model: The identifier of the model to use
+        :param top_n: The number of most relevant documents or indices to return, defaults to the length of the documents
+        :param filename: The filename of the document to rerank
+        :param name: The name to display on the trace. If not specified, the default system name will be used.
+        :param fallbacks: Array of fallback models to use if primary model fails
+        :param retry: Retry configuration for the request
+        :param cache: Cache configuration for the request.
+        :param load_balancer: Load balancer configuration for the request.
+        :param timeout: Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.
+        :param orq:
+        :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 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 timeout_ms is None:
+            timeout_ms = 600000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreateRerankRequestBody(
+            query=query,
+            documents=documents,
+            model=model,
+            top_n=top_n,
+            filename=filename,
+            name=name,
+            fallbacks=utils.get_pydantic_model(
+                fallbacks, Optional[List[models.CreateRerankFallbacks]]
+            ),
+            retry=utils.get_pydantic_model(retry, Optional[models.CreateRerankRetry]),
+            cache=utils.get_pydantic_model(cache, Optional[models.CreateRerankCache]),
+            load_balancer=utils.get_pydantic_model(
+                load_balancer, Optional[models.CreateRerankLoadBalancer]
+            ),
+            timeout=utils.get_pydantic_model(
+                timeout, Optional[models.CreateRerankTimeout]
+            ),
+            orq=utils.get_pydantic_model(orq, Optional[models.CreateRerankOrq]),
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/v2/router/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="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.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
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        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, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.CreateRerankResponseBody, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise models.APIError("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 models.APIError("API error occurred", http_res, http_res_text)
+
+        raise models.APIError("Unexpected response received", http_res)