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

mixpeek/models/interactionresponse.py

@@ -0,0 +1,86 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .interactiontype import InteractionType
+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 InteractionResponseMetadataTypedDict(TypedDict):
+    pass
+
+
+class InteractionResponseMetadata(BaseModel):
+    pass
+
+
+class InteractionResponseTypedDict(TypedDict):
+    feature_id: str
+    r"""ID of the item that was interacted with"""
+    interaction_type: List[InteractionType]
+    r"""Type of interaction or feedback"""
+    interaction_id: str
+    r"""Unique identifier for this interaction"""
+    position: NotRequired[Nullable[int]]
+    r"""Position in search results where interaction occurred"""
+    metadata: NotRequired[Nullable[InteractionResponseMetadataTypedDict]]
+    r"""Additional context about the interaction"""
+    user_id: NotRequired[Nullable[str]]
+    r"""Customer's authenticated user identifier - persists across sessions"""
+    session_id: NotRequired[Nullable[str]]
+    r"""Temporary identifier for a single search journey/session (typically 30min-1hr) - tracks anonymous and authenticated users"""
+
+
+class InteractionResponse(BaseModel):
+    feature_id: str
+    r"""ID of the item that was interacted with"""
+
+    interaction_type: List[InteractionType]
+    r"""Type of interaction or feedback"""
+
+    interaction_id: str
+    r"""Unique identifier for this interaction"""
+
+    position: OptionalNullable[int] = UNSET
+    r"""Position in search results where interaction occurred"""
+
+    metadata: OptionalNullable[InteractionResponseMetadata] = UNSET
+    r"""Additional context about the interaction"""
+
+    user_id: OptionalNullable[str] = UNSET
+    r"""Customer's authenticated user identifier - persists across sessions"""
+
+    session_id: OptionalNullable[str] = UNSET
+    r"""Temporary identifier for a single search journey/session (typically 30min-1hr) - tracks anonymous and authenticated users"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["position", "metadata", "user_id", "session_id"]
+        nullable_fields = ["position", "metadata", "user_id", "session_id"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(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/interactiontype.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class InteractionType(str, Enum):
+    VIEW = "view"
+    CLICK = "click"
+    POSITIVE_FEEDBACK = "positive_feedback"
+    NEGATIVE_FEEDBACK = "negative_feedback"
+    PURCHASE = "purchase"
+    ADD_TO_CART = "add_to_cart"
+    WISHLIST = "wishlist"
+    LONG_VIEW = "long_view"
+    SHARE = "share"
+    BOOKMARK = "bookmark"
+    QUERY_REFINEMENT = "query_refinement"
+    ZERO_RESULTS = "zero_results"
+    FILTER_TOGGLE = "filter_toggle"
+    SKIP = "skip"
+    RETURN_TO_RESULTS = "return_to_results"

mixpeek/models/{search_features_v1_features_search_postop.py → invalidate_cache_v1_collections_cache_invalidate_postop.py}

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .searchrequestfeatures import SearchRequestFeatures, SearchRequestFeaturesTypedDict
+from .recomputestrategy import RecomputeStrategy
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -11,37 +11,57 @@ from mixpeek.utils import (
 )
 import pydantic
 from pydantic import model_serializer
-from typing import Optional
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class SearchFeaturesV1FeaturesSearchPostRequestTypedDict(TypedDict):
-    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]
-    r"""Number of results to return per page."""
+class InvalidateCacheV1CollectionsCacheInvalidatePostRequestTypedDict(TypedDict):
+    collection_id: str
+    action: str
+    internal_id: str
+    retriever_id: NotRequired[Nullable[str]]
+    recompute_strategy: NotRequired[RecomputeStrategy]
+    r"""Strategies for recomputing cache entries"""
+    redis_url: NotRequired[Nullable[str]]
+    prefix: NotRequired[Nullable[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."""
+    request_body: NotRequired[Nullable[List[str]]]
 
 
-class SearchFeaturesV1FeaturesSearchPostRequest(BaseModel):
-    search_request_features: Annotated[
-        SearchRequestFeatures,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+class InvalidateCacheV1CollectionsCacheInvalidatePostRequest(BaseModel):
+    collection_id: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+
+    action: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
     ]
 
