mixpeek 0.15.0__py3-none-any.whl → 0.15.2__py3-none-any.whl

mixpeek/models/{logicaloperator_input.py → logicaloperator.py}

@@ -9,7 +9,7 @@ from typing import List, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
-class LogicalOperatorInputTypedDict(TypedDict):
+class LogicalOperatorTypedDict(TypedDict):
     case_sensitive: NotRequired[Nullable[bool]]
     r"""Whether to perform case-sensitive matching"""
     and_: NotRequired[Nullable[List[AndTypedDict]]]
@@ -20,7 +20,7 @@ class LogicalOperatorInputTypedDict(TypedDict):
     r"""Logical NOR operation"""
 
 
-class LogicalOperatorInput(BaseModel):
+class LogicalOperator(BaseModel):
     case_sensitive: OptionalNullable[bool] = UNSET
     r"""Whether to perform case-sensitive matching"""
 
@@ -65,24 +65,24 @@ class LogicalOperatorInput(BaseModel):
 
 
 AndTypedDict = TypeAliasType(
-    "AndTypedDict", Union[FilterConditionTypedDict, LogicalOperatorInputTypedDict]
+    "AndTypedDict", Union[FilterConditionTypedDict, LogicalOperatorTypedDict]
 )
 
 
-And = TypeAliasType("And", Union[FilterCondition, LogicalOperatorInput])
+And = TypeAliasType("And", Union[FilterCondition, LogicalOperator])
 
 
 OrTypedDict = TypeAliasType(
-    "OrTypedDict", Union[FilterConditionTypedDict, LogicalOperatorInputTypedDict]
+    "OrTypedDict", Union[FilterConditionTypedDict, LogicalOperatorTypedDict]
 )
 
 
-Or = TypeAliasType("Or", Union[FilterCondition, LogicalOperatorInput])
+Or = TypeAliasType("Or", Union[FilterCondition, LogicalOperator])
 
 
 NorTypedDict = TypeAliasType(
-    "NorTypedDict", Union[FilterConditionTypedDict, LogicalOperatorInputTypedDict]
+    "NorTypedDict", Union[FilterConditionTypedDict, LogicalOperatorTypedDict]
 )
 
 
-Nor = TypeAliasType("Nor", Union[FilterCondition, LogicalOperatorInput])
+Nor = TypeAliasType("Nor", Union[FilterCondition, LogicalOperator])

mixpeek/models/namespaceresponse.py

@@ -10,7 +10,7 @@ from typing_extensions import TypedDict
 class NamespaceResponseTypedDict(TypedDict):
     namespace_id: str
     namespace_name: str
-    vector_indexes: List[str]
+    embedding_models: List[str]
     payload_indexes: Nullable[List[Any]]
 
 
@@ -19,7 +19,7 @@ class NamespaceResponse(BaseModel):
 
     namespace_name: str
 
-    vector_indexes: List[str]
+    embedding_models: List[str]
 
     payload_indexes: Nullable[List[Any]]
 

mixpeek/models/processimageurlinput.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 from .assetupdate import AssetUpdate, AssetUpdateTypedDict
 from .imagesettings import ImageSettings, ImageSettingsTypedDict
-from .percolaterequest import PercolateRequest, PercolateRequestTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
 from typing import Optional
@@ -27,8 +26,6 @@ class ProcessImageURLInputTypedDict(TypedDict):
     r"""Controls how processing results are stored - either creating a new asset or updating an existing one."""
     metadata: NotRequired[ProcessImageURLInputMetadataTypedDict]
     r"""Additional metadata associated with the asset. Can include any key-value pairs relevant to the asset."""
-    percolate: NotRequired[Nullable[PercolateRequestTypedDict]]
-    r"""Settings for percolating the asset against stored queries."""
     skip_duplicate: NotRequired[Nullable[bool]]
     r"""Makes feature extraction idempotent. When True and a duplicate file hash is found, copies features from the existing asset instead of reprocessing. This allows the same file to be used multiple times with different metadata while avoiding redundant processing."""
     feature_extractors: NotRequired[Nullable[ImageSettingsTypedDict]]
