/
api.py
369 lines (286 loc) · 9.95 KB
/
api.py
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
from typing import BinaryIO, List, Optional
from urllib.parse import urlencode
import httpx
from . import types
ENDPOINT_TRANSCRIPT = "/v2/transcript"
ENDPOINT_UPLOAD = "/v2/upload"
ENDPOINT_LEMUR_BASE = "/lemur/v3"
ENDPOINT_LEMUR = f"{ENDPOINT_LEMUR_BASE}/generate"
ENDPOINT_REALTIME_WEBSOCKET = "/v2/realtime/ws"
ENDPOINT_REALTIME_TOKEN = "/v2/realtime/token"
def _get_error_message(response: httpx.Response) -> str:
"""
Tries to retrieve the `error` field if the response is JSON, otherwise
returns the response text.
Args:
`response`: the HTTP response
Returns: the error message
"""
try:
return response.json()["error"]
except Exception:
return f"\nReason: {response.text}\nRequest: {response.request}"
def create_transcript(
client: httpx.Client,
request: types.TranscriptRequest,
) -> types.TranscriptResponse:
response = client.post(
ENDPOINT_TRANSCRIPT,
json=request.dict(
exclude_none=True,
by_alias=True,
),
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to transcribe url {request.audio_url}: {_get_error_message(response)}"
)
return types.TranscriptResponse.parse_obj(response.json())
def get_transcript(
client: httpx.Client,
transcript_id: str,
) -> types.TranscriptResponse:
response = client.get(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}",
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to retrieve transcript {transcript_id}: {_get_error_message(response)}",
)
return types.TranscriptResponse.parse_obj(response.json())
def delete_transcript(
client: httpx.Client,
transcript_id: str,
) -> types.TranscriptResponse:
response = client.delete(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}",
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to delete transcript {transcript_id}: {_get_error_message(response)}",
)
return types.TranscriptResponse.parse_obj(response.json())
def upload_file(
client: httpx.Client,
audio_file: BinaryIO,
) -> str:
"""
Uploads the given file.
Args:
`client`: the HTTP client
`audio_file`: an opened file (in binary mode)
Returns: The URL of the uploaded audio file.
"""
response = client.post(
ENDPOINT_UPLOAD,
content=audio_file,
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"Failed to upload audio file: {_get_error_message(response)}"
)
return response.json()["upload_url"]
def export_subtitles_srt(
client: httpx.Client,
transcript_id: str,
chars_per_caption: Optional[int],
) -> str:
params = {}
if chars_per_caption:
params = {
"chars_per_caption": chars_per_caption,
}
response = client.get(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}/srt",
params=params,
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to export SRT for transcript {transcript_id}: {_get_error_message(response)}"
)
return response.text
def export_subtitles_vtt(
client: httpx.Client,
transcript_id: str,
chars_per_caption: Optional[int],
) -> str:
params = {}
if chars_per_caption:
params = {
"chars_per_caption": chars_per_caption,
}
response = client.get(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}/vtt",
params=params,
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to export VTT for transcript {transcript_id}: {_get_error_message(response)}"
)
return response.text
def word_search(
client: httpx.Client,
transcript_id: str,
words: List[str],
) -> types.WordSearchMatchResponse:
response = client.get(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}/word-search",
params=urlencode(
{
"words": ",".join(words),
}
),
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to search words in transcript {transcript_id}: {_get_error_message(response)}"
)
return types.WordSearchMatchResponse.parse_obj(response.json())
def get_redacted_audio(
client: httpx.Client, transcript_id: str
) -> types.RedactedAudioResponse:
"""
Retrieves the object containing the redacted audio URL for the given transcript.
Raises:
RedactedAudioIncompleteError: If response indicates that the redacted audio is still processing
RedactedAudioUnavailableError: If response indicates that the redacted audio is not available
TranscriptError: If we fail to get a valid response from the API at all
Returns:
`RedactedAudioResponse`, which contains the URL of the redacted audio
"""
response = client.get(f"{ENDPOINT_TRANSCRIPT}/{transcript_id}/redacted-audio")
if response.status_code == httpx.codes.ACCEPTED:
raise types.RedactedAudioIncompleteError(
f"redacted audio for transcript {transcript_id} is not ready yet"
)
if response.status_code == httpx.codes.BAD_REQUEST:
raise types.RedactedAudioExpiredError(
f"redacted audio for transcript {transcript_id} is no longer available"
)
if response.status_code != httpx.codes.OK:
raise types.TranscriptError(
f"failed to retrieve redacted audio for transcript {transcript_id}: {_get_error_message(response)}"
)
return types.RedactedAudioResponse.parse_obj(response.json())
def get_sentences(
client: httpx.Client,
transcript_id: str,
) -> types.SentencesResponse:
response = client.get(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}/sentences",
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to retrieve sentences for transcript {transcript_id}: {_get_error_message(response)}"
)
return types.SentencesResponse.parse_obj(response.json())
def get_paragraphs(
client: httpx.Client,
transcript_id: str,
) -> types.ParagraphsResponse:
response = client.get(
f"{ENDPOINT_TRANSCRIPT}/{transcript_id}/paragraphs",
)
if response.status_code != httpx.codes.ok:
raise types.TranscriptError(
f"failed to retrieve paragraphs for transcript {transcript_id}: {_get_error_message(response)}"
)
return types.ParagraphsResponse.parse_obj(response.json())
def lemur_question(
client: httpx.Client,
request: types.LemurQuestionRequest,
http_timeout: Optional[float],
) -> types.LemurQuestionResponse:
response = client.post(
f"{ENDPOINT_LEMUR}/question-answer",
json=request.dict(
exclude_none=True,
),
timeout=http_timeout,
)
if response.status_code != httpx.codes.ok:
raise types.LemurError(
f"failed to call Lemur questions: {_get_error_message(response)}"
)
return types.LemurQuestionResponse.parse_obj(response.json())
def lemur_summarize(
client: httpx.Client,
request: types.LemurSummaryRequest,
http_timeout: Optional[float],
) -> types.LemurSummaryResponse:
response = client.post(
f"{ENDPOINT_LEMUR}/summary",
json=request.dict(
exclude_none=True,
),
timeout=http_timeout,
)
if response.status_code != httpx.codes.ok:
raise types.LemurError(
f"failed to call Lemur summary: {_get_error_message(response)}"
)
return types.LemurSummaryResponse.parse_obj(response.json())
def lemur_action_items(
client: httpx.Client,
request: types.LemurActionItemsRequest,
http_timeout: Optional[float],
) -> types.LemurActionItemsResponse:
response = client.post(
f"{ENDPOINT_LEMUR}/action-items",
json=request.dict(
exclude_none=True,
),
timeout=http_timeout,
)
if response.status_code != httpx.codes.ok:
raise types.LemurError(
f"failed to call Lemur action items: {_get_error_message(response)}"
)
return types.LemurActionItemsResponse.parse_obj(response.json())
def lemur_task(
client: httpx.Client,
request: types.LemurTaskRequest,
http_timeout: Optional[float],
) -> types.LemurTaskResponse:
response = client.post(
f"{ENDPOINT_LEMUR}/task",
json=request.dict(
exclude_none=True,
),
timeout=http_timeout,
)
if response.status_code != httpx.codes.ok:
raise types.LemurError(
f"failed to call Lemur task: {_get_error_message(response)}"
)
return types.LemurTaskResponse.parse_obj(response.json())
def lemur_purge_request_data(
client: httpx.Client,
request: types.LemurPurgeRequest,
http_timeout: Optional[float],
) -> types.LemurPurgeRequest:
response = client.delete(
f"{ENDPOINT_LEMUR_BASE}/{request.request_id}",
timeout=http_timeout,
)
if response.status_code != httpx.codes.ok:
raise types.LemurError(
f"Failed to purge LeMUR request data for provided request ID: {request.request_id}. Error: {_get_error_message(response)}"
)
return types.LemurPurgeResponse.parse_obj(response.json())
def create_temporary_token(
client: httpx.Client,
request: types.RealtimeCreateTemporaryTokenRequest,
http_timeout: Optional[float],
) -> str:
response = client.post(
f"{ENDPOINT_REALTIME_TOKEN}",
json=request.dict(exclude_none=True),
timeout=http_timeout,
)
if response.status_code != httpx.codes.ok:
raise types.AssemblyAIError(
f"Failed to create temporary token: {_get_error_message(response)}"
)
data = types.RealtimeCreateTemporaryTokenResponse.parse_obj(response.json())
return data.token