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

mixpeek/models/jsontextoutputsettings.py

@@ -0,0 +1,55 @@
+"""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_extensions import NotRequired, TypedDict
+
+
+class ResponseShapeTypedDict(TypedDict):
+    pass
+
+
+class ResponseShape(BaseModel):
+    pass
+
+
+class JSONTextOutputSettingsTypedDict(TypedDict):
+    response_shape: NotRequired[Nullable[ResponseShapeTypedDict]]
+    prompt: NotRequired[Nullable[str]]
+
+
+class JSONTextOutputSettings(BaseModel):
+    response_shape: OptionalNullable[ResponseShape] = UNSET
+
+    prompt: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["response_shape", "prompt"]
+        nullable_fields = ["response_shape", "prompt"]
+        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/jsonvideooutputsettings.py

@@ -0,0 +1,55 @@
+"""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_extensions import NotRequired, TypedDict
+
+
+class JSONVideoOutputSettingsResponseShapeTypedDict(TypedDict):
+    pass
+
+
+class JSONVideoOutputSettingsResponseShape(BaseModel):
+    pass
+
+
+class JSONVideoOutputSettingsTypedDict(TypedDict):
+    response_shape: NotRequired[Nullable[JSONVideoOutputSettingsResponseShapeTypedDict]]
+    prompt: NotRequired[Nullable[str]]
+
+
+class JSONVideoOutputSettings(BaseModel):
+    response_shape: OptionalNullable[JSONVideoOutputSettingsResponseShape] = UNSET
+
+    prompt: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["response_shape", "prompt"]
+        nullable_fields = ["response_shape", "prompt"]
+        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/keywordindexparams.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 KeywordIndexParamsTypedDict(TypedDict):
+    r"""Configuration for keyword index"""
+
+    type: NotRequired[str]
+    is_tenant: NotRequired[bool]
+
+
+class KeywordIndexParams(BaseModel):
+    r"""Configuration for keyword index"""
+
+    type: Optional[str] = "keyword"
+
+    is_tenant: Optional[bool] = False

