cohere-python/src/cohere/audio/transcriptions/client.py at main · cohere-ai/cohere-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# This file was auto-generated by Fern from our API Definition.

import typing

from ... import core
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from .raw_client import AsyncRawTranscriptionsClient, RawTranscriptionsClient
from .types.audio_transcriptions_create_response import AudioTranscriptionsCreateResponse

# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)


class TranscriptionsClient:
    def __init__(self, *, client_wrapper: SyncClientWrapper):
        self._raw_client = RawTranscriptionsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> RawTranscriptionsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        RawTranscriptionsClient
        """
        return self._raw_client

    def create(
        self,
        *,
        model: str,
        language: str,
        file: core.File,
        temperature: typing.Optional[float] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> AudioTranscriptionsCreateResponse:
        """
        Transcribe an audio file.

        Parameters
        ----------
        model : str
            ID of the model to use.

        language : str
            The language of the input audio, supplied in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.

        file : core.File
            See core.File for more documentation

        temperature : typing.Optional[float]
            The sampling temperature, between 0 and 1. Higher values like 0.8 make the output more random, while lower values like 0.2 make it more focused and deterministic.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        AudioTranscriptionsCreateResponse
            A successful response.

        Examples
        --------
        from cohere import Client

        client = Client(
            client_name="YOUR_CLIENT_NAME",
            token="YOUR_TOKEN",
        )
        client.audio.transcriptions.create(
            model="model",
            language="language",
        )
        """
        _response = self._raw_client.create(
            model=model, language=language, file=file, temperature=temperature, request_options=request_options
        )
        return _response.data


class AsyncTranscriptionsClient:
    def __init__(self, *, client_wrapper: AsyncClientWrapper):
        self._raw_client = AsyncRawTranscriptionsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> AsyncRawTranscriptionsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        AsyncRawTranscriptionsClient
        """
        return self._raw_client

    async def create(
        self,
        *,
        model: str,
        language: str,
        file: core.File,
        temperature: typing.Optional[float] = OMIT,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> AudioTranscriptionsCreateResponse:
        """
        Transcribe an audio file.

        Parameters
        ----------
        model : str
            ID of the model to use.

        language : str
            The language of the input audio, supplied in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.

        file : core.File
            See core.File for more documentation

        temperature : typing.Optional[float]
            The sampling temperature, between 0 and 1. Higher values like 0.8 make the output more random, while lower values like 0.2 make it more focused and deterministic.

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        AudioTranscriptionsCreateResponse
            A successful response.

        Examples
        --------
        import asyncio

        from cohere import AsyncClient

        client = AsyncClient(
            client_name="YOUR_CLIENT_NAME",
            token="YOUR_TOKEN",
        )


        async def main() -> None:
            await client.audio.transcriptions.create(
                model="model",
                language="language",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.create(
            model=model, language=language, file=file, temperature=temperature, request_options=request_options
        )
        return _response.data