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

mixpeek/models/search_model_searchquery_input.py

@@ -0,0 +1,76 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .availablemodels import AvailableModels
+from .logicaloperator_input import LogicalOperatorInput, LogicalOperatorInputTypedDict
+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 SearchModelSearchQueryInputTypedDict(TypedDict):
+    vector_index: 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]]
+    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
+
+    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[LogicalOperatorInput] = 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

@@ -0,0 +1,78 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .assets_model_searchquery import (
+    AssetsModelSearchQuery,
+    AssetsModelSearchQueryTypedDict,
+)
+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 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[LogicalOperatorInputTypedDict]]
+    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[LogicalOperatorInput] = 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/searchinteraction.py

@@ -0,0 +1,82 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .interactiontype import InteractionType
+from .searchrequestfeatures_input import (
+    SearchRequestFeaturesInput,
+    SearchRequestFeaturesInputTypedDict,
+)
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class MetadataTypedDict(TypedDict):
+    pass
+
+
+class Metadata(BaseModel):
+    pass
+
+
+class SearchInteractionTypedDict(TypedDict):
+    feature_id: str
+    r"""ID of the item that was interacted with"""
+    interaction_type: InteractionType
+    search_request: NotRequired[Nullable[SearchRequestFeaturesInputTypedDict]]
+    r"""The search request that led to this interaction"""
+    position: NotRequired[Nullable[int]]
+    r"""Position in search results where interaction occurred"""
+    metadata: NotRequired[Nullable[MetadataTypedDict]]
+    r"""Additional context about the interaction"""
+    session_id: NotRequired[Nullable[str]]
+    r"""Search session identifier"""
+
+
+class SearchInteraction(BaseModel):
+    feature_id: str
+    r"""ID of the item that was interacted with"""
+
+    interaction_type: InteractionType
+
+    search_request: OptionalNullable[SearchRequestFeaturesInput] = UNSET
+    r"""The search request that led to this interaction"""
+
+    position: OptionalNullable[int] = UNSET
+    r"""Position in search results where interaction occurred"""
+
+    metadata: OptionalNullable[Metadata] = UNSET
+    r"""Additional context about the interaction"""
+
+    session_id: OptionalNullable[str] = UNSET
+    r"""Search session identifier"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["search_request", "position", "metadata", "session_id"]
+        nullable_fields = ["search_request", "position", "metadata", "session_id"]
+        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/searchquery_output.py

@@ -0,0 +1,79 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .availablemodels import AvailableModels
+from .logicaloperator_output import (
+    LogicalOperatorOutput,
+    LogicalOperatorOutputTypedDict,
+)
+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 SearchQueryOutputType(str, Enum):
+    r"""Type of input (text, url, or base64)"""
+
+    TEXT = "text"
+    URL = "url"
+    BASE64 = "base64"
+
+
+class SearchQueryOutputTypedDict(TypedDict):
+    vector_index: AvailableModels
+    value: str
+    r"""Query value - can be text, URL, or base64 encoded image"""
+    type: SearchQueryOutputType
+    r"""Type of input (text, url, or base64)"""
+    filters: NotRequired[Nullable[LogicalOperatorOutputTypedDict]]
+    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 SearchQueryOutput(BaseModel):
+    vector_index: AvailableModels
+
+    value: str
+    r"""Query value - can be text, URL, or base64 encoded image"""
+
+    type: SearchQueryOutputType
+    r"""Type of input (text, url, or base64)"""
+
+    filters: OptionalNullable[LogicalOperatorOutput] = 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/searchrequestfeatures_input.py

@@ -0,0 +1,151 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .groupbyoptions import GroupByOptions, GroupByOptionsTypedDict
+from .logicaloperator_input import LogicalOperatorInput, LogicalOperatorInputTypedDict
+from .rerankingoptions import RerankingOptions, RerankingOptionsTypedDict
+from .search_model_searchquery_input import (
+    SearchModelSearchQueryInput,
+    SearchModelSearchQueryInputTypedDict,
+)
+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 SearchRequestFeaturesInputTypedDict(TypedDict):
+    queries: List[SearchModelSearchQueryInputTypedDict]
+    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.
+
+
+    """
+    collections: List[str]
+    r"""List of Collection names to search within, required"""
+    filters: NotRequired[Nullable[LogicalOperatorInputTypedDict]]
+    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 SearchRequestFeaturesInput(BaseModel):
+    queries: List[SearchModelSearchQueryInput]
+    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.
+
+
+    """
+
+    collections: List[str]
+    r"""List of Collection names to search within, required"""
+
+    filters: OptionalNullable[LogicalOperatorInput] = 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 = [
+            "filters",
+            "group_by",
+            "sort",
+            "select",
+            "reranking_options",
+            "session_id",
+            "return_url",
+        ]
+        nullable_fields = [
+            "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/searchrequestfeatures_output.py

@@ -0,0 +1,151 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .groupbyoptions import GroupByOptions, GroupByOptionsTypedDict
+from .logicaloperator_output import (
+    LogicalOperatorOutput,
+    LogicalOperatorOutputTypedDict,
+)
+from .rerankingoptions import RerankingOptions, RerankingOptionsTypedDict
+from .searchquery_output import SearchQueryOutput, SearchQueryOutputTypedDict
+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 SearchRequestFeaturesOutputTypedDict(TypedDict):
+    queries: List[SearchQueryOutputTypedDict]
+    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.
+
+
+    """
+    collections: List[str]
+    r"""List of Collection names to search within, required"""
+    filters: NotRequired[Nullable[LogicalOperatorOutputTypedDict]]
+    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 SearchRequestFeaturesOutput(BaseModel):
+    queries: List[SearchQueryOutput]
+    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.
+
+
+    """
+
+    collections: List[str]
+    r"""List of Collection names to search within, required"""
+
+    filters: OptionalNullable[LogicalOperatorOutput] = 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 = [
+            "filters",
+            "group_by",
+            "sort",
+            "select",
+            "reranking_options",
+            "session_id",
+            "return_url",
+        ]
+        nullable_fields = [
+            "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/sortoption.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+from mixpeek.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class Direction(str, Enum):
+    r"""Sort direction"""
+
+    ASC = "asc"
+    DESC = "desc"
+
+
+class SortOptionTypedDict(TypedDict):
+    field: str
+    r"""Field to sort by, supports dot notation for nested fields"""
+    direction: Direction
+    r"""Sort direction"""
+
+
+class SortOption(BaseModel):
+    field: str
+    r"""Field to sort by, supports dot notation for nested fields"""
+
+    direction: Direction
+    r"""Sort direction"""

mixpeek/models/sparseembedding.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 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"""