mixpeek 0.11.2__py3-none-any.whl → 0.13__py3-none-any.whl

mixpeek/models/tasks_model_taskresponse.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .taskstatus import TaskStatus
+from mixpeek.types import BaseModel
+from typing import Any, List
+from typing_extensions import TypedDict
+
+
+class TasksModelTaskResponseTypedDict(TypedDict):
+    task_id: str
+    status: TaskStatus
+    inputs: List[Any]
+    outputs: List[Any]
+
+
+class TasksModelTaskResponse(BaseModel):
+    task_id: str
+
+    status: TaskStatus
+
+    inputs: List[Any]
+
+    outputs: List[Any]

mixpeek/models/taskstatus.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class TaskStatus(str, Enum):
+    DONE = "DONE"
+    FAILED = "FAILED"
+    SKIPPED = "SKIPPED"
+    CANCELLED = "CANCELLED"
+    PROCESSING = "PROCESSING"
+    DOWNLOADING = "DOWNLOADING"
+    INITIALIZING = "INITIALIZING"
+    UPLOADING = "UPLOADING"
+    QUEUED = "QUEUED"

mixpeek/models/textindexparams.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .tokenizertype import TokenizerType
+from mixpeek.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class TextIndexParamsTypedDict(TypedDict):
+    r"""Configuration for text index"""
+
+    type: NotRequired[str]
+    tokenizer: NotRequired[TokenizerType]
+    min_token_len: NotRequired[int]
+    max_token_len: NotRequired[int]
+    lowercase: NotRequired[bool]
+
+
+class TextIndexParams(BaseModel):
+    r"""Configuration for text index"""
+
+    type: Optional[str] = "text"
+
+    tokenizer: Optional[TokenizerType] = None
+
+    min_token_len: Optional[int] = 2
+
+    max_token_len: Optional[int] = 15
+
+    lowercase: Optional[bool] = True

mixpeek/models/textsettings.py

