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

llama_cloud/resources/retrievers/retriever.py

@@ -0,0 +1,238 @@
+# 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 CompositeRetrievalMode
+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.retrievers import retriever_search_params
+from ...types.re_rank_config_param import ReRankConfigParam
+from ...types.composite_retrieval_mode import CompositeRetrievalMode
+from ...types.composite_retrieval_result import CompositeRetrievalResult
+
+__all__ = ["RetrieverResource", "AsyncRetrieverResource"]
+
+
+class RetrieverResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> RetrieverResourceWithRawResponse:
+        """
+        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 RetrieverResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> RetrieverResourceWithStreamingResponse:
+        """
+        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 RetrieverResourceWithStreamingResponse(self)
+
+    def search(
+        self,
+        retriever_id: str,
+        *,
+        query: str,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: Optional[str] | Omit = omit,
+        mode: CompositeRetrievalMode | Omit = omit,
+        rerank_config: ReRankConfigParam | Omit = omit,
+        rerank_top_n: Optional[int] | 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,
+    ) -> CompositeRetrievalResult:
+        """
+        Retrieve data using a Retriever.
+
+        Args:
+          query: The query to retrieve against.
+
+          mode: The mode of composite retrieval.
+
+          rerank_config: The rerank configuration for composite retrieval.
+
+          rerank_top_n: (use rerank_config.top_n instead) The number of nodes to retrieve after
+              reranking over retrieved nodes from all retrieval tools.
+
+          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 retriever_id:
+            raise ValueError(f"Expected a non-empty value for `retriever_id` but received {retriever_id!r}")
+        return self._post(
+            f"/api/v1/retrievers/{retriever_id}/retrieve",
+            body=maybe_transform(
+                {
+                    "query": query,
+                    "mode": mode,
+                    "rerank_config": rerank_config,
+                    "rerank_top_n": rerank_top_n,
+                },
+                retriever_search_params.RetrieverSearchParams,
+            ),
+            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,
+                    },
+                    retriever_search_params.RetrieverSearchParams,
+                ),
+            ),
+            cast_to=CompositeRetrievalResult,
+        )
+
+
+class AsyncRetrieverResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncRetrieverResourceWithRawResponse:
+        """
+        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 AsyncRetrieverResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncRetrieverResourceWithStreamingResponse:
+        """
+        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 AsyncRetrieverResourceWithStreamingResponse(self)
+
+    async def search(
+        self,
+        retriever_id: str,
+        *,
+        query: str,
+        organization_id: Optional[str] | Omit = omit,
+        project_id: Optional[str] | Omit = omit,
+        mode: CompositeRetrievalMode | Omit = omit,
+        rerank_config: ReRankConfigParam | Omit = omit,
+        rerank_top_n: Optional[int] | 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,
+    ) -> CompositeRetrievalResult:
+        """
+        Retrieve data using a Retriever.
+
+        Args:
+          query: The query to retrieve against.
+
+          mode: The mode of composite retrieval.
+
+          rerank_config: The rerank configuration for composite retrieval.
+
+          rerank_top_n: (use rerank_config.top_n instead) The number of nodes to retrieve after
+              reranking over retrieved nodes from all retrieval tools.
+
+          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 retriever_id:
+            raise ValueError(f"Expected a non-empty value for `retriever_id` but received {retriever_id!r}")
+        return await self._post(
+            f"/api/v1/retrievers/{retriever_id}/retrieve",
+            body=await async_maybe_transform(
+                {
+                    "query": query,
+                    "mode": mode,
+                    "rerank_config": rerank_config,
+                    "rerank_top_n": rerank_top_n,
+                },
+                retriever_search_params.RetrieverSearchParams,
+            ),
+            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,
+                    },
+                    retriever_search_params.RetrieverSearchParams,
+                ),
+            ),
+            cast_to=CompositeRetrievalResult,
+        )
+
+
+class RetrieverResourceWithRawResponse:
+    def __init__(self, retriever: RetrieverResource) -> None:
+        self._retriever = retriever
+
+        self.search = to_raw_response_wrapper(
+            retriever.search,
+        )
+
+
+class AsyncRetrieverResourceWithRawResponse:
+    def __init__(self, retriever: AsyncRetrieverResource) -> None:
+        self._retriever = retriever
+
+        self.search = async_to_raw_response_wrapper(
+            retriever.search,
+        )
+
+
+class RetrieverResourceWithStreamingResponse:
+    def __init__(self, retriever: RetrieverResource) -> None:
+        self._retriever = retriever
+
+        self.search = to_streamed_response_wrapper(
+            retriever.search,
+        )
+
+
+class AsyncRetrieverResourceWithStreamingResponse:
+    def __init__(self, retriever: AsyncRetrieverResource) -> None:
+        self._retriever = retriever
+
+        self.search = async_to_streamed_response_wrapper(
+            retriever.search,
+        )