-    offset_position: Annotated[
-        OptionalNullable[int],
+    internal_id: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+
+    retriever_id: Annotated[
+        OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
-    r"""The position to start returning results from. Used for pagination. Does not work with group_by"""
 
-    page_size: Annotated[
-        Optional[int],
+    recompute_strategy: Annotated[
+        Optional[RecomputeStrategy],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = 10
-    r"""Number of results to return per page."""
+    ] = None
+    r"""Strategies for recomputing cache entries"""
+
+    redis_url: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    prefix: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
 
     x_namespace: Annotated[
         OptionalNullable[str],
@@ -50,17 +70,35 @@ class SearchFeaturesV1FeaturesSearchPostRequest(BaseModel):
     ] = 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."""
 
+    request_body: Annotated[
+        OptionalNullable[List[str]],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["offset_position", "page_size", "X-Namespace"]
-        nullable_fields = ["offset_position", "X-Namespace"]
+        optional_fields = [
+            "retriever_id",
+            "recompute_strategy",
+            "redis_url",
+            "prefix",
+            "X-Namespace",
+            "RequestBody",
+        ]
+        nullable_fields = [
+            "retriever_id",
+            "redis_url",
+            "prefix",
+            "X-Namespace",
+            "RequestBody",
+        ]
         null_default_fields = []
 
         serialized = handler(self)
 
         m = {}
 
-        for n, f in self.model_fields.items():
+        for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
             serialized.pop(k, None)
@@ -79,15 +117,3 @@ class SearchFeaturesV1FeaturesSearchPostRequest(BaseModel):
                 m[k] = val
 
         return m
-
-
-class SearchFeaturesV1FeaturesSearchPostResponseSearchFeaturesV1FeaturesSearchPostTypedDict(
-    TypedDict
-):
-    r"""Successful Response"""
-
-
-class SearchFeaturesV1FeaturesSearchPostResponseSearchFeaturesV1FeaturesSearchPost(
-    BaseModel
-):
-    r"""Successful Response"""

mixpeek/models/invalidationevent.py

@@ -0,0 +1,67 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .recomputestrategy import RecomputeStrategy
+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 InvalidationEventTypedDict(TypedDict):
+    r"""Event that triggers cache invalidation"""
+
+    collection: str
+    r"""Collection ID to monitor"""
+    action: str
+    r"""Action that triggers invalidation (create, update, delete)"""
+    recompute_strategy: NotRequired[RecomputeStrategy]
+    r"""Strategies for recomputing cache entries"""
+    retriever_id: NotRequired[Nullable[str]]
+    r"""Optional retriever ID for retriever-specific invalidation"""
+
+
+class InvalidationEvent(BaseModel):
+    r"""Event that triggers cache invalidation"""
+
+    collection: str
+    r"""Collection ID to monitor"""
+
+    action: str
+    r"""Action that triggers invalidation (create, update, delete)"""
+
+    recompute_strategy: Optional[RecomputeStrategy] = None
+    r"""Strategies for recomputing cache entries"""
+
+    retriever_id: OptionalNullable[str] = UNSET
+    r"""Optional retriever ID for retriever-specific invalidation"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["recompute_strategy", "retriever_id"]
+        nullable_fields = ["retriever_id"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(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/invalidationstrategy.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class InvalidationStrategy(str, Enum):
+    r"""Strategies for cache invalidation"""
+
+    REPLACE_IF_BETTER = "replace_if_better"
+    REPLACE_ALWAYS = "replace_always"
+    KEEP_EXISTING = "keep_existing"

mixpeek/models/kill_task_v1_tasks_task_id_deleteop.py

@@ -36,7 +36,7 @@ class KillTaskV1TasksTaskIDDeleteRequest(BaseModel):
 
         m = {}
 
-        for n, f in self.model_fields.items():
+        for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
             serialized.pop(k, None)

mixpeek/models/list_active_tasks_v1_tasks_getop.py

@@ -44,7 +44,7 @@ class ListActiveTasksV1TasksGetRequest(BaseModel):
 
         m = {}
 
-        for n, f in self.model_fields.items():
+        for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
             serialized.pop(k, None)

mixpeek/models/{list_assets_v1_assets_postop.py → list_buckets_v1_buckets_postop.py}

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .listassetsrequest import ListAssetsRequest, ListAssetsRequestTypedDict
+from .listbucketsrequest import ListBucketsRequest, ListBucketsRequestTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -15,29 +15,24 @@ from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class ListAssetsV1AssetsPostRequestTypedDict(TypedDict):
-    list_assets_request: ListAssetsRequestTypedDict
-    page: NotRequired[Nullable[int]]
-    page_size: NotRequired[int]
+class ListBucketsV1BucketsPostRequestTypedDict(TypedDict):
+    limit: NotRequired[Nullable[int]]
+    offset: NotRequired[Nullable[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."""
+    list_buckets_request: NotRequired[ListBucketsRequestTypedDict]
 
 
-class ListAssetsV1AssetsPostRequest(BaseModel):
-    list_assets_request: Annotated[
-        ListAssetsRequest,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
-    ]
-
-    page: Annotated[
+class ListBucketsV1BucketsPostRequest(BaseModel):
+    limit: Annotated[
         OptionalNullable[int],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
 
-    page_size: Annotated[
-        Optional[int],
+    offset: Annotated[
+        OptionalNullable[int],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = 10
+    ] = UNSET
 
     x_namespace: Annotated[
         OptionalNullable[str],
@@ -46,17 +41,22 @@ class ListAssetsV1AssetsPostRequest(BaseModel):
     ] = 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."""
 
+    list_buckets_request: Annotated[
+        Optional[ListBucketsRequest],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["page", "page_size", "X-Namespace"]
-        nullable_fields = ["page", "X-Namespace"]
+        optional_fields = ["limit", "offset", "X-Namespace", "ListBucketsRequest"]
+        nullable_fields = ["limit", "offset", "X-Namespace"]
         null_default_fields = []
 
         serialized = handler(self)
 
         m = {}
 
-        for n, f in self.model_fields.items():
+        for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
             serialized.pop(k, None)

mixpeek/models/{list_features_v1_features_postop.py → list_documents_v1_collections_collection_identifier_documents_getop.py}

@@ -1,13 +1,12 @@
 """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,
+    PathParamMetadata,
     QueryParamMetadata,
-    RequestMetadata,
 )
 import pydantic
 from pydantic import model_serializer
@@ -15,31 +14,60 @@ from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class ListFeaturesV1FeaturesPostRequestTypedDict(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]
+class ListDocumentsV1CollectionsCollectionIdentifierDocumentsGetRequestTypedDict(
+    TypedDict
+):
+    collection_identifier: str
+    r"""The ID of the collection"""
+    limit: NotRequired[int]
+    r"""Number of documents to return per page"""
+    offset_id: NotRequired[Nullable[str]]
+    r"""ID of the document to start pagination from"""
+    sort: NotRequired[Nullable[str]]
+    r"""Field to sort by"""
+    filters: NotRequired[Nullable[str]]
+    r"""Filter criteria"""
+    select: NotRequired[Nullable[str]]
+    r"""Fields to select"""
     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 ListFeaturesV1FeaturesPostRequest(BaseModel):
-    list_features_request: Annotated[
-        ListFeaturesRequest,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+class ListDocumentsV1CollectionsCollectionIdentifierDocumentsGetRequest(BaseModel):
+    collection_identifier: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
+    r"""The ID of the collection"""
 
-    offset_feature_id: Annotated[
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Number of documents to return per page"""
+
+    offset_id: Annotated[
         OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
-    r"""The offset id to start returning results from. Used for pagination"""
+    r"""ID of the document to start pagination from"""
 
-    page_size: Annotated[
-        Optional[int],
+    sort: Annotated[
+        OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = 10
+    ] = UNSET
+    r"""Field to sort by"""
+
+    filters: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Filter criteria"""
+
+    select: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Fields to select"""
 
     x_namespace: Annotated[
         OptionalNullable[str],
@@ -50,15 +78,22 @@ class ListFeaturesV1FeaturesPostRequest(BaseModel):
 
     @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"]
+        optional_fields = [
+            "limit",
+            "offset_id",
+            "sort",
+            "filters",
+            "select",
+            "X-Namespace",
+        ]
+        nullable_fields = ["offset_id", "sort", "filters", "select", "X-Namespace"]
         null_default_fields = []
 
         serialized = handler(self)
 
         m = {}
 
-        for n, f in self.model_fields.items():
+        for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
             serialized.pop(k, None)

mixpeek/models/list_interactions_v1_retrievers_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 ListInteractionsV1RetrieversInteractionsGetRequestTypedDict(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 ListInteractionsV1RetrieversInteractionsGetRequest(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 type(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