@@ -48,9 +45,6 @@ class ProcessImageURLInput(BaseModel):
     metadata: Optional[ProcessImageURLInputMetadata] = None
     r"""Additional metadata associated with the asset. Can include any key-value pairs relevant to the asset."""
 
-    percolate: OptionalNullable[PercolateRequest] = UNSET
-    r"""Settings for percolating the asset against stored queries."""
-
     skip_duplicate: OptionalNullable[bool] = UNSET
     r"""Makes feature extraction idempotent. When True and a duplicate file hash is found, copies features from the existing asset instead of reprocessing. This allows the same file to be used multiple times with different metadata while avoiding redundant processing."""
 
@@ -62,16 +56,10 @@ class ProcessImageURLInput(BaseModel):
         optional_fields = [
             "asset_update",
             "metadata",
-            "percolate",
-            "skip_duplicate",
-            "feature_extractors",
-        ]
-        nullable_fields = [
-            "asset_update",
-            "percolate",
             "skip_duplicate",
             "feature_extractors",
         ]
+        nullable_fields = ["asset_update", "skip_duplicate", "feature_extractors"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/processtextinput.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 from .assetupdate import AssetUpdate, AssetUpdateTypedDict
-from .percolaterequest import PercolateRequest, PercolateRequestTypedDict
 from .textsettings import TextSettings, TextSettingsTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
@@ -27,8 +26,6 @@ class ProcessTextInputTypedDict(TypedDict):
     r"""Additional metadata associated with the file. Can include any key-value pairs relevant to the file."""
     feature_extractors: NotRequired[Nullable[TextSettingsTypedDict]]
     r"""Settings for text processing."""
-    percolate: NotRequired[Nullable[PercolateRequestTypedDict]]
-    r"""Settings for percolating the asset against stored queries."""
     skip_duplicate: NotRequired[Nullable[bool]]
     r"""Skips processing when a duplicate hash is found and stores an error by the task_id with the existing asset_id"""
 
@@ -46,9 +43,6 @@ class ProcessTextInput(BaseModel):
     feature_extractors: OptionalNullable[TextSettings] = UNSET
     r"""Settings for text processing."""
 
-    percolate: OptionalNullable[PercolateRequest] = UNSET
-    r"""Settings for percolating the asset against stored queries."""
-
     skip_duplicate: OptionalNullable[bool] = UNSET
     r"""Skips processing when a duplicate hash is found and stores an error by the task_id with the existing asset_id"""
 
@@ -58,15 +52,9 @@ class ProcessTextInput(BaseModel):
             "asset_update",
             "metadata",
             "feature_extractors",
-            "percolate",
-            "skip_duplicate",
-        ]
-        nullable_fields = [
-            "asset_update",
-            "feature_extractors",
-            "percolate",
             "skip_duplicate",
         ]
