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

mixpeek/models/actionusage.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mixpeek.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class ActionUsageTypedDict(TypedDict):
+    action: str
+    credits: int
+
+
+class ActionUsage(BaseModel):
+    action: str
+
+    credits: int

mixpeek/models/apierror.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from dataclasses import dataclass
+from typing import Optional
+import httpx
+
+
+@dataclass
+class APIError(Exception):
+    """Represents an error returned by the API."""
+
+    message: str
+    status_code: int = -1
+    body: str = ""
+    raw_response: Optional[httpx.Response] = None
+
+    def __str__(self):
+        body = ""
+        if len(self.body) > 0:
+            body = f"\n{self.body}"
+
+        return f"{self.message}: Status {self.status_code}{body}"

mixpeek/models/apikey.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .permission import Permission
+from datetime import datetime
+from mixpeek.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class APIKeyTypedDict(TypedDict):
+    key: NotRequired[str]
+    name: NotRequired[str]
+    created_at: NotRequired[datetime]
+    permissions: NotRequired[List[Permission]]
+
+
+class APIKey(BaseModel):
+    key: Optional[str] = None
+
+    name: Optional[str] = None
+
+    created_at: Optional[datetime] = None
+
+    permissions: Optional[List[Permission]] = None

mixpeek/models/apikeyupdate.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .permission import Permission
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class APIKeyUpdateTypedDict(TypedDict):
+    name: NotRequired[Nullable[str]]
+    permissions: NotRequired[Nullable[List[Permission]]]
+
+
+class APIKeyUpdate(BaseModel):
+    name: OptionalNullable[str] = UNSET
+
+    permissions: OptionalNullable[List[Permission]] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["name", "permissions"]
+        nullable_fields = ["name", "permissions"]
+        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/assetfeatures.py

@@ -0,0 +1,55 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .featureresponse import FeatureResponse, FeatureResponseTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class AssetFeaturesTypedDict(TypedDict):
+    video: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
+    image: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
+    text: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
+    audio: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
+
+
+class AssetFeatures(BaseModel):
+    video: OptionalNullable[List[FeatureResponse]] = UNSET
+
+    image: OptionalNullable[List[FeatureResponse]] = UNSET
+
+    text: OptionalNullable[List[FeatureResponse]] = UNSET
+
+    audio: OptionalNullable[List[FeatureResponse]] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["video", "image", "text", "audio"]
+        nullable_fields = ["video", "image", "text", "audio"]
+        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/assetresponse.py

