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

mixpeek/models/usageresponse.py

@@ -0,0 +1,86 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .namespaceusage import NamespaceUsage, NamespaceUsageTypedDict
+from .plan import Plan, PlanTypedDict
+from .timeseriesusage import TimeseriesUsage, TimeseriesUsageTypedDict
+from .usagesummary import UsageSummary, UsageSummaryTypedDict
+from datetime import datetime
+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 UsageResponseTypedDict(TypedDict):
+    r"""Complete usage response model"""
+
+    usage_summary: UsageSummaryTypedDict
+    r"""Summary of current resource usage"""
+    namespace_usage: List[NamespaceUsageTypedDict]
+    r"""Usage by namespace"""
+    billing_period_end: datetime
+    r"""End of current billing period"""
+    organization_id: str
+    r"""Organization ID"""
+    usage_history: NotRequired[Nullable[TimeseriesUsageTypedDict]]
+    r"""Historical usage data"""
+    billing_period_start: NotRequired[Nullable[datetime]]
+    r"""Start of current billing period"""
+    current_plan: NotRequired[Nullable[PlanTypedDict]]
+    r"""Current subscription plan"""
+
+
+class UsageResponse(BaseModel):
+    r"""Complete usage response model"""
+
+    usage_summary: UsageSummary
+    r"""Summary of current resource usage"""
+
+    namespace_usage: List[NamespaceUsage]
+    r"""Usage by namespace"""
+
+    billing_period_end: datetime
+    r"""End of current billing period"""
+
+    organization_id: str
+    r"""Organization ID"""
+
+    usage_history: OptionalNullable[TimeseriesUsage] = UNSET
+    r"""Historical usage data"""
+
+    billing_period_start: OptionalNullable[datetime] = UNSET
+    r"""Start of current billing period"""
+
+    current_plan: OptionalNullable[Plan] = UNSET
+    r"""Current subscription plan"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["usage_history", "billing_period_start", "current_plan"]
+        nullable_fields = ["usage_history", "billing_period_start", "current_plan"]
+        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/usagesummary.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mixpeek.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class UsageSummaryTypedDict(TypedDict):
+    r"""Summary of current resource usage"""
+
+    api_calls: int
+    r"""Total API calls in the current period"""
+    storage_used_gb: float
+    r"""Total storage used in GB"""
+    documents_processed: int
+    r"""Total documents processed"""
+    active_collections: int
+    r"""Number of active collections"""
+    credits_used: int
+    r"""Total credits used"""
+
+
+class UsageSummary(BaseModel):
+    r"""Summary of current resource usage"""
+
+    api_calls: int
+    r"""Total API calls in the current period"""
+
+    storage_used_gb: float
+    r"""Total storage used in GB"""
+
+    documents_processed: int
+    r"""Total documents processed"""
+
+    active_collections: int
+    r"""Number of active collections"""
+
+    credits_used: int
+    r"""Total credits used"""

mixpeek/models/usagetimerange.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class UsageTimeRange(str, Enum):
+    r"""Time ranges for usage data"""
+
+    SEVEND = "7d"
+    THIRTYD = "30d"
+    NINETYD = "90d"
+    ONE_HUNDRED_AND_EIGHTYD = "180d"
+    THREE_HUNDRED_AND_SIXTY_FIVED = "365d"
+    BILLING_PERIOD = "billing_period"
+    CUSTOM = "custom"

mixpeek/models/usermodel_input.py

@@ -19,6 +19,7 @@ class UserModelInputMetadata(BaseModel):
 class UserModelInputTypedDict(TypedDict):
     email: str
     user_id: NotRequired[str]
+    user_name: NotRequired[str]
     api_keys: NotRequired[List[APIKeyTypedDict]]
     metadata: NotRequired[UserModelInputMetadataTypedDict]
     created_at: NotRequired[datetime]
@@ -29,6 +30,8 @@ class UserModelInput(BaseModel):
 
     user_id: Optional[str] = None
 
+    user_name: Optional[str] = None
+
     api_keys: Optional[List[APIKey]] = None
 
     metadata: Optional[UserModelInputMetadata] = None

mixpeek/models/usermodel_output.py

@@ -19,6 +19,7 @@ class UserModelOutputMetadata(BaseModel):
 class UserModelOutputTypedDict(TypedDict):
     email: str
     user_id: NotRequired[str]
+    user_name: NotRequired[str]
     api_keys: NotRequired[List[APIKeyTypedDict]]
     metadata: NotRequired[UserModelOutputMetadataTypedDict]
     created_at: NotRequired[datetime]
@@ -29,6 +30,8 @@ class UserModelOutput(BaseModel):
 
     user_id: Optional[str] = None
 
+    user_name: Optional[str] = None
+
     api_keys: Optional[List[APIKey]] = None
 
     metadata: Optional[UserModelOutputMetadata] = None

mixpeek/models/vectorbasedconfig.py

@@ -0,0 +1,60 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .clusteringmethod import ClusteringMethod
+from .hdbscanparameters import HDBSCANParameters, HDBSCANParametersTypedDict
+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 VectorBasedConfigTypedDict(TypedDict):
+    feature_extractor_name: str
+    r"""Name of the feature extractor to use for vector-based clustering"""
+    clustering_method: ClusteringMethod
+    sample_size: NotRequired[int]
+    r"""Maximum number of documents to process"""
+    hdbscan_parameters: NotRequired[Nullable[HDBSCANParametersTypedDict]]
+
+
+class VectorBasedConfig(BaseModel):
+    feature_extractor_name: str
+    r"""Name of the feature extractor to use for vector-based clustering"""
+
+    clustering_method: ClusteringMethod
+
+    sample_size: Optional[int] = 1000
+    r"""Maximum number of documents to process"""
+
+    hdbscan_parameters: OptionalNullable[HDBSCANParameters] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["sample_size", "hdbscan_parameters"]
+        nullable_fields = ["hdbscan_parameters"]
+        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/{collectionresult.py → vectorindex.py}

@@ -1,43 +1,48 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .vectortype import VectorType
 from mixpeek.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
 from typing_extensions import NotRequired, TypedDict
 
 
-class CollectionResultMetadataTypedDict(TypedDict):
-    pass
+class VectorIndexTypedDict(TypedDict):
+    r"""Base configuration for vector indexes"""
 
+    name: str
+    description: str
+    dimensions: int
+    type: VectorType
+    r"""Types of vectors supported"""
+    distance: NotRequired[Nullable[str]]
 
-class CollectionResultMetadata(BaseModel):
-    pass
 
+class VectorIndex(BaseModel):
+    r"""Base configuration for vector indexes"""
 
-class CollectionResultTypedDict(TypedDict):
-    collection_id: str
-    collection_name: NotRequired[Nullable[str]]
-    metadata: NotRequired[Nullable[CollectionResultMetadataTypedDict]]
+    name: str
 
+    description: str
 
-class CollectionResult(BaseModel):
-    collection_id: str
+    dimensions: int
 
-    collection_name: OptionalNullable[str] = UNSET
+    type: VectorType
+    r"""Types of vectors supported"""
 
-    metadata: OptionalNullable[CollectionResultMetadata] = UNSET
+    distance: OptionalNullable[str] = UNSET
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["collection_name", "metadata"]
-        nullable_fields = ["collection_name", "metadata"]
+        optional_fields = ["distance"]
+        nullable_fields = ["distance"]
         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/vectorindexdefinition.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .multivectorindex import MultiVectorIndex, MultiVectorIndexTypedDict
+from .vectorindex import VectorIndex, VectorIndexTypedDict
+from enum import Enum
+from mixpeek.types import BaseModel
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+class Type(str, Enum):
+    SINGLE = "single"
+    MULTI = "multi"
+
+
+IndexTypedDict = TypeAliasType(
+    "IndexTypedDict", Union[MultiVectorIndexTypedDict, VectorIndexTypedDict]
+)
+
+
+Index = TypeAliasType("Index", Union[MultiVectorIndex, VectorIndex])
+
+
+class VectorIndexDefinitionTypedDict(TypedDict):
+    r"""Complete vector index definition that can be either single or multi-vector"""
+
+    name: str
+    description: str
+    type: Type
+    index: IndexTypedDict
+
+
+class VectorIndexDefinition(BaseModel):
+    r"""Complete vector index definition that can be either single or multi-vector"""
+
+    name: str
+
+    description: str
+
+    type: Type
+
+    index: Index

mixpeek/models/vectortype.py

@@ -5,5 +5,8 @@ from enum import Enum
 
 
 class VectorType(str, Enum):
-    SPARSE = "sparse"
+    r"""Types of vectors supported"""
+
     DENSE = "dense"
+    SPARSE = "sparse"
+    INT8 = "int8"