+        nullable_fields = ["asset_update", "feature_extractors", "skip_duplicate"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/processvideourlinput.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 from .assetupdate import AssetUpdate, AssetUpdateTypedDict
-from .percolaterequest import PercolateRequest, PercolateRequestTypedDict
 from .videosettings import VideoSettings, VideoSettingsTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
@@ -27,8 +26,6 @@ class ProcessVideoURLInputTypedDict(TypedDict):
     r"""Controls how processing results are stored - either creating a new asset or updating an existing one."""
     metadata: NotRequired[ProcessVideoURLInputMetadataTypedDict]
     r"""Additional metadata associated with the asset. Can include any key-value pairs relevant to the asset."""
-    percolate: NotRequired[Nullable[PercolateRequestTypedDict]]
-    r"""Settings for percolating the asset against stored queries."""
     skip_duplicate: NotRequired[Nullable[bool]]
     r"""Makes feature extraction idempotent. When True and a duplicate file hash is found, copies features from the existing asset instead of reprocessing. This allows the same file to be used multiple times with different metadata while avoiding redundant processing."""
     feature_extractors: NotRequired[Nullable[List[VideoSettingsTypedDict]]]
@@ -48,9 +45,6 @@ class ProcessVideoURLInput(BaseModel):
     metadata: Optional[ProcessVideoURLInputMetadata] = None
     r"""Additional metadata associated with the asset. Can include any key-value pairs relevant to the asset."""
 
-    percolate: OptionalNullable[PercolateRequest] = UNSET
-    r"""Settings for percolating the asset against stored queries."""
-
     skip_duplicate: OptionalNullable[bool] = UNSET
     r"""Makes feature extraction idempotent. When True and a duplicate file hash is found, copies features from the existing asset instead of reprocessing. This allows the same file to be used multiple times with different metadata while avoiding redundant processing."""
 
@@ -62,16 +56,10 @@ class ProcessVideoURLInput(BaseModel):
         optional_fields = [
             "asset_update",
             "metadata",
-            "percolate",
-            "skip_duplicate",
-            "feature_extractors",
-        ]
-        nullable_fields = [
-            "asset_update",
-            "percolate",
             "skip_duplicate",
             "feature_extractors",
         ]
+        nullable_fields = ["asset_update", "skip_duplicate", "feature_extractors"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/search_features_features_search_postop.py

@@ -1,10 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .searchrequestfeatures_input import (
-    SearchRequestFeaturesInput,
-    SearchRequestFeaturesInputTypedDict,
-)
+from .searchrequestfeatures import SearchRequestFeatures, SearchRequestFeaturesTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -19,7 +16,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class SearchFeaturesFeaturesSearchPostRequestTypedDict(TypedDict):
-    search_request_features_input: SearchRequestFeaturesInputTypedDict
+    search_request_features: SearchRequestFeaturesTypedDict
     offset_position: NotRequired[Nullable[int]]
     r"""The position to start returning results from. Used for pagination. Does not work with group_by"""
     page_size: NotRequired[int]
@@ -29,8 +26,8 @@ class SearchFeaturesFeaturesSearchPostRequestTypedDict(TypedDict):
 
 
 class SearchFeaturesFeaturesSearchPostRequest(BaseModel):
-    search_request_features_input: Annotated[
-        SearchRequestFeaturesInput,
+    search_request_features: Annotated[
+        SearchRequestFeatures,
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
 

mixpeek/models/{search_model_searchquery_input.py → search_model_searchquery.py}

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 from .availablemodels import AvailableModels
-from .logicaloperator_input import LogicalOperatorInput, LogicalOperatorInputTypedDict
+from .logicaloperator import LogicalOperator, LogicalOperatorTypedDict
 from .querysettings import QuerySettings, QuerySettingsTypedDict
 from enum import Enum
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
@@ -18,20 +18,20 @@ class Type(str, Enum):
     BASE64 = "base64"
 
 
-class SearchModelSearchQueryInputTypedDict(TypedDict):
-    vector_index: AvailableModels
+class SearchModelSearchQueryTypedDict(TypedDict):
+    embedding_model: AvailableModels
     value: str
     r"""Query value - can be text, URL, or base64 encoded image"""
     type: Type
     r"""Type of input (text, url, or base64)"""
-    filters: NotRequired[Nullable[LogicalOperatorInputTypedDict]]
+    filters: NotRequired[Nullable[LogicalOperatorTypedDict]]
     r"""Optional filters for the query, this is used for filtering individual vector indexes"""
     settings: NotRequired[Nullable[QuerySettingsTypedDict]]
     r"""Optional settings for this specific query"""
 
 
-class SearchModelSearchQueryInput(BaseModel):
-    vector_index: AvailableModels
+class SearchModelSearchQuery(BaseModel):
+    embedding_model: AvailableModels
 
     value: str
     r"""Query value - can be text, URL, or base64 encoded image"""
@@ -39,7 +39,7 @@ class SearchModelSearchQueryInput(BaseModel):
     type: Type
     r"""Type of input (text, url, or base64)"""
 
-    filters: OptionalNullable[LogicalOperatorInput] = UNSET
+    filters: OptionalNullable[LogicalOperator] = UNSET
     r"""Optional filters for the query, this is used for filtering individual vector indexes"""
 
     settings: OptionalNullable[QuerySettings] = UNSET

mixpeek/models/searchassetsrequest.py

@@ -5,7 +5,7 @@ from .assets_model_searchquery import (
     AssetsModelSearchQuery,
     AssetsModelSearchQueryTypedDict,
 )
-from .logicaloperator_input import LogicalOperatorInput, LogicalOperatorInputTypedDict
+from .logicaloperator import LogicalOperator, LogicalOperatorTypedDict
 from .sortoption import SortOption, SortOptionTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
@@ -18,7 +18,7 @@ class SearchAssetsRequestTypedDict(TypedDict):
     r"""List of Collection IDs or Names to search within, required"""
     query: NotRequired[Nullable[AssetsModelSearchQueryTypedDict]]
     r"""Structured query object specifying which fields to search in and what to search for"""
-    filters: NotRequired[Nullable[LogicalOperatorInputTypedDict]]
+    filters: NotRequired[Nullable[LogicalOperatorTypedDict]]
     r"""Complex nested query filters"""
     sort: NotRequired[Nullable[SortOptionTypedDict]]
     r"""List of fields to sort by"""
@@ -35,7 +35,7 @@ class SearchAssetsRequest(BaseModel):
     query: OptionalNullable[AssetsModelSearchQuery] = UNSET
     r"""Structured query object specifying which fields to search in and what to search for"""
 
-    filters: OptionalNullable[LogicalOperatorInput] = UNSET
+    filters: OptionalNullable[LogicalOperator] = UNSET
     r"""Complex nested query filters"""
 
     sort: OptionalNullable[SortOption] = UNSET

mixpeek/models/{searchrequestfeatures_output.py → searchrequestfeatures.py}

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 from .groupbyoptions import GroupByOptions, GroupByOptionsTypedDict
-from .logicaloperator_output import (
-    LogicalOperatorOutput,
-    LogicalOperatorOutputTypedDict,
-)
+from .logicaloperator import LogicalOperator, LogicalOperatorTypedDict
 from .rerankingoptions import RerankingOptions, RerankingOptionsTypedDict
-from .searchquery_output import SearchQueryOutput, SearchQueryOutputTypedDict
+from .search_model_searchquery import (
+    SearchModelSearchQuery,
+    SearchModelSearchQueryTypedDict,
+)
 from .sortoption import SortOption, SortOptionTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
@@ -15,8 +15,8 @@ from typing import List
 from typing_extensions import NotRequired, TypedDict
 
 
-class SearchRequestFeaturesOutputTypedDict(TypedDict):
-    queries: List[SearchQueryOutputTypedDict]
+class SearchRequestFeaturesTypedDict(TypedDict):
+    queries: List[SearchModelSearchQueryTypedDict]
     r"""List of search queries to perform.
 
     Behavior:
@@ -40,7 +40,7 @@ class SearchRequestFeaturesOutputTypedDict(TypedDict):
     """
     collections: List[str]
     r"""List of Collection names to search within, required"""
-    filters: NotRequired[Nullable[LogicalOperatorOutputTypedDict]]
+    filters: NotRequired[Nullable[LogicalOperatorTypedDict]]
     r"""Used for filtering across all indexes"""
     group_by: NotRequired[Nullable[GroupByOptionsTypedDict]]
     r"""Grouping options for search results"""
@@ -56,8 +56,8 @@ class SearchRequestFeaturesOutputTypedDict(TypedDict):
     r"""Return the presigned URL for the asset and preview asset, this will introduce additional latency"""
 
 
-class SearchRequestFeaturesOutput(BaseModel):
-    queries: List[SearchQueryOutput]
+class SearchRequestFeatures(BaseModel):
+    queries: List[SearchModelSearchQuery]
     r"""List of search queries to perform.
 
     Behavior:
@@ -83,7 +83,7 @@ class SearchRequestFeaturesOutput(BaseModel):
     collections: List[str]
     r"""List of Collection names to search within, required"""
 
-    filters: OptionalNullable[LogicalOperatorOutput] = UNSET
+    filters: OptionalNullable[LogicalOperator] = UNSET
     r"""Used for filtering across all indexes"""
 
     group_by: OptionalNullable[GroupByOptions] = UNSET

mixpeek/models/{percolaterequest.py → taskresponse.py}

@@ -1,35 +1,33 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .taskstatus import TaskStatus
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing import Optional
+from typing import Any, List, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-class PercolateRequestTypedDict(TypedDict):
-    enabled: NotRequired[bool]
-    r"""Whether to enable percolator matching for this request"""
-    min_score: NotRequired[Nullable[float]]
-    r"""Minimum similarity score (0-1) required for a match. Higher values mean stricter matching."""
-    max_candidates: NotRequired[Nullable[int]]
-    r"""Maximum number of matching percolators to return in the response"""
+class TaskResponseTypedDict(TypedDict):
+    task_id: str
+    status: NotRequired[TaskStatus]
+    inputs: NotRequired[Nullable[List[Any]]]
+    outputs: NotRequired[Nullable[List[Any]]]
 
 
-class PercolateRequest(BaseModel):
-    enabled: Optional[bool] = True
-    r"""Whether to enable percolator matching for this request"""
+class TaskResponse(BaseModel):
+    task_id: str
 
-    min_score: OptionalNullable[float] = UNSET
-    r"""Minimum similarity score (0-1) required for a match. Higher values mean stricter matching."""
+    status: Optional[TaskStatus] = None
 
-    max_candidates: OptionalNullable[int] = UNSET
-    r"""Maximum number of matching percolators to return in the response"""
+    inputs: OptionalNullable[List[Any]] = UNSET
+
+    outputs: OptionalNullable[List[Any]] = UNSET
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["enabled", "min_score", "max_candidates"]
-        nullable_fields = ["min_score", "max_candidates"]
+        optional_fields = ["status", "inputs", "outputs"]
+        nullable_fields = ["inputs", "outputs"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/taskstatus.py

@@ -14,3 +14,4 @@ class TaskStatus(str, Enum):
     INITIALIZING = "INITIALIZING"
     UPLOADING = "UPLOADING"
     QUEUED = "QUEUED"
+    PENDING = "PENDING"

mixpeek/models/taxonomyextractionconfig.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .availablemodels import AvailableModels
+from mixpeek.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class TaxonomyExtractionConfigTypedDict(TypedDict):
+    r"""Configuration for taxonomy-based entity extraction during ingestion"""
+
+    taxonomy_ids: List[str]
+    r"""List of taxonomy IDs to use for classification"""
+    embedding_models: List[AvailableModels]
+    r"""Vector indexes to use for classification"""
+    confidence_threshold: NotRequired[float]
+    r"""Minimum confidence score required for classification"""
+
+
+class TaxonomyExtractionConfig(BaseModel):
+    r"""Configuration for taxonomy-based entity extraction during ingestion"""
+
+    taxonomy_ids: List[str]
+    r"""List of taxonomy IDs to use for classification"""
+
+    embedding_models: List[AvailableModels]
+    r"""Vector indexes to use for classification"""
+
+    confidence_threshold: Optional[float] = 0.8
+    r"""Minimum confidence score required for classification"""

mixpeek/models/textsettings.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 from .embeddingrequest import EmbeddingRequest, EmbeddingRequestTypedDict
+from .entitysettings import EntitySettings, EntitySettingsTypedDict
 from .jsontextoutputsettings import (
     JSONTextOutputSettings,
     JSONTextOutputSettingsTypedDict,
@@ -15,25 +16,30 @@ 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.
+    Default: [{type: 'text', embedding_model: 'multimodal'}] if none provided.
     """
     json_output: NotRequired[Nullable[JSONTextOutputSettingsTypedDict]]
     r"""Settings for structured JSON output of text analysis."""
+    entities: NotRequired[Nullable[EntitySettingsTypedDict]]
+    r"""Settings for extracting entities from text content"""
 
 
 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.
+    Default: [{type: 'text', embedding_model: 'multimodal'}] if none provided.
     """
 
     json_output: OptionalNullable[JSONTextOutputSettings] = UNSET
     r"""Settings for structured JSON output of text analysis."""
 
+    entities: OptionalNullable[EntitySettings] = UNSET
+    r"""Settings for extracting entities from text content"""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["embed", "json_output"]
-        nullable_fields = ["json_output"]
+        optional_fields = ["embed", "json_output", "entities"]
+        nullable_fields = ["json_output", "entities"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/vectormodel.py

@@ -6,6 +6,10 @@ from enum import Enum
 
 class VectorModel(str, Enum):
     IMAGE = "image"
+    OPENAI_CLIP_VIT_BASE_PATCH32 = "openai-clip-vit-base-patch32"
     MULTIMODAL = "multimodal"
+    VERTEX_MULTIMODAL = "vertex-multimodal"
     TEXT = "text"
+    BAAI_BGE_M3 = "baai-bge-m3"
     KEYWORD = "keyword"
+    NAVER_SPLADE_V3 = "naver-splade-v3"

mixpeek/models/videodescribesettings.py

@@ -25,8 +25,8 @@ class VideoDescribeSettingsTypedDict(TypedDict):
     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."""
+    embedding_model: NotRequired[Nullable[VectorModel]]
+    r"""Name of the vector model to use for embedding the text output. If embedding_model is duplicated, the vector will be overwritten."""
 
 
 class VideoDescribeSettings(BaseModel):
@@ -42,8 +42,8 @@ class VideoDescribeSettings(BaseModel):
     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."""
+    embedding_model: OptionalNullable[VectorModel] = UNSET
+    r"""Name of the vector model to use for embedding the text output. If embedding_model is duplicated, the vector will be overwritten."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
@@ -52,9 +52,9 @@ class VideoDescribeSettings(BaseModel):
             "enabled",
             "max_length",
             "json_output",
-            "vector_index",
+            "embedding_model",
         ]
-        nullable_fields = ["prompt", "max_length", "vector_index"]
+        nullable_fields = ["prompt", "max_length", "embedding_model"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/videoreadsettings.py

@@ -23,8 +23,8 @@ class VideoReadSettingsTypedDict(TypedDict):
     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."""
+    embedding_model: NotRequired[Nullable[VectorModel]]
+    r"""Name of the vector model to use for embedding the text output. If embedding_model is duplicated, the vector will be overwritten."""
 
 
 class VideoReadSettings(BaseModel):
@@ -37,13 +37,13 @@ class VideoReadSettings(BaseModel):
     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."""
+    embedding_model: OptionalNullable[VectorModel] = UNSET
+    r"""Name of the vector model to use for embedding the text output. If embedding_model 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"]
+        optional_fields = ["enabled", "prompt", "json_output", "embedding_model"]
+        nullable_fields = ["prompt", "embedding_model"]
         null_default_fields = []
 
         serialized = handler(self)

mixpeek/models/videosettings.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 from .embeddingrequest import EmbeddingRequest, EmbeddingRequestTypedDict
+from .entitysettings import EntitySettings, EntitySettingsTypedDict
 from .jsonvideooutputsettings import (
     JSONVideoOutputSettings,
     JSONVideoOutputSettingsTypedDict,
@@ -26,7 +27,7 @@ class VideoSettingsTypedDict(TypedDict):
     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.
+    Default: [{type: 'url', embedding_model: 'multimodal'}] if none provided.
     """
     transcribe: NotRequired[Nullable[VideoTranscriptionSettingsTypedDict]]
     r"""Settings for transcribing video audio."""
@@ -36,6 +37,8 @@ class VideoSettingsTypedDict(TypedDict):
     r"""Settings for object detection in video frames."""
     json_output: NotRequired[Nullable[JSONVideoOutputSettingsTypedDict]]
     r"""Settings for structured JSON output of video analysis."""
+    entities: NotRequired[Nullable[EntitySettingsTypedDict]]
+    r"""Settings for extracting entities from video content"""
 
 
 class VideoSettings(BaseModel):
@@ -47,7 +50,7 @@ class VideoSettings(BaseModel):
 
     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.
+    Default: [{type: 'url', embedding_model: 'multimodal'}] if none provided.
     """
 
     transcribe: OptionalNullable[VideoTranscriptionSettings] = UNSET
@@ -62,6 +65,9 @@ class VideoSettings(BaseModel):
     json_output: OptionalNullable[JSONVideoOutputSettings] = UNSET
     r"""Settings for structured JSON output of video analysis."""
 
+    entities: OptionalNullable[EntitySettings] = UNSET
+    r"""Settings for extracting entities from video content"""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -72,8 +78,16 @@ class VideoSettings(BaseModel):
             "describe",
             "detect",
             "json_output",
+            "entities",
+        ]
+        nullable_fields = [
+            "read",
+            "transcribe",
+            "describe",
+            "detect",
+            "json_output",
+            "entities",
         ]
-        nullable_fields = ["read", "transcribe", "describe", "detect", "json_output"]
         null_default_fields = []
 
         serialized = handler(self)