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

mixpeek/models/stagedefinition.py

@@ -0,0 +1,110 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .bucketschemafield_output import (
+    BucketSchemaFieldOutput,
+    BucketSchemaFieldOutputTypedDict,
+)
+from .vectorindexdefinition import VectorIndexDefinition, VectorIndexDefinitionTypedDict
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Any, Dict, List
+from typing_extensions import NotRequired, TypedDict
+
+
+class StageDefinitionDefaultParametersTypedDict(TypedDict):
+    pass
+
+
+class StageDefinitionDefaultParameters(BaseModel):
+    pass
+
+
+class StageDefinitionTypedDict(TypedDict):
+    r"""Model for retriever stage definition that describes how to process and search documents."""
+
+    stage_name: str
+    r"""Name of the stage"""
+    description: str
+    version: str
+    module_path: str
+    input_schema: Dict[str, BucketSchemaFieldOutputTypedDict]
+    output_schema: Dict[str, BucketSchemaFieldOutputTypedDict]
+    parameter_schema: Dict[str, BucketSchemaFieldOutputTypedDict]
+    supported_input_types: List[str]
+    max_inputs: Dict[str, int]
+    default_parameters: StageDefinitionDefaultParametersTypedDict
+    required_vector_indexes: NotRequired[Nullable[List[VectorIndexDefinitionTypedDict]]]
+    required_payload_indexes: NotRequired[Nullable[List[Any]]]
+    supported_filters: NotRequired[Nullable[List[str]]]
+    r"""List of filter operations supported by this stage"""
+
+
+class StageDefinition(BaseModel):
+    r"""Model for retriever stage definition that describes how to process and search documents."""
+
+    stage_name: str
+    r"""Name of the stage"""
+
+    description: str
+
+    version: str
+
+    module_path: str
+
+    input_schema: Dict[str, BucketSchemaFieldOutput]
+
+    output_schema: Dict[str, BucketSchemaFieldOutput]
+
+    parameter_schema: Dict[str, BucketSchemaFieldOutput]
+
+    supported_input_types: List[str]
+
+    max_inputs: Dict[str, int]
+
+    default_parameters: StageDefinitionDefaultParameters
+
+    required_vector_indexes: OptionalNullable[List[VectorIndexDefinition]] = UNSET
+
+    required_payload_indexes: OptionalNullable[List[Any]] = UNSET
+
+    supported_filters: OptionalNullable[List[str]] = UNSET
+    r"""List of filter operations supported by this stage"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "required_vector_indexes",
+            "required_payload_indexes",
+            "supported_filters",
+        ]
+        nullable_fields = [
+            "required_vector_indexes",
+            "required_payload_indexes",
+            "supported_filters",
+        ]
+        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/{jsonimageoutputsettings.py → stageresponse.py}

@@ -3,38 +3,48 @@
 from __future__ import annotations
 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 JSONImageOutputSettingsResponseShapeTypedDict(TypedDict):
+class ResultsTypedDict(TypedDict):
     pass
 
 
-class JSONImageOutputSettingsResponseShape(BaseModel):
+class Results(BaseModel):
     pass
 
 
-class JSONImageOutputSettingsTypedDict(TypedDict):
-    response_shape: NotRequired[Nullable[JSONImageOutputSettingsResponseShapeTypedDict]]
-    prompt: NotRequired[Nullable[str]]
+class StageResponseTypedDict(TypedDict):
+    r"""Output from a retriever stage"""
 
+    results: List[ResultsTypedDict]
+    execution_time: float
+    total_results: NotRequired[Nullable[int]]
+    r"""Total number of results not filtered by pagination"""
 
-class JSONImageOutputSettings(BaseModel):
-    response_shape: OptionalNullable[JSONImageOutputSettingsResponseShape] = UNSET
 
-    prompt: OptionalNullable[str] = UNSET
+class StageResponse(BaseModel):
+    r"""Output from a retriever stage"""
+
+    results: List[Results]
+
+    execution_time: float
+
+    total_results: OptionalNullable[int] = UNSET
+    r"""Total number of results not filtered by pagination"""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["response_shape", "prompt"]
-        nullable_fields = ["response_shape", "prompt"]
+        optional_fields = ["total_results"]
+        nullable_fields = ["total_results"]
         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/taskresponse.py

@@ -34,7 +34,7 @@ class TaskResponse(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/taskstatus.py

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

mixpeek/models/{assetfeatures.py → taxonomyapplicationconfig.py}

@@ -1,40 +1,48 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .featureresponse import FeatureResponse, FeatureResponseTypedDict
 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 AssetFeaturesTypedDict(TypedDict):
-    video: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
-    image: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
-    text: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
-    audio: NotRequired[Nullable[List[FeatureResponseTypedDict]]]
+class TaxonomyApplicationConfigTypedDict(TypedDict):
+    r"""Configuration for how a taxonomy should be applied and materialized"""
 
+    taxonomy_id: str
+    r"""ID of the taxonomy to apply"""
+    output_collection: NotRequired[Nullable[str]]
+    r"""
+    ID or name of the collection to store enriched documents, if none exists, it will be created.
+    If set to None, it will be treated as a temporary enrichment and not stored.
 
