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

mixpeek/models/videoreadsettings.py

@@ -0,0 +1,71 @@
+"""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 JSONOutputTypedDict(TypedDict):
+    r"""JSON format for the response"""
+
+
+class JSONOutput(BaseModel):
+    r"""JSON format for the response"""
+
+
+class VideoReadSettingsTypedDict(TypedDict):
+    enabled: NotRequired[bool]
+    r"""Enable video reading"""
+    prompt: NotRequired[Nullable[str]]
+    r"""Prompt for reading on-screen text"""
+    json_output: NotRequired[JSONOutputTypedDict]
+    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 VideoReadSettings(BaseModel):
+    enabled: Optional[bool] = True
+    r"""Enable video reading"""
+
+    prompt: OptionalNullable[str] = UNSET
+    r"""Prompt for reading on-screen text"""
+
+    json_output: Optional[JSONOutput] = 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 = ["enabled", "prompt", "json_output", "vector_index"]
+        nullable_fields = ["prompt", "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/videosettings.py

@@ -0,0 +1,101 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .embeddingrequest import EmbeddingRequest, EmbeddingRequestTypedDict
+from .jsonvideooutputsettings import (
+    JSONVideoOutputSettings,
+    JSONVideoOutputSettingsTypedDict,
+)
+from .videodescribesettings import VideoDescribeSettings, VideoDescribeSettingsTypedDict
+from .videodetectsettings import VideoDetectSettings, VideoDetectSettingsTypedDict
+from .videoreadsettings import VideoReadSettings, VideoReadSettingsTypedDict
+from .videotranscriptionsettings import (
+    VideoTranscriptionSettings,
+    VideoTranscriptionSettingsTypedDict,
+)
+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 VideoSettingsTypedDict(TypedDict):
+    interval_sec: NotRequired[int]
+    r"""Interval in seconds for processing video. Must be greater than or equal to 5, less than 120."""
+    read: NotRequired[Nullable[VideoReadSettingsTypedDict]]
+    r"""Settings for reading and analyzing video content."""
+    embed: NotRequired[List[EmbeddingRequestTypedDict]]
+    r"""List of embedding settings for generating multiple embeddings. For now, if url is provided, value must be None.
+    Default: [{type: 'url', vector_index: 'multimodal'}] if none provided.
+    """
+    transcribe: NotRequired[Nullable[VideoTranscriptionSettingsTypedDict]]
+    r"""Settings for transcribing video audio."""
+    describe: NotRequired[Nullable[VideoDescribeSettingsTypedDict]]
+    r"""Settings for generating video descriptions."""
+    detect: NotRequired[Nullable[VideoDetectSettingsTypedDict]]
+    r"""Settings for object detection in video frames."""
+    json_output: NotRequired[Nullable[JSONVideoOutputSettingsTypedDict]]
+    r"""Settings for structured JSON output of video analysis."""
+
+
+class VideoSettings(BaseModel):
+    interval_sec: Optional[int] = 10
+    r"""Interval in seconds for processing video. Must be greater than or equal to 5, less than 120."""
+
+    read: OptionalNullable[VideoReadSettings] = UNSET
+    r"""Settings for reading and analyzing video content."""
+
+    embed: Optional[List[EmbeddingRequest]] = None
+    r"""List of embedding settings for generating multiple embeddings. For now, if url is provided, value must be None.
+    Default: [{type: 'url', vector_index: 'multimodal'}] if none provided.
+    """
+
+    transcribe: OptionalNullable[VideoTranscriptionSettings] = UNSET
+    r"""Settings for transcribing video audio."""
+
+    describe: OptionalNullable[VideoDescribeSettings] = UNSET
+    r"""Settings for generating video descriptions."""
+
+    detect: OptionalNullable[VideoDetectSettings] = UNSET
+    r"""Settings for object detection in video frames."""
+
+    json_output: OptionalNullable[JSONVideoOutputSettings] = UNSET
+    r"""Settings for structured JSON output of video analysis."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "interval_sec",
+            "read",
+            "embed",
+            "transcribe",
+            "describe",
+            "detect",
+            "json_output",
+        ]
+        nullable_fields = ["read", "transcribe", "describe", "detect", "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/videotranscriptionsettings.py

@@ -0,0 +1,69 @@
+"""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 VideoTranscriptionSettingsJSONOutputTypedDict(TypedDict):
+    r"""JSON format for the response"""
+
+
+class VideoTranscriptionSettingsJSONOutput(BaseModel):
+    r"""JSON format for the response"""
+
+
+class VideoTranscriptionSettingsTypedDict(TypedDict):
+    enabled: NotRequired[bool]
+    r"""Enable video transcription"""
+    prompt: NotRequired[Nullable[str]]
+    json_output: NotRequired[VideoTranscriptionSettingsJSONOutputTypedDict]
+    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 VideoTranscriptionSettings(BaseModel):
+    enabled: Optional[bool] = True
+    r"""Enable video transcription"""
+
+    prompt: OptionalNullable[str] = UNSET
+
+    json_output: Optional[VideoTranscriptionSettingsJSONOutput] = 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 = ["enabled", "prompt", "json_output", "vector_index"]
+        nullable_fields = ["prompt", "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