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

mixpeek/models/aggregationtype.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class AggregationType(str, Enum):
+    r"""Types of data aggregation"""
+
+    HOURLY = "hourly"
+    DAILY = "daily"
+    WEEKLY = "weekly"
+    MONTHLY = "monthly"

mixpeek/models/apikeyupdate.py

@@ -28,7 +28,7 @@ class APIKeyUpdate(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/attributebasedconfig.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, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class AttributeBasedConfigTypedDict(TypedDict):
+    attributes: List[str]
+    r"""List of attributes to use for attribute-based clustering"""
+    hierarchical_grouping: NotRequired[bool]
+    r"""Enable multi-level grouping similar to pandas multi-level groupby"""
+
+
+class AttributeBasedConfig(BaseModel):
+    attributes: List[str]
+    r"""List of attributes to use for attribute-based clustering"""
+
+    hierarchical_grouping: Optional[bool] = False
+    r"""Enable multi-level grouping similar to pandas multi-level groupby"""

mixpeek/models/automaticnaming.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .generativemodels import GenerativeModels
+from .namingmethod import NamingMethod
+from mixpeek.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class AutomaticNamingTypedDict(TypedDict):
+    enabled: NotRequired[bool]
+    r"""Automatically assign cluster labels to documents"""
+    generative_model: NotRequired[GenerativeModels]
+    method: NotRequired[NamingMethod]
+    num_nearest_points: NotRequired[int]
+    r"""Features used to generate name"""
+
+
+class AutomaticNaming(BaseModel):
+    enabled: Optional[bool] = True
+    r"""Automatically assign cluster labels to documents"""
+
+    generative_model: Optional[GenerativeModels] = None
+
+    method: Optional[NamingMethod] = None
+
+    num_nearest_points: Optional[int] = 3
+    r"""Features used to generate name"""

mixpeek/models/basicfeatureextractor.py

@@ -0,0 +1,35 @@
+"""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 BasicFeatureExtractorTypedDict(TypedDict):
+    r"""Basic feature extractor model, used for creating namespaces."""
+
+    feature_extractor_name: str
+    r"""Name of the feature extractor"""
+    description: str
+    r"""Description of the feature extractor"""
+    supported_input_types: List[str]
+    r"""Supported input types"""
+    version: str
+    r"""Version of the feature extractor"""
+
+
+class BasicFeatureExtractor(BaseModel):
+    r"""Basic feature extractor model, used for creating namespaces."""
+
+    feature_extractor_name: str
+    r"""Name of the feature extractor"""
+
+    description: str
+    r"""Description of the feature extractor"""
+
+    supported_input_types: List[str]
+    r"""Supported input types"""
+
+    version: str
+    r"""Version of the feature extractor"""

mixpeek/models/{classify_features_v1_entities_taxonomies_taxonomy_classify_postop.py → batch_delete_documents_v1_collections_collection_identifier_documents_batch_deleteop.py}

@@ -1,7 +1,6 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .discoverrequest import DiscoverRequest, DiscoverRequestTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -11,29 +10,27 @@ from mixpeek.utils import (
 )
 import pydantic
 from pydantic import model_serializer
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class ClassifyFeaturesV1EntitiesTaxonomiesTaxonomyClassifyPostRequestTypedDict(
+class BatchDeleteDocumentsV1CollectionsCollectionIdentifierDocumentsBatchDeleteRequestTypedDict(
     TypedDict
 ):
-    taxonomy: str
-    r"""The name or id of the taxonomy to use for discovery"""
-    discover_request: DiscoverRequestTypedDict
+    collection_identifier: str
+    r"""The ID of the collection"""
     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[List[str]]
 
 
-class ClassifyFeaturesV1EntitiesTaxonomiesTaxonomyClassifyPostRequest(BaseModel):
-    taxonomy: Annotated[
+class BatchDeleteDocumentsV1CollectionsCollectionIdentifierDocumentsBatchDeleteRequest(
+    BaseModel
+):
+    collection_identifier: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""The name or id of the taxonomy to use for discovery"""
-
-    discover_request: Annotated[
-        DiscoverRequest,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
-    ]
+    r"""The ID of the collection"""
 
     x_namespace: Annotated[
         OptionalNullable[str],
@@ -42,9 +39,14 @@ class ClassifyFeaturesV1EntitiesTaxonomiesTaxonomyClassifyPostRequest(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[
+        Optional[List[str]],
+        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", "RequestBody"]
         nullable_fields = ["X-Namespace"]
         null_default_fields = []
 
@@ -52,7 +54,7 @@ class ClassifyFeaturesV1EntitiesTaxonomiesTaxonomyClassifyPostRequest(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_collection_v1_collections_collection_putop.py → batch_update_documents_v1_collections_collection_identifier_documents_batch_putop.py}

@@ -1,10 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .createcollectionrequest import (
-    CreateCollectionRequest,
-    CreateCollectionRequestTypedDict,
-)
+from .documentupdate import DocumentUpdate, DocumentUpdateTypedDict
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mixpeek.utils import (
     FieldMetadata,
@@ -14,27 +11,35 @@ from mixpeek.utils import (
 )
 import pydantic
 from pydantic import model_serializer
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing import List, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+RequestBodyTypedDict = TypeAliasType(
+    "RequestBodyTypedDict", Union[DocumentUpdateTypedDict, str]
+)
+
+
+RequestBody = TypeAliasType("RequestBody", Union[DocumentUpdate, str])
 
 
-class UpdateCollectionV1CollectionsCollectionPutRequestTypedDict(TypedDict):
-    collection: str
-    r"""Either the collection name or collection ID"""
-    create_collection_request: CreateCollectionRequestTypedDict
+class BatchUpdateDocumentsV1CollectionsCollectionIdentifierDocumentsBatchPutRequestTypedDict(
+    TypedDict
+):
+    collection_identifier: str
+    r"""The ID of the collection"""
     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[List[List[RequestBodyTypedDict]]]
 
 
-class UpdateCollectionV1CollectionsCollectionPutRequest(BaseModel):
-    collection: Annotated[
+class BatchUpdateDocumentsV1CollectionsCollectionIdentifierDocumentsBatchPutRequest(
+    BaseModel
+):
+    collection_identifier: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Either the collection name or collection ID"""
-
-    create_collection_request: Annotated[
-        CreateCollectionRequest,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
-    ]
+    r"""The ID of the collection"""
 
     x_namespace: Annotated[
         OptionalNullable[str],
@@ -43,9 +48,14 @@ class UpdateCollectionV1CollectionsCollectionPutRequest(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[
+        Optional[List[List[RequestBody]]],
+        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", "RequestBody"]
         nullable_fields = ["X-Namespace"]
         null_default_fields = []
 
@@ -53,7 +63,7 @@ class UpdateCollectionV1CollectionsCollectionPutRequest(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/blobdetails.py

@@ -0,0 +1,72 @@
+"""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 pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class BlobDetailsTypedDict(TypedDict):
+    r"""File details for a bucket object, these are automatically generated by the system"""
+
+    filename: NotRequired[Nullable[str]]
+    size_bytes: NotRequired[Nullable[int]]
+    mime_type: NotRequired[Nullable[str]]
+    hash: NotRequired[Nullable[str]]
+    s3_object_key: NotRequired[Nullable[str]]
+
+
+class BlobDetails(BaseModel):
+    r"""File details for a bucket object, these are automatically generated by the system"""
+
+    filename: OptionalNullable[str] = UNSET
+
+    size_bytes: OptionalNullable[int] = UNSET
+
+    mime_type: OptionalNullable[str] = UNSET
+
+    hash: OptionalNullable[str] = UNSET
+
+    s3_object_key: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "filename",
+            "size_bytes",
+            "mime_type",
+            "hash",
+            "s3_object_key",
+        ]
+        nullable_fields = [
+            "filename",
+            "size_bytes",
+            "mime_type",
+            "hash",
+            "s3_object_key",
+        ]
+        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/blobmodel.py

@@ -0,0 +1,107 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .blobdetails import BlobDetails, BlobDetailsTypedDict
+from .bucketschemafieldtype import BucketSchemaFieldType
+from .taskstatus import TaskStatus
+from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Any, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class BlobModelMetadataTypedDict(TypedDict):
+    pass
+
+
+class BlobModelMetadata(BaseModel):
+    pass
+
+
+class BlobModelTypedDict(TypedDict):
+    r"""Model for a blob within a bucket object"""
+
+    property: str
+    r"""Property name of the blob"""
+    type: BucketSchemaFieldType
+    r"""Enum for field types in bucket schemas"""
+    data: Any
+    r"""Data for the blob"""
+    blob_id: NotRequired[str]
+    r"""Unique identifier for the blob"""
+    key_prefix: NotRequired[Nullable[str]]
+    r"""Storage key/path of the blob, this will be used to retrieve the blob from the storage. It is similar to a file path. If not provided, it will be placed in the root of the bucket."""
+    metadata: NotRequired[Nullable[BlobModelMetadataTypedDict]]
+    r"""Metadata for the blob, this will only be applied to the documents that use this blob"""
+    details: NotRequired[BlobDetailsTypedDict]
+    r"""File details for a bucket object, these are automatically generated by the system"""
+    status: NotRequired[TaskStatus]
+    error: NotRequired[Nullable[str]]
+    r"""Error message if the blob failed to be ingested"""
+
+
+class BlobModel(BaseModel):
+    r"""Model for a blob within a bucket object"""
+
+    property: str
+    r"""Property name of the blob"""
+
+    type: BucketSchemaFieldType
+    r"""Enum for field types in bucket schemas"""
+
+    data: Any
+    r"""Data for the blob"""
+
+    blob_id: Optional[str] = None
+    r"""Unique identifier for the blob"""
+
+    key_prefix: OptionalNullable[str] = UNSET
+    r"""Storage key/path of the blob, this will be used to retrieve the blob from the storage. It is similar to a file path. If not provided, it will be placed in the root of the bucket."""
+
+    metadata: OptionalNullable[BlobModelMetadata] = UNSET
+    r"""Metadata for the blob, this will only be applied to the documents that use this blob"""
+
+    details: Optional[BlobDetails] = None
+    r"""File details for a bucket object, these are automatically generated by the system"""
+
+    status: Optional[TaskStatus] = None
+
+    error: OptionalNullable[str] = UNSET
+    r"""Error message if the blob failed to be ingested"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "blob_id",
+            "key_prefix",
+            "metadata",
+            "details",
+            "status",
+            "error",
+        ]
+        nullable_fields = ["key_prefix", "metadata", "error"]
+        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/bucketcreaterequest.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .bucketschema_input import BucketSchemaInput, BucketSchemaInputTypedDict
+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 BucketCreateRequestMetadataTypedDict(TypedDict):
+    r"""Additional metadata for the bucket"""
+
+
+class BucketCreateRequestMetadata(BaseModel):
+    r"""Additional metadata for the bucket"""
+
+
+class BucketCreateRequestTypedDict(TypedDict):
+    r"""Request model for creating a new bucket"""
+
+    bucket_name: str
+    r"""Human-readable name for the bucket"""
+    bucket_schema: BucketSchemaInputTypedDict
+    r"""Schema definition for bucket objects"""
+    description: NotRequired[Nullable[str]]
+    r"""Description of the bucket"""
+    metadata: NotRequired[BucketCreateRequestMetadataTypedDict]
+    r"""Additional metadata for the bucket"""
+
+
+class BucketCreateRequest(BaseModel):
+    r"""Request model for creating a new bucket"""
+
+    bucket_name: str
+    r"""Human-readable name for the bucket"""
+
+    bucket_schema: BucketSchemaInput
+    r"""Schema definition for bucket objects"""
+
+    description: OptionalNullable[str] = UNSET
+    r"""Description of the bucket"""
+
+    metadata: Optional[BucketCreateRequestMetadata] = None
+    r"""Additional metadata for the bucket"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description", "metadata"]
+        nullable_fields = ["description"]
+        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/bucketresponse.py

@@ -0,0 +1,90 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .bucketschema_output import BucketSchemaOutput, BucketSchemaOutputTypedDict
+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 BucketResponseMetadataTypedDict(TypedDict):
+    r"""Additional metadata for the bucket"""
+
+
+class BucketResponseMetadata(BaseModel):
+    r"""Additional metadata for the bucket"""
+
+
+class BucketResponseTypedDict(TypedDict):
+    r"""Response model for bucket operations"""
+
+    bucket_name: str
+    r"""Human-readable name for the bucket"""
+    bucket_schema: BucketSchemaOutputTypedDict
+    r"""Schema definition for bucket objects"""
+    object_count: int
+    r"""Number of objects in the bucket"""
+    total_size_bytes: int
+    r"""Total size of all objects in the bucket in bytes"""
+    bucket_id: NotRequired[str]
+    r"""Unique identifier for the bucket"""
+    description: NotRequired[Nullable[str]]
+    r"""Description of the bucket"""
+    metadata: NotRequired[BucketResponseMetadataTypedDict]
+    r"""Additional metadata for the bucket"""
+
+
+class BucketResponse(BaseModel):
+    r"""Response model for bucket operations"""
+
+    bucket_name: str
+    r"""Human-readable name for the bucket"""
+
+    bucket_schema: BucketSchemaOutput
+    r"""Schema definition for bucket objects"""
+
+    object_count: int
+    r"""Number of objects in the bucket"""
+
+    total_size_bytes: int
+    r"""Total size of all objects in the bucket in bytes"""
+
+    bucket_id: Optional[str] = None
+    r"""Unique identifier for the bucket"""
+
+    description: OptionalNullable[str] = UNSET
+    r"""Description of the bucket"""
+
+    metadata: Optional[BucketResponseMetadata] = None
+    r"""Additional metadata for the bucket"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["bucket_id", "description", "metadata"]
+        nullable_fields = ["description"]
+        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/bucketschema_input.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .bucketschemafield_input import (
+    BucketSchemaFieldInput,
+    BucketSchemaFieldInputTypedDict,
+)
+from mixpeek.types import BaseModel
+import pydantic
+from pydantic import ConfigDict
+from typing import Any, Dict
+from typing_extensions import TypedDict
+
+
+class BucketSchemaInputTypedDict(TypedDict):
+    r"""Schema definition for bucket objects"""
+
+    properties: Dict[str, BucketSchemaFieldInputTypedDict]
+
+
+class BucketSchemaInput(BaseModel):
+    r"""Schema definition for bucket objects"""
+
+    model_config = ConfigDict(
+        populate_by_name=True, arbitrary_types_allowed=True, extra="allow"
+    )
+    __pydantic_extra__: Dict[str, Any] = pydantic.Field(init=False)
+
+    properties: Dict[str, BucketSchemaFieldInput]
+
+    @property
+    def additional_properties(self):
+        return self.__pydantic_extra__
+
+    @additional_properties.setter
+    def additional_properties(self, value):
+        self.__pydantic_extra__ = value  # pyright: ignore[reportIncompatibleVariableOverride]