@@ -0,0 +1,166 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Any
+from typing_extensions import NotRequired, TypedDict
+
+
+class FileDataTypedDict(TypedDict):
+    pass
+
+
+class FileData(BaseModel):
+    pass
+
+
+class AssetResponseMetadataTypedDict(TypedDict):
+    pass
+
+
+class AssetResponseMetadata(BaseModel):
+    pass
+
+
+class AssetResponseTypedDict(TypedDict):
+    asset_id: NotRequired[Nullable[str]]
+    r"""The unique identifier for the asset"""
+    collection_id: NotRequired[Nullable[str]]
+    r"""The ID of the collection the asset belongs to"""
+    status: NotRequired[Nullable[str]]
+    r"""The current status of the asset processing"""
+    file_data: NotRequired[Nullable[FileDataTypedDict]]
+    r"""File data associated with the asset"""
+    metadata: NotRequired[Nullable[AssetResponseMetadataTypedDict]]
+    r"""Additional metadata associated with the asset"""
+    error: NotRequired[Nullable[Any]]
+    r"""The error message if the asset processing failed"""
+    modality: NotRequired[Nullable[str]]
+    r"""The type of media"""
+    task_id: NotRequired[Nullable[str]]
+    r"""The task ID"""
+    file_hash: NotRequired[Nullable[str]]
+    r"""The unique hash of the"""
+    updated_at: NotRequired[Nullable[datetime]]
+    r"""The timestamp when the asset was last updated"""
+    created_at: NotRequired[Nullable[datetime]]
+    r"""The timestamp when the asset was created"""
+    score: NotRequired[Nullable[float]]
+    r"""The relevance score of the asset"""
+    url: NotRequired[Nullable[str]]
+    r"""The presigned URL for accessing the asset"""
+    preview_url: NotRequired[Nullable[str]]
+    r"""The presigned URL for accessing the asset preview"""
+    duplicate_of: NotRequired[Nullable[str]]
+    r"""The asset_id of the asset that this asset is a duplicate of"""
+
+
+class AssetResponse(BaseModel):
+    asset_id: OptionalNullable[str] = UNSET
+    r"""The unique identifier for the asset"""
+
+    collection_id: OptionalNullable[str] = UNSET
+    r"""The ID of the collection the asset belongs to"""
+
+    status: OptionalNullable[str] = UNSET
+    r"""The current status of the asset processing"""
+
+    file_data: OptionalNullable[FileData] = UNSET
+    r"""File data associated with the asset"""
+
+    metadata: OptionalNullable[AssetResponseMetadata] = UNSET
+    r"""Additional metadata associated with the asset"""
+
+    error: OptionalNullable[Any] = UNSET
+    r"""The error message if the asset processing failed"""
+
+    modality: OptionalNullable[str] = UNSET
+    r"""The type of media"""
+
+    task_id: OptionalNullable[str] = UNSET
+    r"""The task ID"""
+
+    file_hash: OptionalNullable[str] = UNSET
+    r"""The unique hash of the"""
+
+    updated_at: OptionalNullable[datetime] = UNSET
+    r"""The timestamp when the asset was last updated"""
+
+    created_at: OptionalNullable[datetime] = UNSET
+    r"""The timestamp when the asset was created"""
+
+    score: OptionalNullable[float] = UNSET
+    r"""The relevance score of the asset"""
+
+    url: OptionalNullable[str] = UNSET
+    r"""The presigned URL for accessing the asset"""
+
+    preview_url: OptionalNullable[str] = UNSET
+    r"""The presigned URL for accessing the asset preview"""
+
+    duplicate_of: OptionalNullable[str] = UNSET
+    r"""The asset_id of the asset that this asset is a duplicate of"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "asset_id",
+            "collection_id",
+            "status",
+            "file_data",
+            "metadata",
+            "error",
+            "modality",
+            "task_id",
+            "file_hash",
+            "updated_at",
+            "created_at",
+            "score",
+            "url",
+            "preview_url",
+            "duplicate_of",
+        ]
+        nullable_fields = [
+            "asset_id",
+            "collection_id",
+            "status",
+            "file_data",
+            "metadata",
+            "error",
+            "modality",
+            "task_id",
+            "file_hash",
+            "updated_at",
+            "created_at",
+            "score",
+            "url",
+            "preview_url",
+            "duplicate_of",
+        ]
+        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/assets_model_searchquery.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 List
+from typing_extensions import TypedDict
+
+
+class AssetsModelSearchQueryTypedDict(TypedDict):
+    key: List[str]
+    r"""Fields to search in. Can be a list of field names or '*' for all fields"""
+    value: str
+    r"""The search term to look for in the specified fields"""
+
+
+class AssetsModelSearchQuery(BaseModel):
+    key: List[str]
+    r"""Fields to search in. Can be a list of field names or '*' for all fields"""
+
+    value: str
+    r"""The search term to look for in the specified fields"""

mixpeek/models/assetupdate.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mixpeek.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class Mode(str, Enum):
+    r"""Update mode: 'replace' or 'append'"""
+
+    REPLACE = "replace"
+    APPEND = "append"
+
+
+class AssetUpdateTypedDict(TypedDict):
+    asset_id: str
+    r"""Unique identifier for the asset to be updated"""
+    mode: Mode
+    r"""Update mode: 'replace' or 'append'"""
+
+
+class AssetUpdate(BaseModel):
+    asset_id: str
+    r"""Unique identifier for the asset to be updated"""
+
+    mode: Mode
+    r"""Update mode: 'replace' or 'append'"""

mixpeek/models/availableindexesresponse.py

@@ -0,0 +1,23 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .modeldetails import ModelDetails, ModelDetailsTypedDict
+from .payloadindextype import PayloadIndexType, PayloadIndexTypeTypedDict
+from mixpeek.types import BaseModel
+from typing import Dict, List
+from typing_extensions import TypedDict
+
+
+class AvailableIndexesResponseTypedDict(TypedDict):
+    r"""Response schema for available indexes endpoint"""
+
+    vector_indexes: Dict[str, ModelDetailsTypedDict]
+    payload_indexes: List[PayloadIndexTypeTypedDict]
+
+
+class AvailableIndexesResponse(BaseModel):
+    r"""Response schema for available indexes endpoint"""
+
+    vector_indexes: Dict[str, ModelDetails]
+
+    payload_indexes: List[PayloadIndexType]

mixpeek/models/availablemodels.py

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

mixpeek/models/boolindexparams.py

@@ -0,0 +1,18 @@
+"""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 BoolIndexParamsTypedDict(TypedDict):
+    r"""Configuration for boolean index"""
+
+    type: NotRequired[str]
+
+
+class BoolIndexParams(BaseModel):
+    r"""Configuration for boolean index"""
+
+    type: Optional[str] = "bool"