mixpeek/models/kill_task_tasks_task_id_deleteop.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 KillTaskTasksTaskIDDeleteRequestTypedDict(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 KillTaskTasksTaskIDDeleteRequest(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/list_assets_assets_postop.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .listassetsrequest import ListAssetsRequest, ListAssetsRequestTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mixpeek.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListAssetsAssetsPostRequestTypedDict(TypedDict):
+    list_assets_request: ListAssetsRequestTypedDict
+    page: NotRequired[Nullable[int]]
+    page_size: NotRequired[int]
+    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 ListAssetsAssetsPostRequest(BaseModel):
+    list_assets_request: Annotated[
+        ListAssetsRequest,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+    page: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    page_size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+
+    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 = ["page", "page_size", "X-Namespace"]
+        nullable_fields = ["page", "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/list_collections_collections_getop.py

@@ -0,0 +1,65 @@
+"""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, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListCollectionsCollectionsGetRequestTypedDict(TypedDict):
+    page: NotRequired[Nullable[int]]
+    page_size: NotRequired[int]
+    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 ListCollectionsCollectionsGetRequest(BaseModel):
+    page: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    page_size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+
+    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 = ["page", "page_size", "X-Namespace"]
+        nullable_fields = ["page", "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/list_features_features_postop.py

@@ -0,0 +1,79 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .listfeaturesrequest import ListFeaturesRequest, ListFeaturesRequestTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mixpeek.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListFeaturesFeaturesPostRequestTypedDict(TypedDict):
+    list_features_request: ListFeaturesRequestTypedDict
+    offset_feature_id: NotRequired[Nullable[str]]
+    r"""The offset id to start returning results from. Used for pagination"""
+    page_size: NotRequired[int]
+    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 ListFeaturesFeaturesPostRequest(BaseModel):
+    list_features_request: Annotated[
+        ListFeaturesRequest,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+    offset_feature_id: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The offset id to start returning results from. Used for pagination"""
+
+    page_size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+
+    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 = ["offset_feature_id", "page_size", "X-Namespace"]
+        nullable_fields = ["offset_feature_id", "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/list_interactions_features_search_interactions_getop.py

@@ -0,0 +1,96 @@
+"""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, QueryParamMetadata
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListInteractionsFeaturesSearchInteractionsGetRequestTypedDict(TypedDict):
+    feature_id: NotRequired[Nullable[str]]
+    interaction_type: NotRequired[Nullable[str]]
+    session_id: NotRequired[Nullable[str]]
+    page: NotRequired[Nullable[int]]
+    page_size: NotRequired[int]
+    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 ListInteractionsFeaturesSearchInteractionsGetRequest(BaseModel):
+    feature_id: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    interaction_type: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    session_id: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    page: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    page_size: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+
+    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 = [
+            "feature_id",
+            "interaction_type",
+            "session_id",
+            "page",
+            "page_size",
+            "X-Namespace",
+        ]
+        nullable_fields = [
+            "feature_id",
+            "interaction_type",
+            "session_id",
+            "page",
+            "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/listassetsrequest.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .groupbyoptionsasset import GroupByOptionsAsset, GroupByOptionsAssetTypedDict
+from .logicaloperator_input import LogicalOperatorInput, LogicalOperatorInputTypedDict
+from .sortoption import SortOption, SortOptionTypedDict
+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 ListAssetsRequestTypedDict(TypedDict):
+    collections: List[str]
+    r"""List of Collection IDs or Names to search within, required"""
+    filters: NotRequired[Nullable[LogicalOperatorInputTypedDict]]
+    r"""Used for filtering across all indexes"""
+    group_by: NotRequired[Nullable[GroupByOptionsAssetTypedDict]]
+    r"""Grouping options for search results"""
+    sort: NotRequired[Nullable[SortOptionTypedDict]]
+    r"""List of fields to sort by, with direction (asc or desc). Supports dot notation for nested fields."""
+    select: NotRequired[Nullable[List[str]]]
+    r"""List of fields to return in results, supports dot notation. If None, all fields are returned."""
+    return_url: NotRequired[Nullable[bool]]
+    r"""Return the presigned URL for the asset and preview asset, this will introduce additional latency"""
+
+
+class ListAssetsRequest(BaseModel):
+    collections: List[str]
+    r"""List of Collection IDs or Names to search within, required"""
+
+    filters: OptionalNullable[LogicalOperatorInput] = UNSET
+    r"""Used for filtering across all indexes"""
+
+    group_by: OptionalNullable[GroupByOptionsAsset] = UNSET
+    r"""Grouping options for search results"""
+
+    sort: OptionalNullable[SortOption] = UNSET
+    r"""List of fields to sort by, with direction (asc or desc). Supports dot notation for nested fields."""
+
+    select: OptionalNullable[List[str]] = UNSET
+    r"""List of fields to return in results, supports dot notation. If None, all fields are returned."""
+
+    return_url: OptionalNullable[bool] = UNSET
+    r"""Return the presigned URL for the asset and preview asset, this will introduce additional latency"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["filters", "group_by", "sort", "select", "return_url"]
+        nullable_fields = ["filters", "group_by", "sort", "select", "return_url"]
+        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/listassetsresponse.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .assetresponse import AssetResponse, AssetResponseTypedDict
+from .db_model_paginationresponse import (
+    DbModelPaginationResponse,
+    DbModelPaginationResponseTypedDict,
+)
+from mixpeek.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class ListAssetsResponseTypedDict(TypedDict):
+    results: List[AssetResponseTypedDict]
+    pagination: DbModelPaginationResponseTypedDict
+
+
+class ListAssetsResponse(BaseModel):
+    results: List[AssetResponse]
+
+    pagination: DbModelPaginationResponse

mixpeek/models/listcollectionsresponse.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .collectionresult import CollectionResult, CollectionResultTypedDict
+from .db_model_paginationresponse import (
+    DbModelPaginationResponse,
+    DbModelPaginationResponseTypedDict,
+)
+from mixpeek.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class ListCollectionsResponseTypedDict(TypedDict):
+    results: List[CollectionResultTypedDict]
+    pagination: DbModelPaginationResponseTypedDict
+
+
+class ListCollectionsResponse(BaseModel):
+    results: List[CollectionResult]
+
+    pagination: DbModelPaginationResponse