together 1.3.13__py3-none-any.whl → 1.4.0__py3-none-any.whl

together/abstract/api_requestor.py

@@ -78,7 +78,7 @@ def parse_stream_helper(line: bytes) -> str | None:
             line = line[len(b"data: ") :]
         else:
             line = line[len(b"data:") :]
-        if line.strip() == b"[DONE]":
+        if line.strip().upper() == b"[DONE]":
             # return here will cause GeneratorExit exception in urllib3
             # and it will close http connection with TCP Reset
             return None
@@ -620,7 +620,8 @@ class APIRequestor:
         self, result: requests.Response, stream: bool
     ) -> Tuple[TogetherResponse | Iterator[TogetherResponse], bool]:
         """Returns the response(s) and a bool indicating whether it is a stream."""
-        if stream and "text/event-stream" in result.headers.get("Content-Type", ""):
+        content_type = result.headers.get("Content-Type", "")
+        if stream and "text/event-stream" in content_type:
             return (
                 self._interpret_response_line(
                     line, result.status_code, result.headers, stream=True
@@ -628,9 +629,13 @@ class APIRequestor:
                 for line in parse_stream(result.iter_lines())
             ), True
         else:
+            if content_type in ["application/octet-stream", "audio/wav", "audio/mpeg"]:
+                content = result.content
+            else:
+                content = result.content.decode("utf-8")
             return (
                 self._interpret_response_line(
-                    result.content.decode("utf-8"),
+                    content,
                     result.status_code,
                     result.headers,
                     stream=False,
@@ -670,7 +675,7 @@ class APIRequestor:
             )
 
     def _interpret_response_line(
-        self, rbody: str, rcode: int, rheaders: Any, stream: bool
+        self, rbody: str | bytes, rcode: int, rheaders: Any, stream: bool
     ) -> TogetherResponse:
         # HTTP 204 response code does not have any content in the body.
         if rcode == 204:
@@ -684,13 +689,16 @@ class APIRequestor:
             )
 
         try:
-            if "text/plain" in rheaders.get("Content-Type", ""):
-                data: Dict[str, Any] = {"message": rbody}
+            content_type = rheaders.get("Content-Type", "")
+            if isinstance(rbody, bytes):
+                data: Dict[str, Any] | bytes = rbody
+            elif "text/plain" in content_type:
+                data = {"message": rbody}
             else:
                 data = json.loads(rbody)
         except (JSONDecodeError, UnicodeDecodeError) as e:
             raise error.APIError(
-                f"Error code: {rcode} -{rbody}",
+                f"Error code: {rcode} -{rbody if isinstance(rbody, str) else rbody.decode()}",
                 http_status=rcode,
                 headers=rheaders,
             ) from e

together/client.py

@@ -19,6 +19,7 @@ class Together:
     models: resources.Models
     fine_tuning: resources.FineTuning
     rerank: resources.Rerank
+    audio: resources.Audio
 
     # client options
     client: TogetherClient
@@ -79,6 +80,7 @@ class Together:
         self.models = resources.Models(self.client)
         self.fine_tuning = resources.FineTuning(self.client)
         self.rerank = resources.Rerank(self.client)
+        self.audio = resources.Audio(self.client)
 
 
 class AsyncTogether:

together/resources/__init__.py

@@ -6,6 +6,7 @@ from together.resources.finetune import AsyncFineTuning, FineTuning
 from together.resources.images import AsyncImages, Images
 from together.resources.models import AsyncModels, Models
 from together.resources.rerank import AsyncRerank, Rerank
+from together.resources.audio import AsyncAudio, Audio
 
 
 __all__ = [
@@ -25,4 +26,6 @@ __all__ = [
     "Models",
     "AsyncRerank",
     "Rerank",
+    "AsyncAudio",
+    "Audio",
 ]

together/resources/audio/__init__.py

@@ -0,0 +1,24 @@
+from functools import cached_property
+
+from together.resources.audio.speech import AsyncSpeech, Speech
+from together.types import (
+    TogetherClient,
+)
+
+
+class Audio:
+    def __init__(self, client: TogetherClient) -> None:
+        self._client = client
+
+    @cached_property
+    def speech(self) -> Speech:
+        return Speech(self._client)
+
+
+class AsyncAudio:
+    def __init__(self, client: TogetherClient) -> None:
+        self._client = client
+
+    @cached_property
+    def speech(self) -> AsyncSpeech:
+        return AsyncSpeech(self._client)

together/resources/audio/speech.py

@@ -0,0 +1,153 @@
+from __future__ import annotations
+
+from typing import Any, AsyncGenerator, Dict, Iterator, List, Union
+
+from together.abstract import api_requestor
+from together.together_response import TogetherResponse
+from together.types import (
+    AudioSpeechRequest,
+    AudioResponseFormat,
+    AudioLanguage,
+    AudioResponseEncoding,
+    AudioSpeechStreamChunk,
+    AudioSpeechStreamEvent,
+    AudioSpeechStreamResponse,
+    TogetherClient,
+    TogetherRequest,
+)
+
+
+class Speech:
+    def __init__(self, client: TogetherClient) -> None:
+        self._client = client
+
+    def create(
+        self,
+        *,
+        model: str,
+        input: str,
+        voice: str | None = None,
+        response_format: str = "wav",
+        language: str = "en",
+        response_encoding: str = "pcm_f32le",
+        sample_rate: int = 44100,
+        stream: bool = False,
+        **kwargs: Any,
+    ) -> AudioSpeechStreamResponse:
+        """
+        Method to generate audio from input text using a specified model.
+
+        Args:
+            model (str): The name of the model to query.
+            input (str): Input text to generate the audio for.
+            voice (str, optional): The voice to use for generating the audio.
+                Defaults to None.
+            response_format (str, optional): The format of audio output.
+                Defaults to "wav".
+            language (str, optional): Language of input text.
+                Defaults to "en".
+            response_encoding (str, optional): Audio encoding of response.
+                Defaults to "pcm_f32le".
+            sample_rate (int, optional): Sampling rate to use for the output audio.
+                Defaults to 44100.
+            stream (bool, optional): If true, output is streamed for several characters at a time.
+                Defaults to False.
+
+        Returns:
+            Union[bytes, Iterator[AudioSpeechStreamChunk]]: The generated audio as bytes or an iterator over audio stream chunks.
+        """
+
+        requestor = api_requestor.APIRequestor(
+            client=self._client,
+        )
+
+        parameter_payload = AudioSpeechRequest(
+            model=model,
+            input=input,
+            voice=voice,
+            response_format=AudioResponseFormat(response_format),
+            language=AudioLanguage(language),
+            response_encoding=AudioResponseEncoding(response_encoding),
+            sample_rate=sample_rate,
+            stream=stream,
+            **kwargs,
+        ).model_dump(exclude_none=True)
+
+        response, streamed, _ = requestor.request(
+            options=TogetherRequest(
+                method="POST",
+                url="audio/speech",
+                params=parameter_payload,
+            ),
+            stream=stream,
+        )
+
+        return AudioSpeechStreamResponse(response=response)
+
+
+class AsyncSpeech:
+    def __init__(self, client: TogetherClient) -> None:
+        self._client = client
+
+    async def create(
+        self,
+        *,
+        model: str,
+        input: str,
+        voice: str | None = None,
+        response_format: str = "wav",
+        language: str = "en",
+        response_encoding: str = "pcm_f32le",
+        sample_rate: int = 44100,
+        stream: bool = False,
+        **kwargs: Any,
+    ) -> AudioSpeechStreamResponse:
+        """
+        Async method to generate audio from input text using a specified model.
+
+        Args:
+            model (str): The name of the model to query.
+            input (str): Input text to generate the audio for.
+            voice (str, optional): The voice to use for generating the audio.
+                Defaults to None.
+            response_format (str, optional): The format of audio output.
+                Defaults to "wav".
+            language (str, optional): Language of input text.
+                Defaults to "en".
+            response_encoding (str, optional): Audio encoding of response.
+                Defaults to "pcm_f32le".
+            sample_rate (int, optional): Sampling rate to use for the output audio.
+                Defaults to 44100.
+            stream (bool, optional): If true, output is streamed for several characters at a time.
+                Defaults to False.
+
+        Returns:
+            Union[bytes, AsyncGenerator[AudioSpeechStreamChunk, None]]: The generated audio as bytes or an async generator over audio stream chunks.
+        """
+
+        requestor = api_requestor.APIRequestor(
+            client=self._client,
+        )
+
+        parameter_payload = AudioSpeechRequest(
+            model=model,
+            input=input,
+            voice=voice,
+            response_format=AudioResponseFormat(response_format),
+            language=AudioLanguage(language),
+            response_encoding=AudioResponseEncoding(response_encoding),
+            sample_rate=sample_rate,
+            stream=stream,
+            **kwargs,
+        ).model_dump(exclude_none=True)
+
+        response, _, _ = await requestor.arequest(
+            options=TogetherRequest(
+                method="POST",
+                url="audio/speech",
+                params=parameter_payload,
+            ),
+            stream=stream,
+        )
+
+        return AudioSpeechStreamResponse(response=response)

together/together_response.py

@@ -8,7 +8,7 @@ class TogetherResponse:
     API Response class. Stores headers and response data.
     """
 
-    def __init__(self, data: Dict[str, Any], headers: Dict[str, Any]):
+    def __init__(self, data: Any, headers: Dict[str, Any]):
         self._headers = headers
         self.data = data
 

together/types/__init__.py

@@ -42,6 +42,15 @@ from together.types.rerank import (
     RerankRequest,
     RerankResponse,
 )
+from together.types.audio_speech import (
+    AudioSpeechRequest,
+    AudioResponseFormat,
+    AudioLanguage,
+    AudioResponseEncoding,
+    AudioSpeechStreamChunk,
+    AudioSpeechStreamEvent,
+    AudioSpeechStreamResponse,
+)
 
 __all__ = [
     "TogetherClient",
@@ -77,4 +86,11 @@ __all__ = [
     "RerankRequest",
     "RerankResponse",
     "FinetuneTrainingLimits",
+    "AudioSpeechRequest",
+    "AudioResponseFormat",
+    "AudioLanguage",
+    "AudioResponseEncoding",
+    "AudioSpeechStreamChunk",
+    "AudioSpeechStreamEvent",
+    "AudioSpeechStreamResponse",
 ]

together/types/audio_speech.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+from enum import Enum
+from typing import Iterator
+import threading
+
+from pydantic import BaseModel, ConfigDict
+
+from together.together_response import TogetherResponse
+import base64
+
+
+class AudioResponseFormat(str, Enum):
+    MP3 = "mp3"
+    WAV = "wav"
+    RAW = "raw"
+
+
+class AudioLanguage(str, Enum):
+    EN = "en"
+    DE = "de"
+    FR = "fr"
+    ES = "es"
+    HI = "hi"
+    IT = "it"
+    JA = "ja"
+    KO = "ko"
+    NL = "nl"
+    PL = "pl"
+    PT = "pt"
+    RU = "ru"
+    SV = "sv"
+    TR = "tr"
+    ZH = "zh"
+
+
+class AudioResponseEncoding(str, Enum):
+    PCM_F32LE = "pcm_f32le"
+    PCM_S16LE = "pcm_s16le"
+    PCM_MULAW = "pcm_mulaw"
+    PCM_ALAW = "pcm_alaw"
+
+
+class AudioObjectType(str, Enum):
+    AUDIO_TTS_CHUNK = "audio.tts.chunk"
+
+
+class StreamSentinelType(str, Enum):
+    DONE = "[DONE]"
+
+
+class AudioSpeechRequest(BaseModel):
+    model: str
+    input: str
+    voice: str | None = None
+    response_format: AudioResponseFormat = AudioResponseFormat.MP3
+    language: AudioLanguage = AudioLanguage.EN
+    response_encoding: AudioResponseEncoding = AudioResponseEncoding.PCM_F32LE
+    sample_rate: int = 44100
+    stream: bool = False
+
+
+class AudioSpeechStreamChunk(BaseModel):
+    object: AudioObjectType = AudioObjectType.AUDIO_TTS_CHUNK
+    model: str
+    b64: str
+
+
+class AudioSpeechStreamEvent(BaseModel):
+    data: AudioSpeechStreamChunk
+
+
+class StreamSentinel(BaseModel):
+    data: StreamSentinelType = StreamSentinelType.DONE
+
+
+class AudioSpeechStreamEventResponse(BaseModel):
+    response: AudioSpeechStreamEvent | StreamSentinel
+
+
+class AudioSpeechStreamResponse(BaseModel):
+
+    response: TogetherResponse | Iterator[TogetherResponse]
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    def stream_to_file(self, file_path: str) -> None:
+
+        if isinstance(self.response, TogetherResponse):
+            # save response to file
+            with open(file_path, "wb") as f:
+                f.write(self.response.data)
+
+        elif isinstance(self.response, Iterator):
+
+            with open(file_path, "wb") as f:
+                for chunk in self.response:
+
+                    # Try to parse as stream chunk
+                    stream_event_response = AudioSpeechStreamEventResponse(
+                        response={"data": chunk.data}
+                    )
+
+                    if isinstance(stream_event_response.response, StreamSentinel):
+                        break
+
+                    # decode base64
+                    audio = base64.b64decode(stream_event_response.response.data.b64)
+
+                    f.write(audio)

{together-1.3.13.dist-info → together-1.4.0.dist-info}/METADATA

@@ -1,15 +1,14 @@
 Metadata-Version: 2.3
 Name: together
-Version: 1.3.13
+Version: 1.4.0
 Summary: Python client for Together's Cloud Platform!
 License: Apache-2.0
 Author: Together AI
 Author-email: support@together.ai
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -21,7 +20,7 @@ Requires-Dist: eval-type-backport (>=0.1.3,<0.3.0)
 Requires-Dist: filelock (>=3.13.1,<4.0.0)
 Requires-Dist: numpy (>=1.23.5) ; python_version < "3.12"
 Requires-Dist: numpy (>=1.26.0) ; python_version >= "3.12"
-Requires-Dist: pillow (>=10.3.0,<11.0.0)
+Requires-Dist: pillow (>=11.1.0,<12.0.0)
 Requires-Dist: pyarrow (>=10.0.1)
 Requires-Dist: pydantic (>=2.6.3,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
@@ -245,6 +244,29 @@ embeddings = get_embeddings(input_texts, model='togethercomputer/m2-bert-80M-8k-
 print(embeddings)
 ```
 
+### Reranking
+
+```python
+from typing import List
+from together import Together
+
+client = Together(api_key=os.environ.get("TOGETHER_API_KEY"))
+
+def get_reranked_documents(query: str, documents: List[str], model: str, top_n: int = 3) -> List[str]:
+    outputs = client.rerank.create(model=model, query=query, documents=documents, top_n=top_n)
+    # sort by relevance score and returns the original docs
+    return [documents[i] for i in [x.index for x in sorted(outputs.results, key=lambda x: x.relevance_score, reverse=True)]]
+
+query = "What is the capital of the United States?"
+documents = ["New York","Washington, D.C.", "Los Angeles"]
+
+reranked_documents = get_reranked_documents(query, documents, model='Salesforce/Llama-Rank-V1', top_n=1)
+
+print(reranked_documents)
+```
+
+Read more about Reranking [here](https://docs.together.ai/docs/rerank-overview).
+
 ### Files
 
 The files API is used for fine-tuning and allows developers to upload data to fine-tune on. It also has several methods to list all files, retrive files, and delete files. Please refer to our fine-tuning docs [here](https://docs.together.ai/docs/fine-tuning-python).

{together-1.3.13.dist-info → together-1.4.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 together/__init__.py,sha256=B8T7ybZ7D6jJNRTuFDVjOFlImCNag8tNZXpZdXz7xNM,1530
 together/abstract/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-together/abstract/api_requestor.py,sha256=-JpkI0QQKabCm8wPRF1AxAHaAffeR3cIlph69sw-BKw,25575
+together/abstract/api_requestor.py,sha256=uIIj6D0wWlicm-KXopl4osT6ycE7hiPPXFkmYTSFDqw,25974
 together/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 together/cli/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 together/cli/api/chat.py,sha256=2PHRb-9T-lUEKhUJFtc7SxJv3shCVx40gq_8pzfsewM,9234
@@ -11,7 +11,7 @@ together/cli/api/images.py,sha256=GADSeaNUHUVMtWovmccGuKc28IJ9E_v4vAEwYHJhu5o,26
 together/cli/api/models.py,sha256=xWEzu8ZpxM_Pz9KEjRPRVuv_v22RayYZ4QcgiezT5tE,1126
 together/cli/api/utils.py,sha256=IuqYWPnLI38_Bqd7lj8V_SnGdYc59pRmMbQmciS4FsM,1326
 together/cli/cli.py,sha256=RC0tgapkSOFjsRPg8p-8dx9D2LDzm8YmVCHUjk_aVyQ,1977
-together/client.py,sha256=mOlIFjjE9eSTb0o_weaKJwm8qvWNKHDiMmp8kQ7y68I,4946
+together/client.py,sha256=EBeec9J9epkAZakm0GcZHmWjchEHOzT24XYqt6KZfwI,5023
 together/constants.py,sha256=0L2R8ftvls9eywQstSsrQcpHIkYsOo473vGw0okArN4,1359
 together/error.py,sha256=emjhTSsLwiZvW0v1EmYemjacCMtcFIKAXWWK_2IdP18,5419
 together/filemanager.py,sha256=QHhBn73oVFdgUpSYXYLmJzHJ9c5wYEMJC0ur6ZgDeYo,11269
@@ -23,7 +23,9 @@ together/legacy/files.py,sha256=qmAqMiNTPWb6WvLV5Tsv6kxGRfQ31q7OkHZNFwkw8v0,4082
 together/legacy/finetune.py,sha256=LENaqegeb1PszXDbAhTNPro7T3isz6X_IICIOKH7dKE,5114
 together/legacy/images.py,sha256=bJJRs-6C7-NexPyaeyHiYlHOU51yls5-QAiqtO4xrZU,626
 together/legacy/models.py,sha256=85ZN9Ids_FjdYNDRv5k7sgrtVWPKPHqkDplORtVUGHg,1087
-together/resources/__init__.py,sha256=7BLdBCNUbgi5mz30EFfdkdIYiGfFCkiUbdNzMY1-igY,792
+together/resources/__init__.py,sha256=FCsSApph3FrNXB8RXv3smO6Xr86l7SmqtrVcUtKtyCI,878
+together/resources/audio/__init__.py,sha256=e7xp0Lkp_nMAHXcuFHS7dLXP_YqTPMMZIilW1TW_sAI,551
+together/resources/audio/speech.py,sha256=81ib_gIo-Rxoaipx2Pi9ZsKnOTjeFPwSlBrcUkyX5xk,5211
 together/resources/chat/__init__.py,sha256=RsTptdP8MeGjcdIjze896-J27cRvCbUoMft0X2BVlQ8,617
 together/resources/chat/completions.py,sha256=jYiNZsWa8RyEacL0VgxWj1egJ857oU4nxIY8uqGHcaU,14459
 together/resources/completions.py,sha256=5Wa-ZjPCxRcam6CDe7KgGYlTA7yJZMmd5TrRgGCL_ug,11726
@@ -33,9 +35,10 @@ together/resources/finetune.py,sha256=0UiN2jxxV_lQ9QSFKDjAioXVgPCIzb7biIJbcQj1oq
 together/resources/images.py,sha256=LQUjKPaFxWTqOAPnyF1Pp7Rz4NLOYhmoKwshpYiprEM,4923
 together/resources/models.py,sha256=2dtHhXAqTDOOpwSbYLzWcKTC0-m2Szlb7LDYvp7Jr4w,1786
 together/resources/rerank.py,sha256=3Ju_aRSyZ1s_3zCSNZnSnEJErUVmt2xa3M8z1nvejMA,3931
-together/together_response.py,sha256=MhczUCPem93cjX-A1TOAUrRj3sO-o3SLcEcTsZgVzQI,1319
-together/types/__init__.py,sha256=jEnnepzUeeYgCNTQIi4EWKaOEsZKYp0vEqzYmP8bK5o,1863
+together/together_response.py,sha256=a3dgKMPDrlfKQwxYENfNt2T4l2vSZxRWMixhHSy-q3E,1308
+together/types/__init__.py,sha256=TL_bbZwAu99S1A18j0arV2vIXEbtHRP8IddmSXx1NT0,2285
 together/types/abstract.py,sha256=1lFQI_3WjsR_t1128AeKW0aTk6EiM6Gh1J3ZuyLLPao,642
+together/types/audio_speech.py,sha256=jlj8BZf3dkIDARF1P11fuenVLj4try8Yx4RN-EAkhOU,2609
 together/types/chat_completions.py,sha256=tIHQzB1N1DsUl3WojsrfErqxVmcI_eweGVp_gbf6dp8,4914
 together/types/common.py,sha256=kxZ-N9xtBsGYZBmbIWnZ0rfT3Pn8PFB7sAbp3iv96pw,1525
 together/types/completions.py,sha256=o3FR5ixsTUj-a3pmOUzbSQg-hESVhpqrC9UD__VCqr4,2971
@@ -52,8 +55,8 @@ together/utils/api_helpers.py,sha256=RSF7SRhbjHzroMOSWAXscflByM1r1ta_1SpxkAT22iE
 together/utils/files.py,sha256=4SxxrTYfVoWvsD0n7O73LVjexAxYCWvXUBgmzrJY5-s,14169
 together/utils/tools.py,sha256=3-lXWP3cBCzOVSZg9tr5zOT1jaVeKAKVWxO2fcXZTh8,1788
 together/version.py,sha256=p03ivHyE0SyWU4jAnRTBi_sOwywVWoZPU4g2gzRgG-Y,126
-together-1.3.13.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-together-1.3.13.dist-info/METADATA,sha256=Tll4ZfzcorFyzhzxE50rIhk8ZEQd3Od4QGRz7nYuFfQ,11842
-together-1.3.13.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-together-1.3.13.dist-info/entry_points.txt,sha256=G-b5NKW6lUUf1V1fH8IPTBb7jXnK7lhbX9H1zTEJXPs,50
-together-1.3.13.dist-info/RECORD,,
+together-1.4.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+together-1.4.0.dist-info/METADATA,sha256=v1LquKItktOESHCPhDiIBR9eFXwCcTJQZYGNihiSJ6g,12649
+together-1.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+together-1.4.0.dist-info/entry_points.txt,sha256=G-b5NKW6lUUf1V1fH8IPTBb7jXnK7lhbX9H1zTEJXPs,50
+together-1.4.0.dist-info/RECORD,,