mixpeek/models/collectionmodel.py

@@ -0,0 +1,70 @@
+"""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 CollectionModelMetadataTypedDict(TypedDict):
+    pass
+
+
+class CollectionModelMetadata(BaseModel):
+    pass
+
+
+class CollectionModelTypedDict(TypedDict):
+    collection_name: str
+    r"""Name for the collection"""
+    collection_id: NotRequired[str]
+    r"""Unique identifier for the collection"""
+    namespace_id: NotRequired[Nullable[str]]
+    r"""Namespace for the collection"""
+    metadata: NotRequired[Nullable[CollectionModelMetadataTypedDict]]
+    r"""Optional metadata for the collection"""
+
+
+class CollectionModel(BaseModel):
+    collection_name: str
+    r"""Name for the collection"""
+
+    collection_id: Optional[str] = None
+    r"""Unique identifier for the collection"""
+
+    namespace_id: OptionalNullable[str] = UNSET
+    r"""Namespace for the collection"""
+
+    metadata: OptionalNullable[CollectionModelMetadata] = UNSET
+    r"""Optional metadata for the collection"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["collection_id", "namespace_id", "metadata"]
+        nullable_fields = ["namespace_id", "metadata"]
+        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/collectionresult.py

@@ -0,0 +1,73 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class CollectionResultMetadataTypedDict(TypedDict):
+    pass
+
+
+class CollectionResultMetadata(BaseModel):
+    pass
+
+
+class CollectionResultTypedDict(TypedDict):
+    count: int
+    size_bytes: int
+    last_updated: datetime
+    r"""MongoDB datetime format"""
+    collection_id: str
+    preview_url: NotRequired[Nullable[str]]
+    metadata: NotRequired[Nullable[CollectionResultMetadataTypedDict]]
+    collection_name: NotRequired[Nullable[str]]
+
+
+class CollectionResult(BaseModel):
+    count: int
+
+    size_bytes: int
+
+    last_updated: datetime
+    r"""MongoDB datetime format"""
+
+    collection_id: str
+
+    preview_url: OptionalNullable[str] = UNSET
+
+    metadata: OptionalNullable[CollectionResultMetadata] = UNSET
+
+    collection_name: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["preview_url", "metadata", "collection_name"]
+        nullable_fields = ["preview_url", "metadata", "collection_name"]
+        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/create_api_key_organizations_users_user_email_api_keys_postop.py

@@ -0,0 +1,23 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mixpeek.types import BaseModel
+from mixpeek.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateAPIKeyOrganizationsUsersUserEmailAPIKeysPostRequestTypedDict(TypedDict):
+    user_email: str
+    key_name: NotRequired[str]
+
+
+class CreateAPIKeyOrganizationsUsersUserEmailAPIKeysPostRequest(BaseModel):
+    user_email: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    key_name: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "default"

mixpeek/models/create_collection_collections_postop.py

@@ -0,0 +1,62 @@
+"""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, RequestMetadata
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateCollectionCollectionsPostRequestTypedDict(TypedDict):
+    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 CreateCollectionCollectionsPostRequest(BaseModel):
+    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