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

mixpeek/models/get_asset_assets_asset_id_getop.py

@@ -0,0 +1,73 @@
+"""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 mixpeek.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAssetAssetsAssetIDGetRequestTypedDict(TypedDict):
+    asset_id: str
+    r"""Unique identifier of the asset"""
+    return_url: NotRequired[bool]
+    r"""Whether to generate and return presigned S3 URLs for the asset and preview. Set to false to improve performance when URLs aren't needed"""
+    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 GetAssetAssetsAssetIDGetRequest(BaseModel):
+    asset_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Unique identifier of the asset"""
+
+    return_url: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = True
+    r"""Whether to generate and return presigned S3 URLs for the asset and preview. Set to false to improve performance when URLs aren't needed"""
+
+    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 = ["return_url", "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/get_asset_with_features_assets_asset_id_features_getop.py

@@ -0,0 +1,73 @@
+"""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 mixpeek.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetAssetWithFeaturesAssetsAssetIDFeaturesGetRequestTypedDict(TypedDict):
+    asset_id: str
+    r"""Unique identifier of the asset"""
+    return_url: NotRequired[bool]
+    r"""Whether to generate and return presigned S3 URLs for the asset and preview. Set to false to improve performance when URLs aren't needed"""
+    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 GetAssetWithFeaturesAssetsAssetIDFeaturesGetRequest(BaseModel):
+    asset_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Unique identifier of the asset"""
+
+    return_url: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = False
+    r"""Whether to generate and return presigned S3 URLs for the asset and preview. Set to false to improve performance when URLs aren't needed"""
+
+    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 = ["return_url", "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/get_collection_collections_collection_getop.py

@@ -0,0 +1,59 @@
+"""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 mixpeek.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetCollectionCollectionsCollectionGetRequestTypedDict(TypedDict):
+    collection: str
+    r"""Either the collection name or collection ID"""
+    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 GetCollectionCollectionsCollectionGetRequest(BaseModel):
+    collection: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Either the collection name or collection ID"""
+
+    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/get_feature_features_feature_id_getop.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 mixpeek.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetFeatureFeaturesFeatureIDGetRequestTypedDict(TypedDict):
+    feature_id: str
+    return_vectors: NotRequired[Nullable[bool]]
+    r"""When true, includes the feature's vector embeddings in the response"""
+    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 GetFeatureFeaturesFeatureIDGetRequest(BaseModel):
+    feature_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    return_vectors: Annotated[
+        OptionalNullable[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""When true, includes the feature's vector embeddings in the response"""
+
+    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 = ["return_vectors", "X-Namespace"]
+        nullable_fields = ["return_vectors", "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/get_interaction_features_search_interactions_interaction_id_getop.py

@@ -0,0 +1,59 @@
+"""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 mixpeek.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetInteractionFeaturesSearchInteractionsInteractionIDGetRequestTypedDict(
+    TypedDict
+):
+    interaction_id: str
+    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 GetInteractionFeaturesSearchInteractionsInteractionIDGetRequest(BaseModel):
+    interaction_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    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/get_namespace_namespaces_namespace_getop.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 mixpeek.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class GetNamespaceNamespacesNamespaceGetRequestTypedDict(TypedDict):
+    namespace: str
+    r"""Either the namespace name or namespace ID"""
+
+
+class GetNamespaceNamespacesNamespaceGetRequest(BaseModel):
+    namespace: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Either the namespace name or namespace ID"""

mixpeek/models/get_task_tasks_task_id_getop.py

@@ -0,0 +1,57 @@
+"""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 mixpeek.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetTaskTasksTaskIDGetRequestTypedDict(TypedDict):
+    task_id: str
+    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 GetTaskTasksTaskIDGetRequest(BaseModel):
+    task_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    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/get_user_organizations_users_user_email_getop.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 mixpeek.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class GetUserOrganizationsUsersUserEmailGetRequestTypedDict(TypedDict):
+    user_email: str
+
+
+class GetUserOrganizationsUsersUserEmailGetRequest(BaseModel):
+    user_email: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]

mixpeek/models/groupbyoptions.py

@@ -0,0 +1,71 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .sortoption import SortOption, SortOptionTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class GroupByOptionsTypedDict(TypedDict):
+    field: NotRequired[Nullable[str]]
+    r"""
+    Field to group by
+
+    Note: We currently do not support ad-hoc grouping.
+    This means the field must be indexed separately.
+    Please contact us to add additional fields for grouping.
+
+    """
+    max_features: NotRequired[Nullable[int]]
+    r"""Maximum number of features to group"""
+    sort: NotRequired[Nullable[SortOptionTypedDict]]
+    r"""Sort options for ordering the inside of the groups"""
+
+
+class GroupByOptions(BaseModel):
+    field: OptionalNullable[str] = UNSET
+    r"""
+    Field to group by
+
+    Note: We currently do not support ad-hoc grouping.
+    This means the field must be indexed separately.
+    Please contact us to add additional fields for grouping.
+
+    """
+
+    max_features: OptionalNullable[int] = UNSET
+    r"""Maximum number of features to group"""
+
+    sort: OptionalNullable[SortOption] = UNSET
+    r"""Sort options for ordering the inside of the groups"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["field", "max_features", "sort"]
+        nullable_fields = ["field", "max_features", "sort"]
+        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/groupbyoptionsasset.py

@@ -0,0 +1,71 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .sortoption import SortOption, SortOptionTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class GroupByOptionsAssetTypedDict(TypedDict):
+    field: NotRequired[Nullable[str]]
+    r"""
+    Field to group by
+
+    Note: We currently do not support ad-hoc grouping.
+    This means the field must be indexed separately.
+    Please contact us to add additional fields for grouping.
+
+    """
+    max_assets: NotRequired[Nullable[int]]
+    r"""Maximum number of assets to group"""
+    sort: NotRequired[Nullable[SortOptionTypedDict]]
+    r"""Sort options for ordering the inside of the groups"""
+
+
+class GroupByOptionsAsset(BaseModel):
+    field: OptionalNullable[str] = UNSET
+    r"""
+    Field to group by
+
+    Note: We currently do not support ad-hoc grouping.
+    This means the field must be indexed separately.
+    Please contact us to add additional fields for grouping.
+
+    """
+
+    max_assets: OptionalNullable[int] = UNSET
+    r"""Maximum number of assets to group"""
+
+    sort: OptionalNullable[SortOption] = UNSET
+    r"""Sort options for ordering the inside of the groups"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["field", "max_assets", "sort"]
+        nullable_fields = ["field", "max_assets", "sort"]
+        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/groupedassetdata.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .assetfeatures import AssetFeatures, AssetFeaturesTypedDict
+from .assetresponse import AssetResponse, AssetResponseTypedDict
+from mixpeek.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class GroupedAssetDataTypedDict(TypedDict):
+    asset: AssetResponseTypedDict
+    features: AssetFeaturesTypedDict
+
+
+class GroupedAssetData(BaseModel):
+    asset: AssetResponse
+
+    features: AssetFeatures

mixpeek/models/healthcheckresponse.py

@@ -0,0 +1,13 @@
+"""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 HealthCheckResponseTypedDict(TypedDict):
+    status: str
+
+
+class HealthCheckResponse(BaseModel):
+    status: str

mixpeek/models/httpvalidationerror.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .validationerror import ValidationError
+from mixpeek import utils
+from mixpeek.types import BaseModel
+from typing import List, Optional
+
+
+class HTTPValidationErrorData(BaseModel):
+    detail: Optional[List[ValidationError]] = None
+
+
+class HTTPValidationError(Exception):
+    data: HTTPValidationErrorData
+
+    def __init__(self, data: HTTPValidationErrorData):
+        self.data = data
+
+    def __str__(self) -> str:
+        return utils.marshal_json(self.data, HTTPValidationErrorData)