-class AssetFeatures(BaseModel):
-    video: OptionalNullable[List[FeatureResponse]] = UNSET
+    """
 
-    image: OptionalNullable[List[FeatureResponse]] = UNSET
 
-    text: OptionalNullable[List[FeatureResponse]] = UNSET
+class TaxonomyApplicationConfig(BaseModel):
+    r"""Configuration for how a taxonomy should be applied and materialized"""
 
-    audio: OptionalNullable[List[FeatureResponse]] = UNSET
+    taxonomy_id: str
+    r"""ID of the taxonomy to apply"""
+
+    output_collection: OptionalNullable[str] = UNSET
+    r"""
+    ID or name of the collection to store enriched documents, if none exists, it will be created.
+    If set to None, it will be treated as a temporary enrichment and not stored.
+
+    """
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["video", "image", "text", "audio"]
-        nullable_fields = ["video", "image", "text", "audio"]
+        optional_fields = ["output_collection"]
+        nullable_fields = ["output_collection"]
         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/taxonomyconfig.py

@@ -0,0 +1,19 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .collectionconfig import CollectionConfig, CollectionConfigTypedDict
+from mixpeek.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class TaxonomyConfigTypedDict(TypedDict):
+    r"""Base configuration for all taxonomy types"""
+
+    source_collections: List[CollectionConfigTypedDict]
+
+
+class TaxonomyConfig(BaseModel):
+    r"""Base configuration for all taxonomy types"""
+
+    source_collections: List[CollectionConfig]

mixpeek/models/timeseriesdatapoint.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from mixpeek.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class TimeseriesDataPointTypedDict(TypedDict):
+    r"""Single data point for timeseries data"""
+
+    timestamp: datetime
+    r"""Timestamp of the data point"""
+    value: float
+    r"""Value of the metric"""
+
+
+class TimeseriesDataPoint(BaseModel):
+    r"""Single data point for timeseries data"""
+
+    timestamp: datetime
+    r"""Timestamp of the data point"""
+
+    value: float
+    r"""Value of the metric"""

mixpeek/models/timeseriesusage.py

@@ -0,0 +1,36 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .timeseriesdatapoint import TimeseriesDataPoint, TimeseriesDataPointTypedDict
+from mixpeek.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class TimeseriesUsageTypedDict(TypedDict):
+    r"""Timeseries usage data for various metrics"""
+
+    api_calls: NotRequired[List[TimeseriesDataPointTypedDict]]
+    r"""API calls over time"""
+    storage_used: NotRequired[List[TimeseriesDataPointTypedDict]]
+    r"""Storage used over time"""
+    documents_processed: NotRequired[List[TimeseriesDataPointTypedDict]]
+    r"""Documents processed over time"""
+    credits_used: NotRequired[List[TimeseriesDataPointTypedDict]]
+    r"""Credits used over time"""
+
+
+class TimeseriesUsage(BaseModel):
+    r"""Timeseries usage data for various metrics"""
+
+    api_calls: Optional[List[TimeseriesDataPoint]] = None
+    r"""API calls over time"""
+
+    storage_used: Optional[List[TimeseriesDataPoint]] = None
+    r"""Storage used over time"""
+
+    documents_processed: Optional[List[TimeseriesDataPoint]] = None
+    r"""Documents processed over time"""
+
+    credits_used: Optional[List[TimeseriesDataPoint]] = None
+    r"""Credits used over time"""

mixpeek/models/{full_asset_update_v1_assets_asset_id_putop.py → update_bucket_v1_buckets_bucket_identifier_putop.py}

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .updateassetrequest import UpdateAssetRequest, UpdateAssetRequestTypedDict
+from .bucketupdaterequest import BucketUpdateRequest, BucketUpdateRequestTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -14,20 +14,20 @@ from pydantic import model_serializer
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class FullAssetUpdateV1AssetsAssetIDPutRequestTypedDict(TypedDict):
-    asset_id: str
-    update_asset_request: UpdateAssetRequestTypedDict
+class UpdateBucketV1BucketsBucketIdentifierPutRequestTypedDict(TypedDict):
+    bucket_identifier: str
+    bucket_update_request: BucketUpdateRequestTypedDict
     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 FullAssetUpdateV1AssetsAssetIDPutRequest(BaseModel):
-    asset_id: Annotated[
+class UpdateBucketV1BucketsBucketIdentifierPutRequest(BaseModel):
+    bucket_identifier: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
 
-    update_asset_request: Annotated[
-        UpdateAssetRequest,
+    bucket_update_request: Annotated[
+        BucketUpdateRequest,
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
 
@@ -48,7 +48,7 @@ class FullAssetUpdateV1AssetsAssetIDPutRequest(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/{update_taxonomy_v1_entities_taxonomies_taxonomy_patchop.py → update_document_v1_collections_collection_identifier_documents_document_id_putop.py}

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .taxonomyupdate import TaxonomyUpdate, TaxonomyUpdateTypedDict
+from .documentupdate import DocumentUpdate, DocumentUpdateTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -11,27 +11,34 @@ from mixpeek.utils import (
 )
 import pydantic
 from pydantic import model_serializer
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class UpdateTaxonomyV1EntitiesTaxonomiesTaxonomyPatchRequestTypedDict(TypedDict):
-    taxonomy: str
-    r"""The ID or name of the taxonomy to update"""
-    taxonomy_update: TaxonomyUpdateTypedDict
+class UpdateDocumentV1CollectionsCollectionIdentifierDocumentsDocumentIDPutRequestTypedDict(
+    TypedDict
+):
+    collection_identifier: str
+    r"""The ID of the collection"""
+    document_id: str
+    r"""The ID of the document to update"""
     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."""
