letta-client 0.1.226__py3-none-any.whl → 1.7.2__py3-none-any.whl

letta_client/resources/archives/archives.py

@@ -0,0 +1,650 @@
+# 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 ...types import archive_list_params, archive_create_params, archive_update_params
+from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
+from ..._utils import maybe_transform, async_maybe_transform
+from .passages import (
+    PassagesResource,
+    AsyncPassagesResource,
+    PassagesResourceWithRawResponse,
+    AsyncPassagesResourceWithRawResponse,
+    PassagesResourceWithStreamingResponse,
+    AsyncPassagesResourceWithStreamingResponse,
+)
+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 ...pagination import SyncArrayPage, AsyncArrayPage
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.archive import Archive
+from ...types.embedding_config_param import EmbeddingConfigParam
+
+__all__ = ["ArchivesResource", "AsyncArchivesResource"]
+
+
+class ArchivesResource(SyncAPIResource):
+    @cached_property
+    def passages(self) -> PassagesResource:
+        return PassagesResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> ArchivesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/letta-ai/letta-python#accessing-raw-response-data-eg-headers
+        """
+        return ArchivesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ArchivesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/letta-ai/letta-python#with_streaming_response
+        """
+        return ArchivesResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        name: str,
+        description: Optional[str] | Omit = omit,
+        embedding: Optional[str] | Omit = omit,
+        embedding_config: Optional[EmbeddingConfigParam] | Omit = omit,
+        # 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,
+    ) -> Archive:
+        """
+        Create a new archive.
+
+        Args:
+          embedding: Embedding model handle for the archive
+
+          embedding_config: Configuration for embedding model connection and processing parameters.
+
+          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
+        """
+        return self._post(
+            "/v1/archives/",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "description": description,
+                    "embedding": embedding,
+                    "embedding_config": embedding_config,
+                },
+                archive_create_params.ArchiveCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Archive,
+        )
+
+    def retrieve(
+        self,
+        archive_id: str,
+        *,
+        # 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,
+    ) -> Archive:
+        """
+        Get a single archive by its ID.
+
+        Args:
+          archive_id: The ID of the archive in the format 'archive-<uuid4>'
+
+          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 archive_id:
+            raise ValueError(f"Expected a non-empty value for `archive_id` but received {archive_id!r}")
+        return self._get(
+            f"/v1/archives/{archive_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Archive,
+        )
+
+    def update(
+        self,
+        archive_id: str,
+        *,
+        description: Optional[str] | Omit = omit,
+        name: Optional[str] | Omit = omit,
+        # 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,
+    ) -> Archive:
+        """
+        Update an existing archive's name and/or description.
+
+        Args:
+          archive_id: The ID of the archive in the format 'archive-<uuid4>'
+
+          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 archive_id:
+            raise ValueError(f"Expected a non-empty value for `archive_id` but received {archive_id!r}")
+        return self._patch(
+            f"/v1/archives/{archive_id}",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                },
+                archive_update_params.ArchiveUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Archive,
+        )
+
+    def list(
+        self,
+        *,
+        after: Optional[str] | Omit = omit,
+        agent_id: Optional[str] | Omit = omit,
+        before: Optional[str] | Omit = omit,
+        limit: Optional[int] | Omit = omit,
+        name: Optional[str] | Omit = omit,
+        order: Literal["asc", "desc"] | Omit = omit,
+        order_by: Literal["created_at"] | Omit = omit,
+        # 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,
+    ) -> SyncArrayPage[Archive]:
+        """
+        Get a list of all archives for the current organization with optional filters
+        and pagination.
+
+        Args:
+          after: Archive ID cursor for pagination. Returns archives that come after this archive
+              ID in the specified sort order
+
+          agent_id: Only archives attached to this agent ID
+
+          before: Archive ID cursor for pagination. Returns archives that come before this archive
+              ID in the specified sort order
+
+          limit: Maximum number of archives to return
+
+          name: Filter by archive name (exact match)
+
+          order: Sort order for archives by creation time. 'asc' for oldest first, 'desc' for
+              newest first
+
+          order_by: Field to sort by
+
+          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
+        """
+        return self._get_api_list(
+            "/v1/archives/",
+            page=SyncArrayPage[Archive],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "after": after,
+                        "agent_id": agent_id,
+                        "before": before,
+                        "limit": limit,
+                        "name": name,
+                        "order": order,
+                        "order_by": order_by,
+                    },
+                    archive_list_params.ArchiveListParams,
+                ),
+            ),
+            model=Archive,
+        )
+
+    def delete(
+        self,
+        archive_id: str,
+        *,
+        # 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,
+    ) -> None:
+        """
+        Delete an archive by its ID.
+
+        Args:
+          archive_id: The ID of the archive in the format 'archive-<uuid4>'
+
+          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 archive_id:
+            raise ValueError(f"Expected a non-empty value for `archive_id` but received {archive_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            f"/v1/archives/{archive_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncArchivesResource(AsyncAPIResource):
+    @cached_property
+    def passages(self) -> AsyncPassagesResource:
+        return AsyncPassagesResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncArchivesResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/letta-ai/letta-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncArchivesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncArchivesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/letta-ai/letta-python#with_streaming_response
+        """
+        return AsyncArchivesResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        name: str,
+        description: Optional[str] | Omit = omit,
+        embedding: Optional[str] | Omit = omit,
+        embedding_config: Optional[EmbeddingConfigParam] | Omit = omit,
+        # 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,
+    ) -> Archive:
+        """
+        Create a new archive.
+
+        Args:
+          embedding: Embedding model handle for the archive
+
+          embedding_config: Configuration for embedding model connection and processing parameters.
+
+          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
+        """
+        return await self._post(
+            "/v1/archives/",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "description": description,
+                    "embedding": embedding,
+                    "embedding_config": embedding_config,
+                },
+                archive_create_params.ArchiveCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Archive,
+        )
+
+    async def retrieve(
+        self,
+        archive_id: str,
+        *,
+        # 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,
+    ) -> Archive:
+        """
+        Get a single archive by its ID.
+
+        Args:
+          archive_id: The ID of the archive in the format 'archive-<uuid4>'
+
+          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 archive_id:
+            raise ValueError(f"Expected a non-empty value for `archive_id` but received {archive_id!r}")
+        return await self._get(
+            f"/v1/archives/{archive_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Archive,
+        )
+
+    async def update(
+        self,
+        archive_id: str,
+        *,
+        description: Optional[str] | Omit = omit,
+        name: Optional[str] | Omit = omit,
+        # 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,
+    ) -> Archive:
+        """
+        Update an existing archive's name and/or description.
+
+        Args:
+          archive_id: The ID of the archive in the format 'archive-<uuid4>'
+
+          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 archive_id:
+            raise ValueError(f"Expected a non-empty value for `archive_id` but received {archive_id!r}")
+        return await self._patch(
+            f"/v1/archives/{archive_id}",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                },
+                archive_update_params.ArchiveUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Archive,
+        )
+
+    def list(
+        self,
+        *,
+        after: Optional[str] | Omit = omit,
+        agent_id: Optional[str] | Omit = omit,
+        before: Optional[str] | Omit = omit,
+        limit: Optional[int] | Omit = omit,
+        name: Optional[str] | Omit = omit,
+        order: Literal["asc", "desc"] | Omit = omit,
+        order_by: Literal["created_at"] | Omit = omit,
+        # 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,
+    ) -> AsyncPaginator[Archive, AsyncArrayPage[Archive]]:
+        """
+        Get a list of all archives for the current organization with optional filters
+        and pagination.
+
+        Args:
+          after: Archive ID cursor for pagination. Returns archives that come after this archive
+              ID in the specified sort order
+
+          agent_id: Only archives attached to this agent ID
+
+          before: Archive ID cursor for pagination. Returns archives that come before this archive
+              ID in the specified sort order
+
+          limit: Maximum number of archives to return
+
+          name: Filter by archive name (exact match)
+
+          order: Sort order for archives by creation time. 'asc' for oldest first, 'desc' for
+              newest first
+
+          order_by: Field to sort by
+
+          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
+        """
+        return self._get_api_list(
+            "/v1/archives/",
+            page=AsyncArrayPage[Archive],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "after": after,
+                        "agent_id": agent_id,
+                        "before": before,
+                        "limit": limit,
+                        "name": name,
+                        "order": order,
+                        "order_by": order_by,
+                    },
+                    archive_list_params.ArchiveListParams,
+                ),
+            ),
+            model=Archive,
+        )
+
+    async def delete(
+        self,
+        archive_id: str,
+        *,
+        # 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,
+    ) -> None:
+        """
+        Delete an archive by its ID.
+
+        Args:
+          archive_id: The ID of the archive in the format 'archive-<uuid4>'
+
+          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 archive_id:
+            raise ValueError(f"Expected a non-empty value for `archive_id` but received {archive_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            f"/v1/archives/{archive_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class ArchivesResourceWithRawResponse:
+    def __init__(self, archives: ArchivesResource) -> None:
+        self._archives = archives
+
+        self.create = to_raw_response_wrapper(
+            archives.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            archives.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            archives.update,
+        )
+        self.list = to_raw_response_wrapper(
+            archives.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            archives.delete,
+        )
+
+    @cached_property
+    def passages(self) -> PassagesResourceWithRawResponse:
+        return PassagesResourceWithRawResponse(self._archives.passages)
+
+
+class AsyncArchivesResourceWithRawResponse:
+    def __init__(self, archives: AsyncArchivesResource) -> None:
+        self._archives = archives
+
+        self.create = async_to_raw_response_wrapper(
+            archives.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            archives.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            archives.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            archives.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            archives.delete,
+        )
+
+    @cached_property
+    def passages(self) -> AsyncPassagesResourceWithRawResponse:
+        return AsyncPassagesResourceWithRawResponse(self._archives.passages)
+
+
+class ArchivesResourceWithStreamingResponse:
+    def __init__(self, archives: ArchivesResource) -> None:
+        self._archives = archives
+
+        self.create = to_streamed_response_wrapper(
+            archives.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            archives.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            archives.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            archives.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            archives.delete,
+        )
+
+    @cached_property
+    def passages(self) -> PassagesResourceWithStreamingResponse:
+        return PassagesResourceWithStreamingResponse(self._archives.passages)
+
+
+class AsyncArchivesResourceWithStreamingResponse:
+    def __init__(self, archives: AsyncArchivesResource) -> None:
+        self._archives = archives
+
+        self.create = async_to_streamed_response_wrapper(
+            archives.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            archives.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            archives.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            archives.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            archives.delete,
+        )
+
+    @cached_property
+    def passages(self) -> AsyncPassagesResourceWithStreamingResponse:
+        return AsyncPassagesResourceWithStreamingResponse(self._archives.passages)