mixpeek 0.8.41__py3-none-any.whl → 0.9.0__py3-none-any.whl

mixpeek_sdk/resources/collections/__init__.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .files import (
+    FilesResource,
+    AsyncFilesResource,
+    FilesResourceWithRawResponse,
+    AsyncFilesResourceWithRawResponse,
+    FilesResourceWithStreamingResponse,
+    AsyncFilesResourceWithStreamingResponse,
+)
+from .collections import (
+    CollectionsResource,
+    AsyncCollectionsResource,
+    CollectionsResourceWithRawResponse,
+    AsyncCollectionsResourceWithRawResponse,
+    CollectionsResourceWithStreamingResponse,
+    AsyncCollectionsResourceWithStreamingResponse,
+)
+
+__all__ = [
+    "FilesResource",
+    "AsyncFilesResource",
+    "FilesResourceWithRawResponse",
+    "AsyncFilesResourceWithRawResponse",
+    "FilesResourceWithStreamingResponse",
+    "AsyncFilesResourceWithStreamingResponse",
+    "CollectionsResource",
+    "AsyncCollectionsResource",
+    "CollectionsResourceWithRawResponse",
+    "AsyncCollectionsResourceWithRawResponse",
+    "CollectionsResourceWithStreamingResponse",
+    "AsyncCollectionsResourceWithStreamingResponse",
+]

mixpeek_sdk/resources/collections/collections.py

@@ -0,0 +1,459 @@
+# 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 Literal
+
+import httpx
+
+from .files import (
+    FilesResource,
+    AsyncFilesResource,
+    FilesResourceWithRawResponse,
+    AsyncFilesResourceWithRawResponse,
+    FilesResourceWithStreamingResponse,
+    AsyncFilesResourceWithStreamingResponse,
+)
+from ...types import collection_search_params
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import (
+    maybe_transform,
+    strip_not_given,
+    async_maybe_transform,
+)
+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
+
+__all__ = ["CollectionsResource", "AsyncCollectionsResource"]
+
+
+class CollectionsResource(SyncAPIResource):
+    @cached_property
+    def files(self) -> FilesResource:
+        return FilesResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> CollectionsResourceWithRawResponse:
+        """
+        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 CollectionsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> CollectionsResourceWithStreamingResponse:
+        """
+        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 CollectionsResourceWithStreamingResponse(self)
+
+    def list(
+        self,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        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:
+        """
+        List Collections
+
+        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
+        """
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._get(
+            "/collections/",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    def delete(
+        self,
+        collection_id: str,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        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:
+        """
+        Delete Collection
+
+        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 collection_id:
+            raise ValueError(f"Expected a non-empty value for `collection_id` but received {collection_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._delete(
+            f"/collections/{collection_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    def search(
+        self,
+        *,
+        collection_id: str,
+        query: str,
+        page: int | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        sort_by: Optional[str] | NotGiven = NOT_GIVEN,
+        sort_order: Optional[Literal["asc", "desc"]] | NotGiven = NOT_GIVEN,
+        authorization: str | NotGiven = NOT_GIVEN,
+        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:
+        """
+        Search Files
+
+        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
+        """
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return self._post(
+            "/collections/search",
+            body=maybe_transform(
+                {
+                    "collection_id": collection_id,
+                    "query": query,
+                    "page": page,
+                    "page_size": page_size,
+                    "sort_by": sort_by,
+                    "sort_order": sort_order,
+                },
+                collection_search_params.CollectionSearchParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+
+class AsyncCollectionsResource(AsyncAPIResource):
+    @cached_property
+    def files(self) -> AsyncFilesResource:
+        return AsyncFilesResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncCollectionsResourceWithRawResponse:
+        """
+        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 AsyncCollectionsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncCollectionsResourceWithStreamingResponse:
+        """
+        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 AsyncCollectionsResourceWithStreamingResponse(self)
+
+    async def list(
+        self,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        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:
+        """
+        List Collections
+
+        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
+        """
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._get(
+            "/collections/",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    async def delete(
+        self,
+        collection_id: str,
+        *,
+        authorization: str | NotGiven = NOT_GIVEN,
+        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:
+        """
+        Delete Collection
+
+        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 collection_id:
+            raise ValueError(f"Expected a non-empty value for `collection_id` but received {collection_id!r}")
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._delete(
+            f"/collections/{collection_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+    async def search(
+        self,
+        *,
+        collection_id: str,
+        query: str,
+        page: int | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        sort_by: Optional[str] | NotGiven = NOT_GIVEN,
+        sort_order: Optional[Literal["asc", "desc"]] | NotGiven = NOT_GIVEN,
+        authorization: str | NotGiven = NOT_GIVEN,
+        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:
+        """
+        Search Files
+
+        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
+        """
+        extra_headers = {
+            **strip_not_given(
+                {
+                    "Authorization": authorization,
+                    "index-id": index_id,
+                }
+            ),
+            **(extra_headers or {}),
+        }
+        return await self._post(
+            "/collections/search",
+            body=await async_maybe_transform(
+                {
+                    "collection_id": collection_id,
+                    "query": query,
+                    "page": page,
+                    "page_size": page_size,
+                    "sort_by": sort_by,
+                    "sort_order": sort_order,
+                },
+                collection_search_params.CollectionSearchParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+
+class CollectionsResourceWithRawResponse:
+    def __init__(self, collections: CollectionsResource) -> None:
+        self._collections = collections
+
+        self.list = to_raw_response_wrapper(
+            collections.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            collections.delete,
+        )
+        self.search = to_raw_response_wrapper(
+            collections.search,
+        )
+
+    @cached_property
+    def files(self) -> FilesResourceWithRawResponse:
+        return FilesResourceWithRawResponse(self._collections.files)
+
+
+class AsyncCollectionsResourceWithRawResponse:
+    def __init__(self, collections: AsyncCollectionsResource) -> None:
+        self._collections = collections
+
+        self.list = async_to_raw_response_wrapper(
+            collections.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            collections.delete,
+        )
+        self.search = async_to_raw_response_wrapper(
+            collections.search,
+        )
+
+    @cached_property
+    def files(self) -> AsyncFilesResourceWithRawResponse:
+        return AsyncFilesResourceWithRawResponse(self._collections.files)
+
+
+class CollectionsResourceWithStreamingResponse:
+    def __init__(self, collections: CollectionsResource) -> None:
+        self._collections = collections
+
+        self.list = to_streamed_response_wrapper(
+            collections.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            collections.delete,
+        )
+        self.search = to_streamed_response_wrapper(
+            collections.search,
+        )
+
+    @cached_property
+    def files(self) -> FilesResourceWithStreamingResponse:
+        return FilesResourceWithStreamingResponse(self._collections.files)
+
+
+class AsyncCollectionsResourceWithStreamingResponse:
+    def __init__(self, collections: AsyncCollectionsResource) -> None:
+        self._collections = collections
+
+        self.list = async_to_streamed_response_wrapper(
+            collections.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            collections.delete,
+        )
+        self.search = async_to_streamed_response_wrapper(
+            collections.search,
+        )
+
+    @cached_property
+    def files(self) -> AsyncFilesResourceWithStreamingResponse:
+        return AsyncFilesResourceWithStreamingResponse(self._collections.files)