together 1.5.17__py3-none-any.whl → 2.0.0a8__py3-none-any.whl

together/resources/embeddings.py

@@ -1,104 +1,208 @@
-from __future__ import annotations
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Any
+from __future__ import annotations
 
-from together.abstract import api_requestor
-from together.together_response import TogetherResponse
-from together.types import (
-    EmbeddingRequest,
-    EmbeddingResponse,
-    TogetherClient,
-    TogetherRequest,
+from typing import Union
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import embedding_create_params
+from .._types import Body, Query, Headers, NotGiven, SequenceNotStr, 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.embedding import Embedding
+
+__all__ = ["EmbeddingsResource", "AsyncEmbeddingsResource"]
 
 
-class Embeddings:
-    def __init__(self, client: TogetherClient) -> None:
-        self._client = client
+class EmbeddingsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> EmbeddingsResourceWithRawResponse:
+        """
+        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/togethercomputer/together-py#accessing-raw-response-data-eg-headers
+        """
+        return EmbeddingsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> EmbeddingsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/togethercomputer/together-py#with_streaming_response
+        """
+        return EmbeddingsResourceWithStreamingResponse(self)
 
     def create(
         self,
         *,
-        input: str | List[str],
-        model: str,
-        **kwargs: Any,
-    ) -> EmbeddingResponse:
+        input: Union[str, SequenceNotStr[str]],
+        model: Union[
+            Literal[
+                "WhereIsAI/UAE-Large-V1",
+                "BAAI/bge-large-en-v1.5",
+                "BAAI/bge-base-en-v1.5",
+                "togethercomputer/m2-bert-80M-8k-retrieval",
+            ],
+            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,
+    ) -> Embedding:
         """
-        Method to generate completions based on a given prompt using a specified model.
+        Query an embedding model for a given string of text.
 
         Args:
-            input (str | List[str]): A string or list of strings to embed
-            model (str): The name of the model to query.
+          input: A string providing the text for the model to embed.
 
-        Returns:
-            EmbeddingResponse: Object containing embeddings
-        """
+          model: The name of the embedding model to use.
 
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
-        )
+              [See all of Together AI's embedding models](https://docs.together.ai/docs/serverless-models#embedding-models)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
 
-        parameter_payload = EmbeddingRequest(
-            input=input,
-            model=model,
-            **kwargs,
-        ).model_dump(exclude_none=True)
-
-        response, _, _ = requestor.request(
-            options=TogetherRequest(
-                method="POST",
-                url="embeddings",
-                params=parameter_payload,
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/embeddings",
+            body=maybe_transform(
+                {
+                    "input": input,
+                    "model": model,
+                },
+                embedding_create_params.EmbeddingCreateParams,
             ),
-            stream=False,
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Embedding,
         )
 
-        assert isinstance(response, TogetherResponse)
 
-        return EmbeddingResponse(**response.data)
+class AsyncEmbeddingsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncEmbeddingsResourceWithRawResponse:
+        """
+        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/togethercomputer/together-py#accessing-raw-response-data-eg-headers
+        """
+        return AsyncEmbeddingsResourceWithRawResponse(self)
 
-class AsyncEmbeddings:
-    def __init__(self, client: TogetherClient) -> None:
-        self._client = client
+    @cached_property
+    def with_streaming_response(self) -> AsyncEmbeddingsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/togethercomputer/together-py#with_streaming_response
+        """
+        return AsyncEmbeddingsResourceWithStreamingResponse(self)
 
     async def create(
         self,
         *,
-        input: str | List[str],
-        model: str,
-        **kwargs: Any,
-    ) -> EmbeddingResponse:
+        input: Union[str, SequenceNotStr[str]],
+        model: Union[
+            Literal[
+                "WhereIsAI/UAE-Large-V1",
+                "BAAI/bge-large-en-v1.5",
+                "BAAI/bge-base-en-v1.5",
+                "togethercomputer/m2-bert-80M-8k-retrieval",
+            ],
+            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,
+    ) -> Embedding:
         """
-        Async method to generate completions based on a given prompt using a specified model.
+        Query an embedding model for a given string of text.
 
         Args:
-            input (str | List[str]): A string or list of strings to embed
-            model (str): The name of the model to query.
+          input: A string providing the text for the model to embed.
+
+          model: The name of the embedding model to use.
+
+              [See all of Together AI's embedding models](https://docs.together.ai/docs/serverless-models#embedding-models)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
 
-        Returns:
-            EmbeddingResponse: Object containing embeddings
+          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(
+            "/embeddings",
+            body=await async_maybe_transform(
+                {
+                    "input": input,
+                    "model": model,
+                },
+                embedding_create_params.EmbeddingCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Embedding,
+        )
+
 
-        requestor = api_requestor.APIRequestor(
-            client=self._client,
+class EmbeddingsResourceWithRawResponse:
+    def __init__(self, embeddings: EmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = to_raw_response_wrapper(
+            embeddings.create,
         )
 
-        parameter_payload = EmbeddingRequest(
-            input=input,
-            model=model,
-            **kwargs,
-        ).model_dump(exclude_none=True)
-
-        response, _, _ = await requestor.arequest(
-            options=TogetherRequest(
-                method="POST",
-                url="embeddings",
-                params=parameter_payload,
-            ),
-            stream=False,
+
+class AsyncEmbeddingsResourceWithRawResponse:
+    def __init__(self, embeddings: AsyncEmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = async_to_raw_response_wrapper(
+            embeddings.create,
+        )
+
+
+class EmbeddingsResourceWithStreamingResponse:
+    def __init__(self, embeddings: EmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = to_streamed_response_wrapper(
+            embeddings.create,
         )
 
-        assert isinstance(response, TogetherResponse)
 
-        return EmbeddingResponse(**response.data)
+class AsyncEmbeddingsResourceWithStreamingResponse:
+    def __init__(self, embeddings: AsyncEmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = async_to_streamed_response_wrapper(
+            embeddings.create,
+        )