@@ -0,0 +1,61 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .embeddingrequest import EmbeddingRequest, EmbeddingRequestTypedDict
+from .jsontextoutputsettings import (
+    JSONTextOutputSettings,
+    JSONTextOutputSettingsTypedDict,
+)
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class TextSettingsTypedDict(TypedDict):
+    embed: NotRequired[List[EmbeddingRequestTypedDict]]
+    r"""List of embedding settings for generating multiple embeddings. field_name's provided are how the raw text will be inserted, if not provided, the field_name will be auto-generated.
+    Default: [{type: 'text', vector_index: 'multimodal'}] if none provided.
+    """
+    json_output: NotRequired[Nullable[JSONTextOutputSettingsTypedDict]]
+    r"""Settings for structured JSON output of text analysis."""
+
+
+class TextSettings(BaseModel):
+    embed: Optional[List[EmbeddingRequest]] = None
+    r"""List of embedding settings for generating multiple embeddings. field_name's provided are how the raw text will be inserted, if not provided, the field_name will be auto-generated.
+    Default: [{type: 'text', vector_index: 'multimodal'}] if none provided.
+    """
+
+    json_output: OptionalNullable[JSONTextOutputSettings] = UNSET
+    r"""Settings for structured JSON output of text analysis."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["embed", "json_output"]
+        nullable_fields = ["json_output"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

mixpeek/models/tokenizertype.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class TokenizerType(str, Enum):
+    WORD = "word"
+    WHITESPACE = "whitespace"
+    PREFIX = "prefix"
+    MULTILINGUAL = "multilingual"

mixpeek/models/update_api_key_organizations_users_user_email_api_keys_key_name_patchop.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .apikeyupdate import APIKeyUpdate, APIKeyUpdateTypedDict
+from mixpeek.types import BaseModel
+from mixpeek.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class UpdateAPIKeyOrganizationsUsersUserEmailAPIKeysKeyNamePatchRequestTypedDict(
+    TypedDict
+):
+    user_email: str
+    key_name: str
+    api_key_update: APIKeyUpdateTypedDict
+
+
+class UpdateAPIKeyOrganizationsUsersUserEmailAPIKeysKeyNamePatchRequest(BaseModel):
+    user_email: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    key_name: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    api_key_update: Annotated[
+        APIKeyUpdate,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

mixpeek/models/update_collection_collections_collection_putop.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createcollectionrequest import (
+    CreateCollectionRequest,
+    CreateCollectionRequestTypedDict,
+)
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mixpeek.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpdateCollectionCollectionsCollectionPutRequestTypedDict(TypedDict):
+    collection: str
+    r"""Either the collection name or collection ID"""
+    create_collection_request: CreateCollectionRequestTypedDict
+    x_namespace: NotRequired[Nullable[str]]
+    r"""Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint."""
+
+
+class UpdateCollectionCollectionsCollectionPutRequest(BaseModel):
+    collection: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Either the collection name or collection ID"""
+
+    create_collection_request: Annotated[
+        CreateCollectionRequest,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+    x_namespace: Annotated[
+        OptionalNullable[str],
+        pydantic.Field(alias="X-Namespace"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = UNSET
+    r"""Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["X-Namespace"]
+        nullable_fields = ["X-Namespace"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

mixpeek/models/update_namespace_namespaces_namespace_putop.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .updatenamespacerequest import (
+    UpdateNamespaceRequest,
+    UpdateNamespaceRequestTypedDict,
+)
+from mixpeek.types import BaseModel
+from mixpeek.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class UpdateNamespaceNamespacesNamespacePutRequestTypedDict(TypedDict):
+    namespace: str
+    r"""Either the namespace name or namespace ID"""
+    update_namespace_request: UpdateNamespaceRequestTypedDict
+
+
+class UpdateNamespaceNamespacesNamespacePutRequest(BaseModel):
+    namespace: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Either the namespace name or namespace ID"""
+
+    update_namespace_request: Annotated[
+        UpdateNamespaceRequest,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

mixpeek/models/updateassetrequest.py

@@ -0,0 +1,60 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UpdateAssetRequestMetadataTypedDict(TypedDict):
+    r"""Updated metadata for the asset. This can include any key-value pairs that should be updated or added to the asset's metadata."""
+
+
+class UpdateAssetRequestMetadata(BaseModel):
+    r"""Updated metadata for the asset. This can include any key-value pairs that should be updated or added to the asset's metadata."""
+
+
+class UpdateAssetRequestTypedDict(TypedDict):
+    propagate_features: NotRequired[Nullable[bool]]
+    r"""If True, the features will be propagated to all assets with the same asset_id"""
+    metadata: NotRequired[UpdateAssetRequestMetadataTypedDict]
+    r"""Updated metadata for the asset. This can include any key-value pairs that should be updated or added to the asset's metadata."""
+
+
+class UpdateAssetRequest(BaseModel):
+    propagate_features: OptionalNullable[bool] = UNSET
+    r"""If True, the features will be propagated to all assets with the same asset_id"""
+
+    metadata: Optional[UpdateAssetRequestMetadata] = None
+    r"""Updated metadata for the asset. This can include any key-value pairs that should be updated or added to the asset's metadata."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["propagate_features", "metadata"]
+        nullable_fields = ["propagate_features"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

mixpeek/models/updatenamespacerequest.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .payloadindexconfig import PayloadIndexConfig, PayloadIndexConfigTypedDict
+from mixpeek.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class UpdateNamespaceRequestTypedDict(TypedDict):
+    r"""Request schema for updating a namespace's payload indexes"""
+
+    namespace_name: str
+    r"""Name of the namespace to update"""
+    payload_indexes: List[PayloadIndexConfigTypedDict]
+    r"""Updated list of payload index configurations"""
+
+
+class UpdateNamespaceRequest(BaseModel):
+    r"""Request schema for updating a namespace's payload indexes"""
+
+    namespace_name: str
+    r"""Name of the namespace to update"""
+
+    payload_indexes: List[PayloadIndexConfig]
+    r"""Updated list of payload index configurations"""

mixpeek/models/usage.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .dateusage import DateUsage, DateUsageTypedDict
+from mixpeek.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class UsageTypedDict(TypedDict):
+    total_credits: int
+    dates: List[DateUsageTypedDict]
+
+
+class Usage(BaseModel):
+    total_credits: int
+
+    dates: List[DateUsage]

mixpeek/models/usermodel_input.py

@@ -0,0 +1,36 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .apikey import APIKey, APIKeyTypedDict
+from datetime import datetime
+from mixpeek.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UserModelInputMetadataTypedDict(TypedDict):
+    pass
+
+
+class UserModelInputMetadata(BaseModel):
+    pass
+
+
+class UserModelInputTypedDict(TypedDict):
+    email: str
+    user_id: NotRequired[str]
+    api_keys: NotRequired[List[APIKeyTypedDict]]
+    metadata: NotRequired[UserModelInputMetadataTypedDict]
+    created_at: NotRequired[datetime]
+
+
+class UserModelInput(BaseModel):
+    email: str
+
+    user_id: Optional[str] = None
+
+    api_keys: Optional[List[APIKey]] = None
+
+    metadata: Optional[UserModelInputMetadata] = None
+
+    created_at: Optional[datetime] = None

mixpeek/models/usermodel_output.py

@@ -0,0 +1,36 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .apikey import APIKey, APIKeyTypedDict
+from datetime import datetime
+from mixpeek.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UserModelOutputMetadataTypedDict(TypedDict):
+    pass
+
+
+class UserModelOutputMetadata(BaseModel):
+    pass
+
+
+class UserModelOutputTypedDict(TypedDict):
+    email: str
+    user_id: NotRequired[str]
+    api_keys: NotRequired[List[APIKeyTypedDict]]
+    metadata: NotRequired[UserModelOutputMetadataTypedDict]
+    created_at: NotRequired[datetime]
+
+
+class UserModelOutput(BaseModel):
+    email: str
+
+    user_id: Optional[str] = None
+
+    api_keys: Optional[List[APIKey]] = None
+
+    metadata: Optional[UserModelOutputMetadata] = None
+
+    created_at: Optional[datetime] = None

mixpeek/models/uuidindexparams.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mixpeek.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UUIDIndexParamsTypedDict(TypedDict):
+    r"""Configuration for UUID index"""
+
+    type: NotRequired[str]
+    is_tenant: NotRequired[bool]
+
+
+class UUIDIndexParams(BaseModel):
+    r"""Configuration for UUID index"""
+
+    type: Optional[str] = "uuid"
+
+    is_tenant: Optional[bool] = False

mixpeek/models/validationerror.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mixpeek.types import BaseModel
+from typing import List, Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+LocTypedDict = TypeAliasType("LocTypedDict", Union[str, int])
+
+
+Loc = TypeAliasType("Loc", Union[str, int])
+
+
+class ValidationErrorTypedDict(TypedDict):
+    loc: List[LocTypedDict]
+    msg: str
+    type: str
+
+
+class ValidationError(BaseModel):
+    loc: List[Loc]
+
+    msg: str
+
+    type: str

mixpeek/models/vectormodel.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class VectorModel(str, Enum):
+    IMAGE = "image"
+    MULTIMODAL = "multimodal"
+    TEXT = "text"
+    KEYWORD = "keyword"

mixpeek/models/vectortype.py

@@ -0,0 +1,9 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class VectorType(str, Enum):
+    SPARSE = "sparse"
+    DENSE = "dense"

mixpeek/models/videodescribesettings.py

@@ -0,0 +1,82 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .vectormodel import VectorModel
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class VideoDescribeSettingsJSONOutputTypedDict(TypedDict):
+    r"""JSON format for the response"""
+
+
+class VideoDescribeSettingsJSONOutput(BaseModel):
+    r"""JSON format for the response"""
+
+
+class VideoDescribeSettingsTypedDict(TypedDict):
+    prompt: NotRequired[Nullable[str]]
+    r"""Prompt for video description"""
+    enabled: NotRequired[bool]
+    r"""Enable video description"""
+    max_length: NotRequired[Nullable[int]]
+    r"""Maximum length of the description"""
+    json_output: NotRequired[VideoDescribeSettingsJSONOutputTypedDict]
+    r"""JSON format for the response"""
+    vector_index: NotRequired[Nullable[VectorModel]]
+    r"""Name of the vector model to use for embedding the text output. If vector_index is duplicated, the vector will be overwritten."""
+
+
+class VideoDescribeSettings(BaseModel):
+    prompt: OptionalNullable[str] = UNSET
+    r"""Prompt for video description"""
+
+    enabled: Optional[bool] = True
+    r"""Enable video description"""
+
+    max_length: OptionalNullable[int] = UNSET
+    r"""Maximum length of the description"""
+
+    json_output: Optional[VideoDescribeSettingsJSONOutput] = None
+    r"""JSON format for the response"""
+
+    vector_index: OptionalNullable[VectorModel] = UNSET
+    r"""Name of the vector model to use for embedding the text output. If vector_index is duplicated, the vector will be overwritten."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "prompt",
+            "enabled",
+            "max_length",
+            "json_output",
+            "vector_index",
+        ]
+        nullable_fields = ["prompt", "max_length", "vector_index"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

mixpeek/models/videodetectsettings.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .facedetectsettings import FaceDetectSettings, FaceDetectSettingsTypedDict
+from .logodetectsettings import LogoDetectSettings, LogoDetectSettingsTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class VideoDetectSettingsTypedDict(TypedDict):
+    faces: NotRequired[Nullable[FaceDetectSettingsTypedDict]]
+    r"""Settings for face detection"""
+    logos: NotRequired[Nullable[LogoDetectSettingsTypedDict]]
+    r"""Settings for logo detection"""
+
+
+class VideoDetectSettings(BaseModel):
+    faces: OptionalNullable[FaceDetectSettings] = UNSET
+    r"""Settings for face detection"""
+
+    logos: OptionalNullable[LogoDetectSettings] = UNSET
+    r"""Settings for logo detection"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["faces", "logos"]
+        nullable_fields = ["faces", "logos"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m