orq-ai-sdk 4.2.0rc28__py3-none-any.whl → 4.3.0rc7__py3-none-any.whl

orq_ai_sdk/models/creatererankop.py

@@ -0,0 +1,608 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .publiccontact import PublicContact, PublicContactTypedDict
+from .publicidentity import PublicIdentity, PublicIdentityTypedDict
+from orq_ai_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateRerankFallbacksTypedDict(TypedDict):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class CreateRerankFallbacks(BaseModel):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class CreateRerankRetryTypedDict(TypedDict):
+    r"""Retry configuration for the request"""
+
+    count: NotRequired[float]
+    r"""Number of retry attempts (1-5)"""
+    on_codes: NotRequired[List[float]]
+    r"""HTTP status codes that trigger retry logic"""
+
+
+class CreateRerankRetry(BaseModel):
+    r"""Retry configuration for the request"""
+
+    count: Optional[float] = 3
+    r"""Number of retry attempts (1-5)"""
+
+    on_codes: Optional[List[float]] = None
+    r"""HTTP status codes that trigger retry logic"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["count", "on_codes"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+CreateRerankType = Literal["exact_match",]
+
+
+class CreateRerankCacheTypedDict(TypedDict):
+    r"""Cache configuration for the request."""
+
+    type: CreateRerankType
+    ttl: NotRequired[float]
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+
+class CreateRerankCache(BaseModel):
+    r"""Cache configuration for the request."""
+
+    type: CreateRerankType
+
+    ttl: Optional[float] = 1800
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+CreateRerankLoadBalancerType = Literal["weight_based",]
+
+
+class CreateRerankLoadBalancerModelsTypedDict(TypedDict):
+    model: str
+    r"""Model identifier for load balancing"""
+    weight: NotRequired[float]
+    r"""Weight assigned to this model for load balancing"""
+
+
+class CreateRerankLoadBalancerModels(BaseModel):
+    model: str
+    r"""Model identifier for load balancing"""
+
+    weight: Optional[float] = 0.5
+    r"""Weight assigned to this model for load balancing"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["weight"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateRerankLoadBalancer1TypedDict(TypedDict):
+    type: CreateRerankLoadBalancerType
+    models: List[CreateRerankLoadBalancerModelsTypedDict]
+
+
+class CreateRerankLoadBalancer1(BaseModel):
+    type: CreateRerankLoadBalancerType
+
+    models: List[CreateRerankLoadBalancerModels]
+
+
+CreateRerankLoadBalancerTypedDict = CreateRerankLoadBalancer1TypedDict
+r"""Load balancer configuration for the request."""
+
+
+CreateRerankLoadBalancer = CreateRerankLoadBalancer1
+r"""Load balancer configuration for the request."""
+
+
+class CreateRerankTimeoutTypedDict(TypedDict):
+    r"""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."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+class CreateRerankTimeout(BaseModel):
+    r"""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."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+class CreateRerankRouterRerankFallbacksTypedDict(TypedDict):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class CreateRerankRouterRerankFallbacks(BaseModel):
+    model: str
+    r"""Fallback model identifier"""
+
+
+CreateRerankRouterRerankType = Literal["exact_match",]
+
+
+class CreateRerankRouterRerankCacheTypedDict(TypedDict):
+    r"""Cache configuration for the request."""
+
+    type: CreateRerankRouterRerankType
+    ttl: NotRequired[float]
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+
+class CreateRerankRouterRerankCache(BaseModel):
+    r"""Cache configuration for the request."""
+
+    type: CreateRerankRouterRerankType
+
+    ttl: Optional[float] = 1800
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateRerankRouterRerankRetryTypedDict(TypedDict):
+    r"""Retry configuration for the request"""
+
+    count: NotRequired[float]
+    r"""Number of retry attempts (1-5)"""
+    on_codes: NotRequired[List[float]]
+    r"""HTTP status codes that trigger retry logic"""
+
+
+class CreateRerankRouterRerankRetry(BaseModel):
+    r"""Retry configuration for the request"""
+
+    count: Optional[float] = 3
+    r"""Number of retry attempts (1-5)"""
+
+    on_codes: Optional[List[float]] = None
+    r"""HTTP status codes that trigger retry logic"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["count", "on_codes"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+CreateRerankLoadBalancerRouterRerankType = Literal["weight_based",]
+
+
+class CreateRerankLoadBalancerRouterRerankModelsTypedDict(TypedDict):
+    model: str
+    r"""Model identifier for load balancing"""
+    weight: NotRequired[float]
+    r"""Weight assigned to this model for load balancing"""
+
+
+class CreateRerankLoadBalancerRouterRerankModels(BaseModel):
+    model: str
+    r"""Model identifier for load balancing"""
+
+    weight: Optional[float] = 0.5
+    r"""Weight assigned to this model for load balancing"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["weight"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateRerankLoadBalancerRouterRerank1TypedDict(TypedDict):
+    type: CreateRerankLoadBalancerRouterRerankType
+    models: List[CreateRerankLoadBalancerRouterRerankModelsTypedDict]
+
+
+class CreateRerankLoadBalancerRouterRerank1(BaseModel):
+    type: CreateRerankLoadBalancerRouterRerankType
+
+    models: List[CreateRerankLoadBalancerRouterRerankModels]
+
+
+CreateRerankRouterRerankLoadBalancerTypedDict = (
+    CreateRerankLoadBalancerRouterRerank1TypedDict
+)
+r"""Array of models with weights for load balancing requests"""
+
+
+CreateRerankRouterRerankLoadBalancer = CreateRerankLoadBalancerRouterRerank1
+r"""Array of models with weights for load balancing requests"""
+
+
+class CreateRerankRouterRerankTimeoutTypedDict(TypedDict):
+    r"""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."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+class CreateRerankRouterRerankTimeout(BaseModel):
+    r"""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."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+class CreateRerankOrqTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""The name to display on the trace. If not specified, the default system name will be used."""
+    fallbacks: NotRequired[List[CreateRerankRouterRerankFallbacksTypedDict]]
+    r"""Array of fallback models to use if primary model fails"""
+    cache: NotRequired[CreateRerankRouterRerankCacheTypedDict]
+    r"""Cache configuration for the request."""
+    retry: NotRequired[CreateRerankRouterRerankRetryTypedDict]
+    r"""Retry configuration for the request"""
+    identity: NotRequired[PublicIdentityTypedDict]
+    r"""Information about the identity making the request. If the identity does not exist, it will be created automatically."""
+    contact: NotRequired[PublicContactTypedDict]
+    r"""@deprecated Use identity instead. Information about the contact making the request."""
+    load_balancer: NotRequired[CreateRerankRouterRerankLoadBalancerTypedDict]
+    r"""Array of models with weights for load balancing requests"""
+    timeout: NotRequired[CreateRerankRouterRerankTimeoutTypedDict]
+    r"""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."""
+
+
+class CreateRerankOrq(BaseModel):
+    name: Optional[str] = None
+    r"""The name to display on the trace. If not specified, the default system name will be used."""
+
+    fallbacks: Optional[List[CreateRerankRouterRerankFallbacks]] = None
+    r"""Array of fallback models to use if primary model fails"""
+
+    cache: Optional[CreateRerankRouterRerankCache] = None
+    r"""Cache configuration for the request."""
+
+    retry: Optional[CreateRerankRouterRerankRetry] = None
+    r"""Retry configuration for the request"""
+
+    identity: Optional[PublicIdentity] = None
+    r"""Information about the identity making the request. If the identity does not exist, it will be created automatically."""
+
+    contact: Annotated[
+        Optional[PublicContact],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+        ),
+    ] = None
+    r"""@deprecated Use identity instead. Information about the contact making the request."""
+
+    load_balancer: Optional[CreateRerankRouterRerankLoadBalancer] = None
+    r"""Array of models with weights for load balancing requests"""
+
+    timeout: Optional[CreateRerankRouterRerankTimeout] = None
+    r"""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."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "name",
+                "fallbacks",
+                "cache",
+                "retry",
+                "identity",
+                "contact",
+                "load_balancer",
+                "timeout",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateRerankRequestBodyTypedDict(TypedDict):
+    r"""input"""
+
+    query: str
+    r"""The search query"""
+    documents: List[str]
+    r"""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."""
+    model: str
+    r"""The identifier of the model to use"""
+    top_n: NotRequired[float]
+    r"""The number of most relevant documents or indices to return, defaults to the length of the documents"""
+    filename: NotRequired[Nullable[str]]
+    r"""The filename of the document to rerank"""
+    name: NotRequired[str]
+    r"""The name to display on the trace. If not specified, the default system name will be used."""
+    fallbacks: NotRequired[List[CreateRerankFallbacksTypedDict]]
+    r"""Array of fallback models to use if primary model fails"""
+    retry: NotRequired[CreateRerankRetryTypedDict]
+    r"""Retry configuration for the request"""
+    cache: NotRequired[CreateRerankCacheTypedDict]
+    r"""Cache configuration for the request."""
+    load_balancer: NotRequired[CreateRerankLoadBalancerTypedDict]
+    r"""Load balancer configuration for the request."""
+    timeout: NotRequired[CreateRerankTimeoutTypedDict]
+    r"""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."""
+    orq: NotRequired[CreateRerankOrqTypedDict]
+
+
+class CreateRerankRequestBody(BaseModel):
+    r"""input"""
+
+    query: str
+    r"""The search query"""
+
+    documents: List[str]
+    r"""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."""
+
+    model: str
+    r"""The identifier of the model to use"""
+
+    top_n: Optional[float] = None
+    r"""The number of most relevant documents or indices to return, defaults to the length of the documents"""
+
+    filename: OptionalNullable[str] = UNSET
+    r"""The filename of the document to rerank"""
+
+    name: Optional[str] = None
+    r"""The name to display on the trace. If not specified, the default system name will be used."""
+
+    fallbacks: Optional[List[CreateRerankFallbacks]] = None
+    r"""Array of fallback models to use if primary model fails"""
+
+    retry: Optional[CreateRerankRetry] = None
+    r"""Retry configuration for the request"""
+
+    cache: Optional[CreateRerankCache] = None
+    r"""Cache configuration for the request."""
+
+    load_balancer: Optional[CreateRerankLoadBalancer] = None
+    r"""Load balancer configuration for the request."""
+
+    timeout: Optional[CreateRerankTimeout] = None
+    r"""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."""
+
+    orq: Optional[CreateRerankOrq] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "top_n",
+                "filename",
+                "name",
+                "fallbacks",
+                "retry",
+                "cache",
+                "load_balancer",
+                "timeout",
+                "orq",
+            ]
+        )
+        nullable_fields = set(["filename"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+CreateRerankObject = Literal["list",]
+
+
+CreateRerankRouterRerankObject = Literal["rerank",]
+r"""The object type, which is always `rerank`."""
+
+
+class CreateRerankDocumentTypedDict(TypedDict):
+    r"""If return_documents is set as false this will return none, if true it will return the documents passed in"""
+
+    text: str
+    r"""The text of the document to rerank"""
+
+
+class CreateRerankDocument(BaseModel):
+    r"""If return_documents is set as false this will return none, if true it will return the documents passed in"""
+
+    text: str
+    r"""The text of the document to rerank"""
+
+
+class CreateRerankResultsTypedDict(TypedDict):
+    object: CreateRerankRouterRerankObject
+    r"""The object type, which is always `rerank`."""
+    index: float
+    r"""Corresponds to the index in the original list of documents to which the ranked document belongs."""
+    relevance_score: float
+    r"""Relevance scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance."""
+    document: NotRequired[CreateRerankDocumentTypedDict]
+    r"""If return_documents is set as false this will return none, if true it will return the documents passed in"""
+
+
+class CreateRerankResults(BaseModel):
+    object: CreateRerankRouterRerankObject
+    r"""The object type, which is always `rerank`."""
+
+    index: float
+    r"""Corresponds to the index in the original list of documents to which the ranked document belongs."""
+
+    relevance_score: float
+    r"""Relevance scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance."""
+
+    document: Optional[CreateRerankDocument] = None
+    r"""If return_documents is set as false this will return none, if true it will return the documents passed in"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["document"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateRerankUsageTypedDict(TypedDict):
+    total_tokens: float
+    r"""The total number of tokens used in the rerank"""
+
+
+class CreateRerankUsage(BaseModel):
+    total_tokens: float
+    r"""The total number of tokens used in the rerank"""
+
+
+class CreateRerankResponseBodyTypedDict(TypedDict):
+    r"""Returns the reranked documents."""
+
+    object: CreateRerankObject
+    results: List[CreateRerankResultsTypedDict]
+    r"""An ordered list of ranked documents"""
+    id: NotRequired[str]
+    r"""A unique identifier for the rerank."""
+    usage: NotRequired[CreateRerankUsageTypedDict]
+
+
+class CreateRerankResponseBody(BaseModel):
+    r"""Returns the reranked documents."""
+
+    object: CreateRerankObject
+
+    results: List[CreateRerankResults]
+    r"""An ordered list of ranked documents"""
+
+    id: Optional[str] = None
+    r"""A unique identifier for the rerank."""
+
+    usage: Optional[CreateRerankUsage] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["id", "usage"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m