llama-cloud 0.1.41__py3-none-any.whl → 1.0.0b4__py3-none-any.whl

llama_cloud/resources/pipelines/images.py

@@ -0,0 +1,513 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+
+import httpx
+
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._utils import maybe_transform, 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
+from ...types.pipelines import (
+    image_get_page_figure_params,
+    image_list_page_figures_params,
+    image_get_page_screenshot_params,
+    image_list_page_screenshots_params,
+)
+from ...types.pipelines.image_list_page_figures_response import ImageListPageFiguresResponse
+from ...types.pipelines.image_list_page_screenshots_response import ImageListPageScreenshotsResponse
+
+__all__ = ["ImagesResource", "AsyncImagesResource"]
+
+
+class ImagesResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ImagesResourceWithRawResponse:
+        """
+        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/run-llama/llama-cloud-py#accessing-raw-response-data-eg-headers
+        """
+        return ImagesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ImagesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/run-llama/llama-cloud-py#with_streaming_response
+        """
+        return ImagesResourceWithStreamingResponse(self)
+
+    def get_page_figure(
+        self,
+        figure_name: str,
+        *,
+        id: str,
+        page_index: int,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> object:
+        """
+        Get a specific figure from a page of a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not figure_name:
+            raise ValueError(f"Expected a non-empty value for `figure_name` but received {figure_name!r}")
+        return self._get(
+            f"/api/v1/files/{id}/page-figures/{page_index}/{figure_name}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_get_page_figure_params.ImageGetPageFigureParams,
+                ),
+            ),
+            cast_to=object,
+        )
+
+    def get_page_screenshot(
+        self,
+        page_index: int,
+        *,
+        id: str,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> object:
+        """
+        Get screenshot of a page from a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/api/v1/files/{id}/page_screenshots/{page_index}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_get_page_screenshot_params.ImageGetPageScreenshotParams,
+                ),
+            ),
+            cast_to=object,
+        )
+
+    def list_page_figures(
+        self,
+        id: str,
+        *,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> ImageListPageFiguresResponse:
+        """
+        List metadata for all figures from all pages of a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/api/v1/files/{id}/page-figures",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_list_page_figures_params.ImageListPageFiguresParams,
+                ),
+            ),
+            cast_to=ImageListPageFiguresResponse,
+        )
+
+    def list_page_screenshots(
+        self,
+        id: str,
+        *,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> ImageListPageScreenshotsResponse:
+        """
+        List metadata for all screenshots of pages from a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/api/v1/files/{id}/page_screenshots",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_list_page_screenshots_params.ImageListPageScreenshotsParams,
+                ),
+            ),
+            cast_to=ImageListPageScreenshotsResponse,
+        )
+
+
+class AsyncImagesResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncImagesResourceWithRawResponse:
+        """
+        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/run-llama/llama-cloud-py#accessing-raw-response-data-eg-headers
+        """
+        return AsyncImagesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncImagesResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/run-llama/llama-cloud-py#with_streaming_response
+        """
+        return AsyncImagesResourceWithStreamingResponse(self)
+
+    async def get_page_figure(
+        self,
+        figure_name: str,
+        *,
+        id: str,
+        page_index: int,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> object:
+        """
+        Get a specific figure from a page of a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not figure_name:
+            raise ValueError(f"Expected a non-empty value for `figure_name` but received {figure_name!r}")
+        return await self._get(
+            f"/api/v1/files/{id}/page-figures/{page_index}/{figure_name}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_get_page_figure_params.ImageGetPageFigureParams,
+                ),
+            ),
+            cast_to=object,
+        )
+
+    async def get_page_screenshot(
+        self,
+        page_index: int,
+        *,
+        id: str,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> object:
+        """
+        Get screenshot of a page from a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/api/v1/files/{id}/page_screenshots/{page_index}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_get_page_screenshot_params.ImageGetPageScreenshotParams,
+                ),
+            ),
+            cast_to=object,
+        )
+
+    async def list_page_figures(
+        self,
+        id: str,
+        *,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> ImageListPageFiguresResponse:
+        """
+        List metadata for all figures from all pages of a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/api/v1/files/{id}/page-figures",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_list_page_figures_params.ImageListPageFiguresParams,
+                ),
+            ),
+            cast_to=ImageListPageFiguresResponse,
+        )
+
+    async def list_page_screenshots(
+        self,
+        id: str,
+        *,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: 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,
+    ) -> ImageListPageScreenshotsResponse:
+        """
+        List metadata for all screenshots of pages from a file.
+
+        Args:
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/api/v1/files/{id}/page_screenshots",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "organization_id": organization_id,
+                        "project_id": project_id,
+                    },
+                    image_list_page_screenshots_params.ImageListPageScreenshotsParams,
+                ),
+            ),
+            cast_to=ImageListPageScreenshotsResponse,
+        )
+
+
+class ImagesResourceWithRawResponse:
+    def __init__(self, images: ImagesResource) -> None:
+        self._images = images
+
+        self.get_page_figure = to_raw_response_wrapper(
+            images.get_page_figure,
+        )
+        self.get_page_screenshot = to_raw_response_wrapper(
+            images.get_page_screenshot,
+        )
+        self.list_page_figures = to_raw_response_wrapper(
+            images.list_page_figures,
+        )
+        self.list_page_screenshots = to_raw_response_wrapper(
+            images.list_page_screenshots,
+        )
+
+
+class AsyncImagesResourceWithRawResponse:
+    def __init__(self, images: AsyncImagesResource) -> None:
+        self._images = images
+
+        self.get_page_figure = async_to_raw_response_wrapper(
+            images.get_page_figure,
+        )
+        self.get_page_screenshot = async_to_raw_response_wrapper(
+            images.get_page_screenshot,
+        )
+        self.list_page_figures = async_to_raw_response_wrapper(
+            images.list_page_figures,
+        )
+        self.list_page_screenshots = async_to_raw_response_wrapper(
+            images.list_page_screenshots,
+        )
+
+
+class ImagesResourceWithStreamingResponse:
+    def __init__(self, images: ImagesResource) -> None:
+        self._images = images
+
+        self.get_page_figure = to_streamed_response_wrapper(
+            images.get_page_figure,
+        )
+        self.get_page_screenshot = to_streamed_response_wrapper(
+            images.get_page_screenshot,
+        )
+        self.list_page_figures = to_streamed_response_wrapper(
+            images.list_page_figures,
+        )
+        self.list_page_screenshots = to_streamed_response_wrapper(
+            images.list_page_screenshots,
+        )
+
+
+class AsyncImagesResourceWithStreamingResponse:
+    def __init__(self, images: AsyncImagesResource) -> None:
+        self._images = images
+
+        self.get_page_figure = async_to_streamed_response_wrapper(
+            images.get_page_figure,
+        )
+        self.get_page_screenshot = async_to_streamed_response_wrapper(
+            images.get_page_screenshot,
+        )
+        self.list_page_figures = async_to_streamed_response_wrapper(
+            images.list_page_figures,
+        )
+        self.list_page_screenshots = async_to_streamed_response_wrapper(
+            images.list_page_screenshots,
+        )