mixpeek 0.20.20__py3-none-any.whl → 0.21.6__py3-none-any.whl

mixpeek/models/search_model_searchquery.py

@@ -1,76 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .availablemodels import AvailableModels
-from .logicaloperator import LogicalOperator, LogicalOperatorTypedDict
-from .querysettings import QuerySettings, QuerySettingsTypedDict
-from enum import Enum
-from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
-from pydantic import model_serializer
-from typing_extensions import NotRequired, TypedDict
-
-
-class Type(str, Enum):
-    r"""Type of input (text, url, or base64)"""
-
-    TEXT = "text"
-    URL = "url"
-    BASE64 = "base64"
-
-
-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[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 SearchModelSearchQuery(BaseModel):
-    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: OptionalNullable[LogicalOperator] = UNSET
-    r"""Optional filters for the query, this is used for filtering individual vector indexes"""
-
-    settings: OptionalNullable[QuerySettings] = UNSET
-    r"""Optional settings for this specific query"""
-
-    @model_serializer(mode="wrap")
-    def serialize_model(self, handler):
-        optional_fields = ["filters", "settings"]
-        nullable_fields = ["filters", "settings"]
-        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/searchassetsrequest.py

@@ -1,78 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .assets_model_searchquery import (
-    AssetsModelSearchQuery,
-    AssetsModelSearchQueryTypedDict,
-)
-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
-from typing import List
-from typing_extensions import NotRequired, TypedDict
-
-
-class SearchAssetsRequestTypedDict(TypedDict):
-    collections: List[str]
-    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[LogicalOperatorTypedDict]]
-    r"""Complex nested query filters"""
-    sort: NotRequired[Nullable[SortOptionTypedDict]]
-    r"""List of fields to sort by"""
-    select: NotRequired[Nullable[List[str]]]
-    r"""List of fields to return in results"""
-    return_url: NotRequired[Nullable[bool]]
-    r"""Return the presigned URL for the asset and preview asset, this will introduce additional latency"""
-
-
-class SearchAssetsRequest(BaseModel):
-    collections: List[str]
-    r"""List of Collection IDs or Names to search within, required"""
-
-    query: OptionalNullable[AssetsModelSearchQuery] = UNSET
-    r"""Structured query object specifying which fields to search in and what to search for"""
-
-    filters: OptionalNullable[LogicalOperator] = UNSET
-    r"""Complex nested query filters"""
-
-    sort: OptionalNullable[SortOption] = UNSET
-    r"""List of fields to sort by"""
-
-    select: OptionalNullable[List[str]] = UNSET
-    r"""List of fields to return in results"""
-
-    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 = ["query", "filters", "sort", "select", "return_url"]
-        nullable_fields = ["query", "filters", "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/searchrequestfeatures.py

@@ -1,153 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .groupbyoptions import GroupByOptions, GroupByOptionsTypedDict
-from .logicaloperator import LogicalOperator, LogicalOperatorTypedDict
-from .rerankingoptions import RerankingOptions, RerankingOptionsTypedDict
-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
-from typing import List
-from typing_extensions import NotRequired, TypedDict
-
-
-class SearchRequestFeaturesTypedDict(TypedDict):
-    collections: List[str]
-    r"""List of Collection names to search within, required"""
-    queries: NotRequired[Nullable[List[SearchModelSearchQueryTypedDict]]]
-    r"""List of search queries to perform.
-
-    Behavior:
-    - Single query: Results are returned directly from that query
-    - Multiple queries: Results are combined using Reciprocal Rank Fusion (RRF)
-
-    RRF combines results from multiple queries by:
-    1. Taking each item's rank position in each result list
-    2. Re-ranking all items by their combined RRF scores
-
-    When merging lists from different sources,
-    RRF considers all items that appear in any of the input lists,
-    not just items that appear in all lists.
-
-    This helps surface items that rank well across multiple queries while
-    reducing the impact of outlier high rankings in single queries.
-
-    NOTE: If query array is empty, it will return all features.
-
-
-    """
-    filters: NotRequired[Nullable[LogicalOperatorTypedDict]]
-    r"""Used for filtering across all indexes"""
-    group_by: NotRequired[Nullable[GroupByOptionsTypedDict]]
-    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."""
-    reranking_options: NotRequired[Nullable[RerankingOptionsTypedDict]]
-    r"""Options for ranking the search results, including weights and feedback application"""
-    session_id: NotRequired[Nullable[str]]
-    r"""Identifier for tracking search session interactions"""
-    return_url: NotRequired[Nullable[bool]]
-    r"""Return the presigned URL for the asset and preview asset, this will introduce additional latency"""
-
-
-class SearchRequestFeatures(BaseModel):
-    collections: List[str]
-    r"""List of Collection names to search within, required"""
-
-    queries: OptionalNullable[List[SearchModelSearchQuery]] = UNSET
-    r"""List of search queries to perform.
-
-    Behavior:
-    - Single query: Results are returned directly from that query
-    - Multiple queries: Results are combined using Reciprocal Rank Fusion (RRF)
-
-    RRF combines results from multiple queries by:
-    1. Taking each item's rank position in each result list
-    2. Re-ranking all items by their combined RRF scores
-
-    When merging lists from different sources,
-    RRF considers all items that appear in any of the input lists,
-    not just items that appear in all lists.
-
-    This helps surface items that rank well across multiple queries while
-    reducing the impact of outlier high rankings in single queries.
-
-    NOTE: If query array is empty, it will return all features.
-
-
-    """
-
-    filters: OptionalNullable[LogicalOperator] = UNSET
-    r"""Used for filtering across all indexes"""
-
-    group_by: OptionalNullable[GroupByOptions] = 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."""
-
-    reranking_options: OptionalNullable[RerankingOptions] = UNSET
-    r"""Options for ranking the search results, including weights and feedback application"""
-
-    session_id: OptionalNullable[str] = UNSET
-    r"""Identifier for tracking search session interactions"""
-
-    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 = [
-            "queries",
-            "filters",
-            "group_by",
-            "sort",
-            "select",
-            "reranking_options",
-            "session_id",
-            "return_url",
-        ]
-        nullable_fields = [
-            "queries",
-            "filters",
-            "group_by",
-            "sort",
-            "select",
-            "reranking_options",
-            "session_id",
-            "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/sparseembedding.py

@@ -1,21 +0,0 @@
-"""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 SparseEmbeddingTypedDict(TypedDict):
-    indices: List[int]
-    r"""Indices for sparse vector"""
-    values: List[float]
-    r"""Values for sparse vector"""
-
-
-class SparseEmbedding(BaseModel):
-    indices: List[int]
-    r"""Indices for sparse vector"""
-
-    values: List[float]
-    r"""Values for sparse vector"""

mixpeek/models/taxonomycreate.py

@@ -1,20 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .taxonomynodecreate import TaxonomyNodeCreate, TaxonomyNodeCreateTypedDict
-from mixpeek.types import BaseModel
-from typing import List
-from typing_extensions import TypedDict
-
-
-class TaxonomyCreateTypedDict(TypedDict):
-    taxonomy_name: str
-    r"""Taxonomy name (must not contain spaces or special characters)"""
-    nodes: List[TaxonomyNodeCreateTypedDict]
-
-
-class TaxonomyCreate(BaseModel):
-    taxonomy_name: str
-    r"""Taxonomy name (must not contain spaces or special characters)"""
-
-    nodes: List[TaxonomyNodeCreate]

mixpeek/models/taxonomyextractionconfig.py

@@ -1,26 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .assignmentconfig import AssignmentConfig, AssignmentConfigTypedDict
-from mixpeek.types import BaseModel
-from typing import Optional
-from typing_extensions import NotRequired, TypedDict
-
-
-class TaxonomyExtractionConfigTypedDict(TypedDict):
-    r"""Configuration for taxonomy-based entity extraction during ingestion"""
-
-    taxonomy: str
-    r"""Taxonomy name or ID to use for classification"""
-    assignment: NotRequired[AssignmentConfigTypedDict]
-    r"""Configuration for how classifications should be assigned to features"""
-
-
-class TaxonomyExtractionConfig(BaseModel):
-    r"""Configuration for taxonomy-based entity extraction during ingestion"""
-
-    taxonomy: str
-    r"""Taxonomy name or ID to use for classification"""
-
-    assignment: Optional[AssignmentConfig] = None
-    r"""Configuration for how classifications should be assigned to features"""

mixpeek/models/taxonomymodel.py

@@ -1,27 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .taxonomynode import TaxonomyNode, TaxonomyNodeTypedDict
-from mixpeek.types import BaseModel
-from typing import List, Optional
-from typing_extensions import NotRequired, TypedDict
-
-
-class TaxonomyModelTypedDict(TypedDict):
-    taxonomy_name: str
-    r"""Taxonomy name"""
-    nodes: List[TaxonomyNodeTypedDict]
-    r"""Taxonomy nodes"""
-    taxonomy_id: NotRequired[str]
-    r"""Auto-generated taxonomy identifier"""
-
-
-class TaxonomyModel(BaseModel):
-    taxonomy_name: str
-    r"""Taxonomy name"""
-
-    nodes: List[TaxonomyNode]
-    r"""Taxonomy nodes"""
-
-    taxonomy_id: Optional[str] = None
-    r"""Auto-generated taxonomy identifier"""

mixpeek/models/taxonomynode.py

@@ -1,101 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .embeddingconfig import EmbeddingConfig, EmbeddingConfigTypedDict
-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 TaxonomyNodeTypedDict(TypedDict):
-    taxonomy_id: str
-    r"""ID of the taxonomy this node belongs to"""
-    node_name: str
-    r"""Name of the taxonomy node (must be lowercase without spaces)"""
-    embedding_configs: List[EmbeddingConfigTypedDict]
-    r"""List of embedding configurations defining how this node should be vectorized"""
-    node_id: NotRequired[str]
-    r"""Unique identifier for the taxonomy node"""
-    parent_node_id: NotRequired[Nullable[str]]
-    r"""ID of the parent node (None if root node)"""
-    node_description: NotRequired[Nullable[str]]
-    r"""Optional description of what this node represents"""
-    children: NotRequired[Nullable[List[TaxonomyNodeTypedDict]]]
-    r"""List of child nodes under this node"""
-    path_tokens: NotRequired[List[str]]
-    r"""List of node names representing the path from root to this node"""
-    order: NotRequired[List[int]]
-    r"""Order of the node in the taxonomy"""
-    depth: NotRequired[int]
-    r"""Depth of the node in the taxonomy"""
-
-
-class TaxonomyNode(BaseModel):
-    taxonomy_id: str
-    r"""ID of the taxonomy this node belongs to"""
-
-    node_name: str
-    r"""Name of the taxonomy node (must be lowercase without spaces)"""
-
-    embedding_configs: List[EmbeddingConfig]
-    r"""List of embedding configurations defining how this node should be vectorized"""
-
-    node_id: Optional[str] = None
-    r"""Unique identifier for the taxonomy node"""
-
-    parent_node_id: OptionalNullable[str] = UNSET
-    r"""ID of the parent node (None if root node)"""
-
-    node_description: OptionalNullable[str] = UNSET
-    r"""Optional description of what this node represents"""
-
-    children: OptionalNullable[List[TaxonomyNode]] = UNSET
-    r"""List of child nodes under this node"""
-
-    path_tokens: Optional[List[str]] = None
-    r"""List of node names representing the path from root to this node"""
-
-    order: Optional[List[int]] = None
-    r"""Order of the node in the taxonomy"""
-
-    depth: Optional[int] = 0
-    r"""Depth of the node in the taxonomy"""
-
-    @model_serializer(mode="wrap")
-    def serialize_model(self, handler):
-        optional_fields = [
-            "node_id",
-            "parent_node_id",
-            "node_description",
-            "children",
-            "path_tokens",
-            "order",
-            "depth",
-        ]
-        nullable_fields = ["parent_node_id", "node_description", "children"]
-        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/taxonomynodecreate.py

@@ -1,63 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .embeddingconfig import EmbeddingConfig, EmbeddingConfigTypedDict
-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 TaxonomyNodeCreateTypedDict(TypedDict):
-    node_name: str
-    r"""Name of the taxonomy node (must be lowercase without spaces)"""
-    embedding_configs: List[EmbeddingConfigTypedDict]
-    r"""List of embedding configurations defining how this node should be vectorized"""
-    node_description: NotRequired[Nullable[str]]
-    r"""Optional description of what this node represents"""
-    children: NotRequired[Nullable[List[TaxonomyNodeCreateTypedDict]]]
-    r"""List of child nodes under this node"""
-
-
-class TaxonomyNodeCreate(BaseModel):
-    node_name: str
-    r"""Name of the taxonomy node (must be lowercase without spaces)"""
-
-    embedding_configs: List[EmbeddingConfig]
-    r"""List of embedding configurations defining how this node should be vectorized"""
-
-    node_description: OptionalNullable[str] = UNSET
-    r"""Optional description of what this node represents"""
-
-    children: OptionalNullable[List[TaxonomyNodeCreate]] = UNSET
-    r"""List of child nodes under this node"""
-
-    @model_serializer(mode="wrap")
-    def serialize_model(self, handler):
-        optional_fields = ["node_description", "children"]
-        nullable_fields = ["node_description", "children"]
-        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/textsettings.py

@@ -1,67 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .embeddingrequest import EmbeddingRequest, EmbeddingRequestTypedDict
-from .entitysettings import EntitySettings, EntitySettingsTypedDict
-from .jsontextoutputsettings import (
-    JSONTextOutputSettings,
-    JSONTextOutputSettingsTypedDict,
-)
-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 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', 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', 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", "entities"]
-        nullable_fields = ["json_output", "entities"]
-        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