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

mixpeek/resources/tasks.py

@@ -1,258 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-import httpx
-
-from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
-from .._utils import strip_not_given
-from .._compat import cached_property
-from .._resource import SyncAPIResource, AsyncAPIResource
-from .._response import (
-    to_raw_response_wrapper,
-    to_streamed_response_wrapper,
-    async_to_raw_response_wrapper,
-    async_to_streamed_response_wrapper,
-)
-from .._base_client import make_request_options
-from ..types.shared.task_response import TaskResponse
-
-__all__ = ["TasksResource", "AsyncTasksResource"]
-
-
-class TasksResource(SyncAPIResource):
-    @cached_property
-    def with_raw_response(self) -> TasksResourceWithRawResponse:
-        """
-        This property can be used as a prefix for any HTTP method call to return the
-        the raw response object instead of the parsed content.
-
-        For more information, see https://www.github.com/mixpeek/python-client#accessing-raw-response-data-eg-headers
-        """
-        return TasksResourceWithRawResponse(self)
-
-    @cached_property
-    def with_streaming_response(self) -> TasksResourceWithStreamingResponse:
-        """
-        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
-
-        For more information, see https://www.github.com/mixpeek/python-client#with_streaming_response
-        """
-        return TasksResourceWithStreamingResponse(self)
-
-    def retrieve(
-        self,
-        task_id: str,
-        *,
-        index_id: str | NotGiven = NOT_GIVEN,
-        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
-        # The extra values given here take precedence over values defined on the client or passed to this method.
-        extra_headers: Headers | None = None,
-        extra_query: Query | None = None,
-        extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> TaskResponse:
-        """
-        Get Task
-
-        Args:
-          index_id: filter by organization
-
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        if not task_id:
-            raise ValueError(f"Expected a non-empty value for `task_id` but received {task_id!r}")
-        extra_headers = {**strip_not_given({"index-id": index_id}), **(extra_headers or {})}
-        return self._get(
-            f"/tasks/{task_id}",
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=TaskResponse,
-        )
-
-    def delete(
-        self,
-        task_id: str,
-        *,
-        index_id: str | NotGiven = NOT_GIVEN,
-        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
-        # The extra values given here take precedence over values defined on the client or passed to this method.
-        extra_headers: Headers | None = None,
-        extra_query: Query | None = None,
-        extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> object:
-        """
-        Kill Task
-
-        Args:
-          index_id: filter by organization
-
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        if not task_id:
-            raise ValueError(f"Expected a non-empty value for `task_id` but received {task_id!r}")
-        extra_headers = {**strip_not_given({"index-id": index_id}), **(extra_headers or {})}
-        return self._delete(
-            f"/tasks/{task_id}",
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=object,
-        )
-
-
-class AsyncTasksResource(AsyncAPIResource):
-    @cached_property
-    def with_raw_response(self) -> AsyncTasksResourceWithRawResponse:
-        """
-        This property can be used as a prefix for any HTTP method call to return the
-        the raw response object instead of the parsed content.
-
-        For more information, see https://www.github.com/mixpeek/python-client#accessing-raw-response-data-eg-headers
-        """
-        return AsyncTasksResourceWithRawResponse(self)
-
-    @cached_property
-    def with_streaming_response(self) -> AsyncTasksResourceWithStreamingResponse:
-        """
-        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
-
-        For more information, see https://www.github.com/mixpeek/python-client#with_streaming_response
-        """
-        return AsyncTasksResourceWithStreamingResponse(self)
-
-    async def retrieve(
-        self,
-        task_id: str,
-        *,
-        index_id: str | NotGiven = NOT_GIVEN,
-        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
-        # The extra values given here take precedence over values defined on the client or passed to this method.
-        extra_headers: Headers | None = None,
-        extra_query: Query | None = None,
-        extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> TaskResponse:
-        """
-        Get Task
-
-        Args:
-          index_id: filter by organization
-
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        if not task_id:
-            raise ValueError(f"Expected a non-empty value for `task_id` but received {task_id!r}")
-        extra_headers = {**strip_not_given({"index-id": index_id}), **(extra_headers or {})}
-        return await self._get(
-            f"/tasks/{task_id}",
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=TaskResponse,
-        )
-
-    async def delete(
-        self,
-        task_id: str,
-        *,
-        index_id: str | NotGiven = NOT_GIVEN,
-        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
-        # The extra values given here take precedence over values defined on the client or passed to this method.
-        extra_headers: Headers | None = None,
-        extra_query: Query | None = None,
-        extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> object:
-        """
-        Kill Task
-
-        Args:
-          index_id: filter by organization
-
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        if not task_id:
-            raise ValueError(f"Expected a non-empty value for `task_id` but received {task_id!r}")
-        extra_headers = {**strip_not_given({"index-id": index_id}), **(extra_headers or {})}
-        return await self._delete(
-            f"/tasks/{task_id}",
-            options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
-            ),
-            cast_to=object,
-        )
-
-
-class TasksResourceWithRawResponse:
-    def __init__(self, tasks: TasksResource) -> None:
-        self._tasks = tasks
-
-        self.retrieve = to_raw_response_wrapper(
-            tasks.retrieve,
-        )
-        self.delete = to_raw_response_wrapper(
-            tasks.delete,
-        )
-
-
-class AsyncTasksResourceWithRawResponse:
-    def __init__(self, tasks: AsyncTasksResource) -> None:
-        self._tasks = tasks
-
-        self.retrieve = async_to_raw_response_wrapper(
-            tasks.retrieve,
-        )
-        self.delete = async_to_raw_response_wrapper(
-            tasks.delete,
-        )
-
-
-class TasksResourceWithStreamingResponse:
-    def __init__(self, tasks: TasksResource) -> None:
-        self._tasks = tasks
-
-        self.retrieve = to_streamed_response_wrapper(
-            tasks.retrieve,
-        )
-        self.delete = to_streamed_response_wrapper(
-            tasks.delete,
-        )
-
-
-class AsyncTasksResourceWithStreamingResponse:
-    def __init__(self, tasks: AsyncTasksResource) -> None:
-        self._tasks = tasks
-
-        self.retrieve = async_to_streamed_response_wrapper(
-            tasks.retrieve,
-        )
-        self.delete = async_to_streamed_response_wrapper(
-            tasks.delete,
-        )

mixpeek/types/account_update_params.py

@@ -1,28 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing import Union, Iterable, Optional
-from datetime import datetime
-from typing_extensions import Annotated, TypedDict
-
-from .._utils import PropertyInfo
-
-__all__ = ["AccountUpdateParams", "APIKey"]
-
-
-class AccountUpdateParams(TypedDict, total=False):
-    api_keys: Optional[Iterable[APIKey]]
-
-    metadata: Optional[object]
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""
-
-
-class APIKey(TypedDict, total=False):
-    created_at: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-
-    key: str
-
-    name: str

mixpeek/types/asset_create_params.py

@@ -1,36 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing import List, Iterable, Optional
-from typing_extensions import Required, Annotated, TypedDict
-
-from .._utils import PropertyInfo
-from .shared_params.sort_option import SortOption
-from .shared_params.logical_operator import LogicalOperator
-
-__all__ = ["AssetCreateParams"]
-
-
-class AssetCreateParams(TypedDict, total=False):
-    collection_ids: Required[List[str]]
-    """Collection IDs to filter features"""
-
-    page: Optional[int]
-
-    page_size: int
-
-    filters: Optional[LogicalOperator]
-    """Complex nested query filters"""
-
-    select: Optional[Iterable[object]]
-    """List of fields to return in results, supports dot notation."""
-
-    sort: Optional[SortOption]
-    """List of fields to sort by, with direction (asc or desc).
-
-    NOTE: fields will require a specialty index to use this, consult with the team
-    """
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""

mixpeek/types/asset_create_response.py

@@ -1,15 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import List
-
-from .._models import BaseModel
-from .asset_response import AssetResponse
-from .shared.model_pagination_response import ModelPaginationResponse
-
-__all__ = ["AssetCreateResponse"]
-
-
-class AssetCreateResponse(BaseModel):
-    pagination: ModelPaginationResponse
-
-    results: List[AssetResponse]

mixpeek/types/asset_response.py

@@ -1,46 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import Optional
-from datetime import datetime
-
-from .._models import BaseModel
-
-__all__ = ["AssetResponse"]
-
-
-class AssetResponse(BaseModel):
-    asset_id: Optional[str] = None
-    """The unique identifier for the asset"""
-
-    collection_id: Optional[str] = None
-    """The ID of the collection the asset belongs to"""
-
-    created_at: Optional[datetime] = None
-    """MongoDB datetime format"""
-
-    error: Optional[str] = None
-    """The error message if the asset processing failed"""
-
-    metadata: Optional[object] = None
-    """Additional metadata associated with the asset"""
-
-    modality: Optional[str] = None
-    """The type of media"""
-
-    score: Optional[float] = None
-    """The relevance score of the asset"""
-
-    status: Optional[str] = None
-    """The current status of the asset processing"""
-
-    task_id: Optional[str] = None
-    """The task ID"""
-
-    unique_hash: Optional[str] = None
-    """The unique hash of the asset"""
-
-    updated_at: Optional[datetime] = None
-    """MongoDB datetime format"""
-
-    url: Optional[str] = None
-    """The URL where the asset can be accessed"""

mixpeek/types/asset_search_params.py

@@ -1,43 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing import List, Optional
-from typing_extensions import Required, Annotated, TypedDict
-
-from .._utils import PropertyInfo
-from .shared_params.sort_option import SortOption
-from .shared_params.logical_operator import LogicalOperator
-
-__all__ = ["AssetSearchParams", "Query"]
-
-
-class AssetSearchParams(TypedDict, total=False):
-    collection_ids: Required[List[str]]
-    """List of Collection IDs to search within, required"""
-
-    filters: Optional[LogicalOperator]
-    """Complex nested query filters"""
-
-    query: Optional[Query]
-    """
-    Structured query object specifying which fields to search in and what to search
-    for
-    """
-
-    select: Optional[List[str]]
-    """List of fields to return in results"""
-
-    sort: Optional[SortOption]
-    """List of fields to sort by"""
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""
-
-
-class Query(TypedDict, total=False):
-    key: Required[List[str]]
-    """Fields to search in. Can be a list of field names or '\\**' for all fields"""
-
-    value: Required[str]
-    """The search term to look for in the specified fields"""

mixpeek/types/asset_search_response.py

@@ -1,15 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import List
-
-from .._models import BaseModel
-from .asset_response import AssetResponse
-from .shared.model_pagination_response import ModelPaginationResponse
-
-__all__ = ["AssetSearchResponse"]
-
-
-class AssetSearchResponse(BaseModel):
-    pagination: ModelPaginationResponse
-
-    results: List[AssetResponse]

mixpeek/types/asset_update_params.py

@@ -1,25 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing import Optional
-from typing_extensions import Annotated, TypedDict
-
-from .._utils import PropertyInfo
-
-__all__ = ["AssetUpdateParams"]
-
-
-class AssetUpdateParams(TypedDict, total=False):
-    metadata: object
-    """Updated metadata for the asset.
-
-    This can include any key-value pairs that should be updated or added to the
-    asset's metadata.
-    """
-
-    propagate_features: Optional[bool]
-    """If True, the features will be propagated to all assets with the same asset_id"""
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""

mixpeek/types/asset_update_response.py

@@ -1,11 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import Union
-from typing_extensions import TypeAlias
-
-from .asset_response import AssetResponse
-from .grouped_asset_data import GroupedAssetData
-
-__all__ = ["AssetUpdateResponse"]
-
-AssetUpdateResponse: TypeAlias = Union[AssetResponse, GroupedAssetData]

mixpeek/types/assets/__init__.py

@@ -1,3 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations

mixpeek/types/collection_list_params.py

@@ -1,19 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing import Optional
-from typing_extensions import Annotated, TypedDict
-
-from .._utils import PropertyInfo
-
-__all__ = ["CollectionListParams"]
-
-
-class CollectionListParams(TypedDict, total=False):
-    page: Optional[int]
-
-    page_size: int
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""

mixpeek/types/collection_list_response.py

@@ -1,14 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import List
-
-from .._models import BaseModel
-from .shared.model_pagination_response import ModelPaginationResponse
-
-__all__ = ["CollectionListResponse"]
-
-
-class CollectionListResponse(BaseModel):
-    pagination: ModelPaginationResponse
-
-    results: List[object]

mixpeek/types/entities/__init__.py

@@ -1,13 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from .face_response import FaceResponse as FaceResponse
-from .label_response import LabelResponse as LabelResponse
-from .face_list_params import FaceListParams as FaceListParams
-from .label_list_params import LabelListParams as LabelListParams
-from .face_create_params import FaceCreateParams as FaceCreateParams
-from .face_list_response import FaceListResponse as FaceListResponse
-from .face_update_params import FaceUpdateParams as FaceUpdateParams
-from .label_list_response import LabelListResponse as LabelListResponse
-from .label_update_params import LabelUpdateParams as LabelUpdateParams

mixpeek/types/entities/face_create_params.py

@@ -1,21 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing_extensions import Required, Annotated, TypedDict
-
-from ..._types import FileTypes
-from ..._utils import PropertyInfo
-
-__all__ = ["FaceCreateParams"]
-
-
-class FaceCreateParams(TypedDict, total=False):
-    collection_id: Required[str]
-
-    file: Required[FileTypes]
-
-    metadata: str
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""

mixpeek/types/entities/face_list_params.py

@@ -1,18 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing_extensions import Annotated, TypedDict
-
-from ..._utils import PropertyInfo
-
-__all__ = ["FaceListParams"]
-
-
-class FaceListParams(TypedDict, total=False):
-    page: int
-
-    page_size: int
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""

mixpeek/types/entities/face_list_response.py

@@ -1,15 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import List
-
-from ..._models import BaseModel
-from .face_response import FaceResponse
-from ..shared.model_pagination_response import ModelPaginationResponse
-
-__all__ = ["FaceListResponse"]
-
-
-class FaceListResponse(BaseModel):
-    pagination: ModelPaginationResponse
-
-    results: List[FaceResponse]

mixpeek/types/entities/face_response.py

@@ -1,17 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import Optional
-
-from ..._models import BaseModel
-
-__all__ = ["FaceResponse"]
-
-
-class FaceResponse(BaseModel):
-    collection_id: str
-
-    face_id: str
-
-    metadata: Optional[object] = None
-
-    url: str

mixpeek/types/entities/face_update_params.py

@@ -1,22 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing_extensions import Required, Annotated, TypedDict
-
-from ..._utils import PropertyInfo
-
-__all__ = ["FaceUpdateParams"]
-
-
-class FaceUpdateParams(TypedDict, total=False):
-    path_face_id: Required[Annotated[str, PropertyInfo(alias="face_id")]]
-
-    collection_id: Required[str]
-
-    body_face_id: Required[Annotated[str, PropertyInfo(alias="face_id")]]
-
-    metadata: Required[object]
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""

mixpeek/types/entities/label_list_params.py

@@ -1,18 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from typing_extensions import Annotated, TypedDict
-
-from ..._utils import PropertyInfo
-
-__all__ = ["LabelListParams"]
-
-
-class LabelListParams(TypedDict, total=False):
-    page: int
-
-    page_size: int
-
-    index_id: Annotated[str, PropertyInfo(alias="index-id")]
-    """filter by organization"""