+    document_update: NotRequired[DocumentUpdateTypedDict]
 
 
-class UpdateTaxonomyV1EntitiesTaxonomiesTaxonomyPatchRequest(BaseModel):
-    taxonomy: Annotated[
+class UpdateDocumentV1CollectionsCollectionIdentifierDocumentsDocumentIDPutRequest(
+    BaseModel
+):
+    collection_identifier: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""The ID or name of the taxonomy to update"""
+    r"""The ID of the collection"""
 
-    taxonomy_update: Annotated[
-        TaxonomyUpdate,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    document_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
+    r"""The ID of the document to update"""
 
     x_namespace: Annotated[
         OptionalNullable[str],
@@ -40,9 +47,14 @@ class UpdateTaxonomyV1EntitiesTaxonomiesTaxonomyPatchRequest(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."""
 
+    document_update: Annotated[
+        Optional[DocumentUpdate],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["X-Namespace"]
+        optional_fields = ["X-Namespace", "DocumentUpdate"]
         nullable_fields = ["X-Namespace"]
         null_default_fields = []
 
@@ -50,7 +62,7 @@ class UpdateTaxonomyV1EntitiesTaxonomiesTaxonomyPatchRequest(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/{full_feature_update_v1_features_feature_id_putop.py → update_object_v1_buckets_bucket_identifier_objects_object_identifier_putop.py}

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .featureupdaterequest import FeatureUpdateRequest, FeatureUpdateRequestTypedDict
+from .updateobjectrequest import UpdateObjectRequest, UpdateObjectRequestTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -14,20 +14,31 @@ from pydantic import model_serializer
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class FullFeatureUpdateV1FeaturesFeatureIDPutRequestTypedDict(TypedDict):
-    feature_id: str
-    feature_update_request: FeatureUpdateRequestTypedDict
+class UpdateObjectV1BucketsBucketIdentifierObjectsObjectIdentifierPutRequestTypedDict(
+    TypedDict
+):
+    bucket_identifier: str
+    r"""Identifier of the bucket"""
+    object_identifier: str
+    r"""Identifier of the object"""
+    update_object_request: UpdateObjectRequestTypedDict
     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 FullFeatureUpdateV1FeaturesFeatureIDPutRequest(BaseModel):
-    feature_id: Annotated[
+class UpdateObjectV1BucketsBucketIdentifierObjectsObjectIdentifierPutRequest(BaseModel):
+    bucket_identifier: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
+    r"""Identifier of the bucket"""
 
-    feature_update_request: Annotated[
-        FeatureUpdateRequest,
+    object_identifier: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""Identifier of the object"""
+
+    update_object_request: Annotated[
+        UpdateObjectRequest,
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
 
@@ -48,7 +59,7 @@ class FullFeatureUpdateV1FeaturesFeatureIDPutRequest(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/updatenamespacerequest.py

@@ -36,7 +36,7 @@ class UpdateNamespaceRequest(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/updateobjectrequest.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createblobrequest import CreateBlobRequest, CreateBlobRequestTypedDict
+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 UpdateObjectRequestMetadataTypedDict(TypedDict):
+    pass
+
+
+class UpdateObjectRequestMetadata(BaseModel):
+    pass
+
+
+class UpdateObjectRequestTypedDict(TypedDict):
+    r"""Request model for updating an existing bucket object"""
+
+    key_prefix: NotRequired[Nullable[str]]
+    r"""Updated storage key/path prefix of the object, this will be used to retrieve the object from the storage. It's at the root of the object."""
+    blobs: NotRequired[Nullable[List[CreateBlobRequestTypedDict]]]
+    r"""List of new or updated blobs for this object"""
+    metadata: NotRequired[Nullable[UpdateObjectRequestMetadataTypedDict]]
+    r"""Updated metadata for the object, this will be merged with existing metadata."""
+    skip_duplicates: NotRequired[Nullable[bool]]
+    r"""Skip duplicate blobs, if a blob with the same hash already exists, it will be skipped."""
+
+
+class UpdateObjectRequest(BaseModel):
+    r"""Request model for updating an existing bucket object"""
+
+    key_prefix: OptionalNullable[str] = UNSET
+    r"""Updated storage key/path prefix of the object, this will be used to retrieve the object from the storage. It's at the root of the object."""
+
+    blobs: OptionalNullable[List[CreateBlobRequest]] = UNSET
+    r"""List of new or updated blobs for this object"""
+
+    metadata: OptionalNullable[UpdateObjectRequestMetadata] = UNSET
+    r"""Updated metadata for the object, this will be merged with existing metadata."""
+
+    skip_duplicates: OptionalNullable[bool] = UNSET
+    r"""Skip duplicate blobs, if a blob with the same hash already exists, it will be skipped."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["key_prefix", "blobs", "metadata", "skip_duplicates"]
+        nullable_fields = ["key_prefix", "blobs", "metadata", "skip_duplicates"]
+        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