You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: src/main/java/com/assemblyai/api/resources/lemur/LemurClient.java
+16-2
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,13 @@ public LemurClient(ClientOptions clientOptions) {
31
31
this.clientOptions = clientOptions;
32
32
}
33
33
34
+
/**
35
+
* Custom Summary allows you to distill a piece of audio into a few impactful sentences. You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language.
* Custom Summary allows you to distill a piece of audio into a few impactful sentences. You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language.
36
43
*/
@@ -116,6 +123,13 @@ public LemurQuestionAnswerResponse questionAnswer(LemurQuestionAnswerParameters
116
123
returnquestionAnswer(request, null);
117
124
}
118
125
126
+
/**
127
+
* Use LeMUR to generate a list of Action Items from a transcript
* @return The language of your audio file. Possible values are found in <a href="https://www.assemblyai.com/docs/Concepts/supported_languages">Supported Languages</a>.
* @return Enable Automatic Punctuation, can be true or false.
186
+
* @return Enable Automatic Punctuation, can be true or false
191
187
*/
192
188
@JsonProperty("punctuate")
193
189
@Override
@@ -196,7 +192,7 @@ public Optional<Boolean> getPunctuate() {
196
192
}
197
193
198
194
/**
199
-
* @return Enable Text Formatting, can be true or false.
195
+
* @return Enable Text Formatting, can be true or false
200
196
*/
201
197
@JsonProperty("format_text")
202
198
@Override
@@ -205,7 +201,7 @@ public Optional<Boolean> getFormatText() {
205
201
}
206
202
207
203
/**
208
-
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false.
204
+
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false
209
205
*/
210
206
@JsonProperty("dual_channel")
211
207
@Override
@@ -214,7 +210,7 @@ public Optional<Boolean> getDualChannel() {
214
210
}
215
211
216
212
/**
217
-
* @return The URL to which we send webhooks upon trancription completion, if provided in the transcription request.
213
+
* @return The URL to which AssemblyAI send webhooks upon trancription completion
218
214
*/
219
215
@JsonProperty("webhook_url")
220
216
@Override
@@ -223,7 +219,7 @@ public Optional<String> getWebhookUrl() {
223
219
}
224
220
225
221
/**
226
-
* @return The header name which should be sent back with webhook calls, if provided in the transcription request.
222
+
* @return The header name which should be sent back with webhook calls
227
223
*/
228
224
@JsonProperty("webhook_auth_header_name")
229
225
@Override
@@ -232,7 +228,7 @@ public Optional<String> getWebhookAuthHeaderName() {
232
228
}
233
229
234
230
/**
235
-
* @return Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
231
+
* @return Specify a header name and value to send back with a webhook call for added security
236
232
*/
237
233
@JsonProperty("webhook_auth_header_value")
238
234
@Override
@@ -241,7 +237,7 @@ public Optional<String> getWebhookAuthHeaderValue() {
241
237
}
242
238
243
239
/**
244
-
* @return Whether Key Phrases was enabled in the transcription request, either true or false
240
+
* @return Whether Key Phrases is enabled, either true or false
245
241
*/
246
242
@JsonProperty("auto_highlights")
247
243
@Override
@@ -250,7 +246,7 @@ public Optional<Boolean> getAutoHighlights() {
250
246
}
251
247
252
248
/**
253
-
* @return The point in time, in milliseconds, to begin transcription from in your media file
249
+
* @return The point in time, in milliseconds, to begin transcribing in your media file
254
250
*/
255
251
@JsonProperty("audio_start_from")
256
252
@Override
@@ -268,7 +264,7 @@ public Optional<Integer> getAudioEndAt() {
268
264
}
269
265
270
266
/**
271
-
* @return The list of custom vocabulary to boost transcription probability for, if provided in the transcription request.
267
+
* @return The list of custom vocabulary to boost transcription probability for
272
268
*/
273
269
@JsonProperty("word_boost")
274
270
@Override
@@ -277,7 +273,7 @@ public Optional<List<String>> getWordBoost() {
277
273
}
278
274
279
275
/**
280
-
* @return The word boost parameter value, if provided in the transcription request.
276
+
* @return The word boost parameter value
281
277
*/
282
278
@JsonProperty("boost_param")
283
279
@Override
@@ -286,7 +282,7 @@ public Optional<TranscriptBoostParam> getBoostParam() {
286
282
}
287
283
288
284
/**
289
-
* @return Filter profanity from the transcribed text, can be true or false.
285
+
* @return Filter profanity from the transcribed text, can be true or false
290
286
*/
291
287
@JsonProperty("filter_profanity")
292
288
@Override
@@ -330,9 +326,6 @@ public Optional<List<PiiPolicy>> getRedactPiiPolicies() {
330
326
returnredactPiiPolicies;
331
327
}
332
328
333
-
/**
334
-
* @return The replacement logic for detected PII, can be "entity_type" or "hash". See <a href="https://www.assemblyai.com/docs/Models/pii_redaction">PII redaction</a> for more details.
@@ -349,7 +342,7 @@ public Optional<Boolean> getSpeakerLabels() {
349
342
}
350
343
351
344
/**
352
-
* @return Tells the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
345
+
* @return Tell the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
353
346
*/
354
347
@JsonProperty("speakers_expected")
355
348
@Override
@@ -376,7 +369,7 @@ public Optional<Boolean> getIabCategories() {
376
369
}
377
370
378
371
/**
379
-
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> was enabled in the transcription request, either true or false.
372
+
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> is enabled, either true or false
380
373
*/
381
374
@JsonProperty("language_detection")
382
375
@Override
@@ -394,7 +387,7 @@ public Optional<List<TranscriptCustomSpelling>> getCustomSpelling() {
394
387
}
395
388
396
389
/**
397
-
* @return Transcribe Filler Words, like "umm", in your media file; can be true or false.
390
+
* @return Transcribe Filler Words, like "umm", in your media file; can be true or false
398
391
*/
399
392
@JsonProperty("disfluencies")
400
393
@Override
@@ -467,7 +460,7 @@ public Optional<SummaryType> getSummaryType() {
467
460
}
468
461
469
462
/**
470
-
* @return Whether custom topics was enabled in the transcription request, either true or false
463
+
* @return Whether custom topics is enabled, either true or false
471
464
*/
472
465
@JsonProperty("custom_topics")
473
466
@Override
@@ -476,7 +469,7 @@ public Optional<Boolean> getCustomTopics() {
476
469
}
477
470
478
471
/**
479
-
* @return The list of custom topics provided if custom topics was enabled in the transcription request
472
+
* @return The list of custom topics provided, if custom topics is enabled
480
473
*/
481
474
@JsonProperty("topics")
482
475
@Override
@@ -865,7 +858,7 @@ public _FinalStage audioUrl(String audioUrl) {
865
858
}
866
859
867
860
/**
868
-
* <p>The list of custom topics provided if custom topics was enabled in the transcription request</p>
861
+
* <p>The list of custom topics provided, if custom topics is enabled</p>
869
862
* @return Reference to {@code this} so that method calls can be chained together.
870
863
*/
871
864
@Override
@@ -882,7 +875,7 @@ public _FinalStage topics(Optional<List<String>> topics) {
882
875
}
883
876
884
877
/**
885
-
* <p>Whether custom topics was enabled in the transcription request, either true or false</p>
878
+
* <p>Whether custom topics is enabled, either true or false</p>
886
879
* @return Reference to {@code this} so that method calls can be chained together.
887
880
*/
888
881
@Override
@@ -1019,7 +1012,7 @@ public _FinalStage sentimentAnalysis(Optional<Boolean> sentimentAnalysis) {
1019
1012
}
1020
1013
1021
1014
/**
1022
-
* <p>Transcribe Filler Words, like "umm", in your media file; can be true or false.</p>
1015
+
* <p>Transcribe Filler Words, like "umm", in your media file; can be true or false</p>
1023
1016
* @return Reference to {@code this} so that method calls can be chained together.
1024
1017
*/
1025
1018
@Override
@@ -1053,7 +1046,7 @@ public _FinalStage customSpelling(Optional<List<TranscriptCustomSpelling>> custo
1053
1046
}
1054
1047
1055
1048
/**
1056
-
* <p>Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> was enabled in the transcription request, either true or false.</p>
1049
+
* <p>Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> is enabled, either true or false</p>
1057
1050
* @return Reference to {@code this} so that method calls can be chained together.
1058
1051
*/
1059
1052
@Override
@@ -1104,7 +1097,7 @@ public _FinalStage contentSafety(Optional<Boolean> contentSafety) {
1104
1097
}
1105
1098
1106
1099
/**
1107
-
* <p>Tells the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.</p>
1100
+
* <p>Tell the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.</p>
1108
1101
* @return Reference to {@code this} so that method calls can be chained together.
1109
1102
*/
1110
1103
@Override
@@ -1137,10 +1130,6 @@ public _FinalStage speakerLabels(Optional<Boolean> speakerLabels) {
1137
1130
returnthis;
1138
1131
}
1139
1132
1140
-
/**
1141
-
* <p>The replacement logic for detected PII, can be "entity_type" or "hash". See <a href="https://www.assemblyai.com/docs/Models/pii_redaction">PII redaction</a> for more details.</p>
1142
-
* @return Reference to {@code this} so that method calls can be chained together.
@@ -1223,7 +1212,7 @@ public _FinalStage redactPii(Optional<Boolean> redactPii) {
1223
1212
}
1224
1213
1225
1214
/**
1226
-
* <p>Filter profanity from the transcribed text, can be true or false.</p>
1215
+
* <p>Filter profanity from the transcribed text, can be true or false</p>
1227
1216
* @return Reference to {@code this} so that method calls can be chained together.
1228
1217
*/
1229
1218
@Override
@@ -1240,7 +1229,7 @@ public _FinalStage filterProfanity(Optional<Boolean> filterProfanity) {
1240
1229
}
1241
1230
1242
1231
/**
1243
-
* <p>The word boost parameter value, if provided in the transcription request.</p>
1232
+
* <p>The word boost parameter value</p>
1244
1233
* @return Reference to {@code this} so that method calls can be chained together.
1245
1234
*/
1246
1235
@Override
@@ -1257,7 +1246,7 @@ public _FinalStage boostParam(Optional<TranscriptBoostParam> boostParam) {
1257
1246
}
1258
1247
1259
1248
/**
1260
-
* <p>The list of custom vocabulary to boost transcription probability for, if provided in the transcription request.</p>
1249
+
* <p>The list of custom vocabulary to boost transcription probability for</p>
1261
1250
* @return Reference to {@code this} so that method calls can be chained together.
1262
1251
*/
1263
1252
@Override
@@ -1291,7 +1280,7 @@ public _FinalStage audioEndAt(Optional<Integer> audioEndAt) {
1291
1280
}
1292
1281
1293
1282
/**
1294
-
* <p>The point in time, in milliseconds, to begin transcription from in your media file</p>
1283
+
* <p>The point in time, in milliseconds, to begin transcribing in your media file</p>
1295
1284
* @return Reference to {@code this} so that method calls can be chained together.
1296
1285
*/
1297
1286
@Override
@@ -1308,7 +1297,7 @@ public _FinalStage audioStartFrom(Optional<Integer> audioStartFrom) {
1308
1297
}
1309
1298
1310
1299
/**
1311
-
* <p>Whether Key Phrases was enabled in the transcription request, either true or false</p>
1300
+
* <p>Whether Key Phrases is enabled, either true or false</p>
1312
1301
* @return Reference to {@code this} so that method calls can be chained together.
1313
1302
*/
1314
1303
@Override
@@ -1325,7 +1314,7 @@ public _FinalStage autoHighlights(Optional<Boolean> autoHighlights) {
1325
1314
}
1326
1315
1327
1316
/**
1328
-
* <p>Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.</p>
1317
+
* <p>Specify a header name and value to send back with a webhook call for added security</p>
1329
1318
* @return Reference to {@code this} so that method calls can be chained together.
1330
1319
*/
1331
1320
@Override
@@ -1342,7 +1331,7 @@ public _FinalStage webhookAuthHeaderValue(Optional<String> webhookAuthHeaderValu
1342
1331
}
1343
1332
1344
1333
/**
1345
-
* <p>The header name which should be sent back with webhook calls, if provided in the transcription request.</p>
1334
+
* <p>The header name which should be sent back with webhook calls</p>
1346
1335
* @return Reference to {@code this} so that method calls can be chained together.
1347
1336
*/
1348
1337
@Override
@@ -1359,7 +1348,7 @@ public _FinalStage webhookAuthHeaderName(Optional<String> webhookAuthHeaderName)
1359
1348
}
1360
1349
1361
1350
/**
1362
-
* <p>The URL to which we send webhooks upon trancription completion, if provided in the transcription request.</p>
1351
+
* <p>The URL to which AssemblyAI send webhooks upon trancription completion</p>
1363
1352
* @return Reference to {@code this} so that method calls can be chained together.
1364
1353
*/
1365
1354
@Override
@@ -1376,7 +1365,7 @@ public _FinalStage webhookUrl(Optional<String> webhookUrl) {
1376
1365
}
1377
1366
1378
1367
/**
1379
-
* <p>Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false.</p>
1368
+
* <p>Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false</p>
1380
1369
* @return Reference to {@code this} so that method calls can be chained together.
1381
1370
*/
1382
1371
@Override
@@ -1393,7 +1382,7 @@ public _FinalStage dualChannel(Optional<Boolean> dualChannel) {
1393
1382
}
1394
1383
1395
1384
/**
1396
-
* <p>Enable Text Formatting, can be true or false.</p>
1385
+
* <p>Enable Text Formatting, can be true or false</p>
1397
1386
* @return Reference to {@code this} so that method calls can be chained together.
1398
1387
*/
1399
1388
@Override
@@ -1410,7 +1399,7 @@ public _FinalStage formatText(Optional<Boolean> formatText) {
1410
1399
}
1411
1400
1412
1401
/**
1413
-
* <p>Enable Automatic Punctuation, can be true or false.</p>
1402
+
* <p>Enable Automatic Punctuation, can be true or false</p>
1414
1403
* @return Reference to {@code this} so that method calls can be chained together.
1415
1404
*/
1416
1405
@Override
@@ -1426,11 +1415,6 @@ public _FinalStage punctuate(Optional<Boolean> punctuate) {
1426
1415
returnthis;
1427
1416
}
1428
1417
1429
-
/**
1430
-
* <p>The language of your audio file. Possible values are found in <a href="https://www.assemblyai.com/docs/Concepts/supported_languages">Supported Languages</a>.
1431
-
* The default value is 'en_us'.</p>
1432
-
* @return Reference to {@code this} so that method calls can be chained together.
* @return The language of your audio file. Possible values are found in <a href="https://www.assemblyai.com/docs/Concepts/supported_languages">Supported Languages</a>.
* @return Enable Automatic Punctuation, can be true or false.
174
+
* @return Enable Automatic Punctuation, can be true or false
179
175
*/
180
176
@JsonProperty("punctuate")
181
177
@Override
@@ -184,7 +180,7 @@ public Optional<Boolean> getPunctuate() {
184
180
}
185
181
186
182
/**
187
-
* @return Enable Text Formatting, can be true or false.
183
+
* @return Enable Text Formatting, can be true or false
188
184
*/
189
185
@JsonProperty("format_text")
190
186
@Override
@@ -193,7 +189,7 @@ public Optional<Boolean> getFormatText() {
193
189
}
194
190
195
191
/**
196
-
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false.
192
+
* @return Enable <a href="https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription">Dual Channel</a> transcription, can be true or false
197
193
*/
198
194
@JsonProperty("dual_channel")
199
195
@Override
@@ -202,7 +198,7 @@ public Optional<Boolean> getDualChannel() {
202
198
}
203
199
204
200
/**
205
-
* @return The URL to which we send webhooks upon trancription completion, if provided in the transcription request.
201
+
* @return The URL to which AssemblyAI send webhooks upon trancription completion
206
202
*/
207
203
@JsonProperty("webhook_url")
208
204
@Override
@@ -211,7 +207,7 @@ public Optional<String> getWebhookUrl() {
211
207
}
212
208
213
209
/**
214
-
* @return The header name which should be sent back with webhook calls, if provided in the transcription request.
210
+
* @return The header name which should be sent back with webhook calls
215
211
*/
216
212
@JsonProperty("webhook_auth_header_name")
217
213
@Override
@@ -220,7 +216,7 @@ public Optional<String> getWebhookAuthHeaderName() {
220
216
}
221
217
222
218
/**
223
-
* @return Defaults to null. Optionally allows a user to specify a header name and value to send back with a webhook call for added security.
219
+
* @return Specify a header name and value to send back with a webhook call for added security
224
220
*/
225
221
@JsonProperty("webhook_auth_header_value")
226
222
@Override
@@ -229,7 +225,7 @@ public Optional<String> getWebhookAuthHeaderValue() {
229
225
}
230
226
231
227
/**
232
-
* @return Whether Key Phrases was enabled in the transcription request, either true or false
228
+
* @return Whether Key Phrases is enabled, either true or false
233
229
*/
234
230
@JsonProperty("auto_highlights")
235
231
@Override
@@ -238,7 +234,7 @@ public Optional<Boolean> getAutoHighlights() {
238
234
}
239
235
240
236
/**
241
-
* @return The point in time, in milliseconds, to begin transcription from in your media file
237
+
* @return The point in time, in milliseconds, to begin transcribing in your media file
242
238
*/
243
239
@JsonProperty("audio_start_from")
244
240
@Override
@@ -256,7 +252,7 @@ public Optional<Integer> getAudioEndAt() {
256
252
}
257
253
258
254
/**
259
-
* @return The list of custom vocabulary to boost transcription probability for, if provided in the transcription request.
255
+
* @return The list of custom vocabulary to boost transcription probability for
260
256
*/
261
257
@JsonProperty("word_boost")
262
258
@Override
@@ -265,7 +261,7 @@ public Optional<List<String>> getWordBoost() {
265
261
}
266
262
267
263
/**
268
-
* @return The word boost parameter value, if provided in the transcription request.
264
+
* @return The word boost parameter value
269
265
*/
270
266
@JsonProperty("boost_param")
271
267
@Override
@@ -274,7 +270,7 @@ public Optional<TranscriptBoostParam> getBoostParam() {
274
270
}
275
271
276
272
/**
277
-
* @return Filter profanity from the transcribed text, can be true or false.
273
+
* @return Filter profanity from the transcribed text, can be true or false
278
274
*/
279
275
@JsonProperty("filter_profanity")
280
276
@Override
@@ -318,9 +314,6 @@ public Optional<List<PiiPolicy>> getRedactPiiPolicies() {
318
314
returnredactPiiPolicies;
319
315
}
320
316
321
-
/**
322
-
* @return The replacement logic for detected PII, can be "entity_type" or "hash". See <a href="https://www.assemblyai.com/docs/Models/pii_redaction">PII redaction</a> for more details.
@@ -337,7 +330,7 @@ public Optional<Boolean> getSpeakerLabels() {
337
330
}
338
331
339
332
/**
340
-
* @return Tells the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
333
+
* @return Tell the speaker label model how many speakers it should attempt to identify, up to 10. See <a href="https://www.assemblyai.com/docs/Models/speaker_diarization">Speaker diarization</a> for more details.
341
334
*/
342
335
@JsonProperty("speakers_expected")
343
336
@Override
@@ -364,7 +357,7 @@ public Optional<Boolean> getIabCategories() {
364
357
}
365
358
366
359
/**
367
-
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> was enabled in the transcription request, either true or false.
360
+
* @return Whether <a href="https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection">Automatic language detection</a> is enabled, either true or false
368
361
*/
369
362
@JsonProperty("language_detection")
370
363
@Override
@@ -382,7 +375,7 @@ public Optional<List<TranscriptCustomSpelling>> getCustomSpelling() {
382
375
}
383
376
384
377
/**
385
-
* @return Transcribe Filler Words, like "umm", in your media file; can be true or false.
378
+
* @return Transcribe Filler Words, like "umm", in your media file; can be true or false
386
379
*/
387
380
@JsonProperty("disfluencies")
388
381
@Override
@@ -455,7 +448,7 @@ public Optional<SummaryType> getSummaryType() {
455
448
}
456
449
457
450
/**
458
-
* @return Whether custom topics was enabled in the transcription request, either true or false
451
+
* @return Whether custom topics is enabled, either true or false
459
452
*/
460
453
@JsonProperty("custom_topics")
461
454
@Override
@@ -464,7 +457,7 @@ public Optional<Boolean> getCustomTopics() {
464
457
}
465
458
466
459
/**
467
-
* @return The list of custom topics provided if custom topics was enabled in the transcription request
460
+
* @return The list of custom topics provided, if custom topics is enabled
Copy file name to clipboardexpand all lines: src/main/java/com/assemblyai/api/types/FinalTranscript.java
+20-17
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ private FinalTranscript(
61
61
}
62
62
63
63
/**
64
-
* @return Start time of audio sample relative to session start, in milliseconds.
64
+
* @return Start time of audio sample relative to session start, in milliseconds
65
65
*/
66
66
@JsonProperty("audio_start")
67
67
@Override
@@ -70,7 +70,7 @@ public int getAudioStart() {
70
70
}
71
71
72
72
/**
73
-
* @return End time of audio sample relative to session start, in milliseconds.
73
+
* @return End time of audio sample relative to session start, in milliseconds
74
74
*/
75
75
@JsonProperty("audio_end")
76
76
@Override
@@ -79,7 +79,7 @@ public int getAudioEnd() {
79
79
}
80
80
81
81
/**
82
-
* @return The confidence score of the entire transcription, between 0 and 1.
82
+
* @return The confidence score of the entire transcription, between 0 and 1
83
83
*/
84
84
@JsonProperty("confidence")
85
85
@Override
@@ -88,7 +88,7 @@ public double getConfidence() {
88
88
}
89
89
90
90
/**
91
-
* @return The partial transcript for your audio.
91
+
* @return The partial transcript for your audio
92
92
*/
93
93
@JsonProperty("text")
94
94
@Override
@@ -97,7 +97,8 @@ public String getText() {
97
97
}
98
98
99
99
/**
100
-
* @return An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
100
+
* @return An array of objects, with the information for each word in the transcription text.
101
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
101
102
*/
102
103
@JsonProperty("words")
103
104
@Override
@@ -106,7 +107,7 @@ public List<Word> getWords() {
106
107
}
107
108
108
109
/**
109
-
* @return The timestamp for the partial transcript.
110
+
* @return The timestamp for the partial transcript
110
111
*/
111
112
@JsonProperty("created")
112
113
@Override
@@ -120,15 +121,15 @@ public String getMessageType() {
120
121
}
121
122
122
123
/**
123
-
* @return Whether the text has been punctuated and cased.
124
+
* @return Whether the text is punctuated and cased
124
125
*/
125
126
@JsonProperty("punctuated")
126
127
publicbooleangetPunctuated() {
127
128
returnpunctuated;
128
129
}
129
130
130
131
/**
131
-
* @return Whether the text has been formatted (e.g. Dollar -> $)
132
+
* @return Whether the text is formatted, for example Dollar -> $
132
133
*/
133
134
@JsonProperty("text_formatted")
134
135
publicbooleangetTextFormatted() {
@@ -264,7 +265,7 @@ public Builder from(FinalTranscript other) {
264
265
}
265
266
266
267
/**
267
-
* <p>Start time of audio sample relative to session start, in milliseconds.</p>
268
+
* <p>Start time of audio sample relative to session start, in milliseconds</p>
268
269
* @return Reference to {@code this} so that method calls can be chained together.
269
270
*/
270
271
@Override
@@ -275,7 +276,7 @@ public AudioEndStage audioStart(int audioStart) {
275
276
}
276
277
277
278
/**
278
-
* <p>End time of audio sample relative to session start, in milliseconds.</p>
279
+
* <p>End time of audio sample relative to session start, in milliseconds</p>
279
280
* @return Reference to {@code this} so that method calls can be chained together.
280
281
*/
281
282
@Override
@@ -286,7 +287,7 @@ public ConfidenceStage audioEnd(int audioEnd) {
286
287
}
287
288
288
289
/**
289
-
* <p>The confidence score of the entire transcription, between 0 and 1.</p>
290
+
* <p>The confidence score of the entire transcription, between 0 and 1</p>
290
291
* @return Reference to {@code this} so that method calls can be chained together.
291
292
*/
292
293
@Override
@@ -297,7 +298,7 @@ public TextStage confidence(double confidence) {
297
298
}
298
299
299
300
/**
300
-
* <p>The partial transcript for your audio.</p>
301
+
* <p>The partial transcript for your audio</p>
301
302
* @return Reference to {@code this} so that method calls can be chained together.
302
303
*/
303
304
@Override
@@ -308,7 +309,7 @@ public CreatedStage text(String text) {
308
309
}
309
310
310
311
/**
311
-
* <p>The timestamp for the partial transcript.</p>
312
+
* <p>The timestamp for the partial transcript</p>
312
313
* @return Reference to {@code this} so that method calls can be chained together.
313
314
*/
314
315
@Override
@@ -319,7 +320,7 @@ public PunctuatedStage created(String created) {
319
320
}
320
321
321
322
/**
322
-
* <p>Whether the text has been punctuated and cased.</p>
323
+
* <p>Whether the text is punctuated and cased</p>
323
324
* @return Reference to {@code this} so that method calls can be chained together.
324
325
*/
325
326
@Override
@@ -330,7 +331,7 @@ public TextFormattedStage punctuated(boolean punctuated) {
330
331
}
331
332
332
333
/**
333
-
* <p>Whether the text has been formatted (e.g. Dollar -> $)</p>
334
+
* <p>Whether the text is formatted, for example Dollar -> $</p>
334
335
* @return Reference to {@code this} so that method calls can be chained together.
335
336
*/
336
337
@Override
@@ -341,7 +342,8 @@ public _FinalStage textFormatted(boolean textFormatted) {
341
342
}
342
343
343
344
/**
344
-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
345
+
* <p>An array of objects, with the information for each word in the transcription text.
346
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
345
347
* @return Reference to {@code this} so that method calls can be chained together.
346
348
*/
347
349
@Override
@@ -351,7 +353,8 @@ public _FinalStage addAllWords(List<Word> words) {
351
353
}
352
354
353
355
/**
354
-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
356
+
* <p>An array of objects, with the information for each word in the transcription text.
357
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
355
358
* @return Reference to {@code this} so that method calls can be chained together.
Copy file name to clipboardexpand all lines: src/main/java/com/assemblyai/api/types/PartialTranscript.java
+16-13
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ private PartialTranscript(
53
53
}
54
54
55
55
/**
56
-
* @return Start time of audio sample relative to session start, in milliseconds.
56
+
* @return Start time of audio sample relative to session start, in milliseconds
57
57
*/
58
58
@JsonProperty("audio_start")
59
59
@Override
@@ -62,7 +62,7 @@ public int getAudioStart() {
62
62
}
63
63
64
64
/**
65
-
* @return End time of audio sample relative to session start, in milliseconds.
65
+
* @return End time of audio sample relative to session start, in milliseconds
66
66
*/
67
67
@JsonProperty("audio_end")
68
68
@Override
@@ -71,7 +71,7 @@ public int getAudioEnd() {
71
71
}
72
72
73
73
/**
74
-
* @return The confidence score of the entire transcription, between 0 and 1.
74
+
* @return The confidence score of the entire transcription, between 0 and 1
75
75
*/
76
76
@JsonProperty("confidence")
77
77
@Override
@@ -80,7 +80,7 @@ public double getConfidence() {
80
80
}
81
81
82
82
/**
83
-
* @return The partial transcript for your audio.
83
+
* @return The partial transcript for your audio
84
84
*/
85
85
@JsonProperty("text")
86
86
@Override
@@ -89,7 +89,8 @@ public String getText() {
89
89
}
90
90
91
91
/**
92
-
* @return An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
92
+
* @return An array of objects, with the information for each word in the transcription text.
93
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
93
94
*/
94
95
@JsonProperty("words")
95
96
@Override
@@ -98,7 +99,7 @@ public List<Word> getWords() {
98
99
}
99
100
100
101
/**
101
-
* @return The timestamp for the partial transcript.
102
+
* @return The timestamp for the partial transcript
102
103
*/
103
104
@JsonProperty("created")
104
105
@Override
@@ -209,7 +210,7 @@ public Builder from(PartialTranscript other) {
209
210
}
210
211
211
212
/**
212
-
* <p>Start time of audio sample relative to session start, in milliseconds.</p>
213
+
* <p>Start time of audio sample relative to session start, in milliseconds</p>
213
214
* @return Reference to {@code this} so that method calls can be chained together.
214
215
*/
215
216
@Override
@@ -220,7 +221,7 @@ public AudioEndStage audioStart(int audioStart) {
220
221
}
221
222
222
223
/**
223
-
* <p>End time of audio sample relative to session start, in milliseconds.</p>
224
+
* <p>End time of audio sample relative to session start, in milliseconds</p>
224
225
* @return Reference to {@code this} so that method calls can be chained together.
225
226
*/
226
227
@Override
@@ -231,7 +232,7 @@ public ConfidenceStage audioEnd(int audioEnd) {
231
232
}
232
233
233
234
/**
234
-
* <p>The confidence score of the entire transcription, between 0 and 1.</p>
235
+
* <p>The confidence score of the entire transcription, between 0 and 1</p>
235
236
* @return Reference to {@code this} so that method calls can be chained together.
236
237
*/
237
238
@Override
@@ -242,7 +243,7 @@ public TextStage confidence(double confidence) {
242
243
}
243
244
244
245
/**
245
-
* <p>The partial transcript for your audio.</p>
246
+
* <p>The partial transcript for your audio</p>
246
247
* @return Reference to {@code this} so that method calls can be chained together.
247
248
*/
248
249
@Override
@@ -253,7 +254,7 @@ public CreatedStage text(String text) {
253
254
}
254
255
255
256
/**
256
-
* <p>The timestamp for the partial transcript.</p>
257
+
* <p>The timestamp for the partial transcript</p>
257
258
* @return Reference to {@code this} so that method calls can be chained together.
258
259
*/
259
260
@Override
@@ -264,7 +265,8 @@ public _FinalStage created(String created) {
264
265
}
265
266
266
267
/**
267
-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
268
+
* <p>An array of objects, with the information for each word in the transcription text.
269
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
268
270
* @return Reference to {@code this} so that method calls can be chained together.
269
271
*/
270
272
@Override
@@ -274,7 +276,8 @@ public _FinalStage addAllWords(List<Word> words) {
274
276
}
275
277
276
278
/**
277
-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
279
+
* <p>An array of objects, with the information for each word in the transcription text.
280
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
278
281
* @return Reference to {@code this} so that method calls can be chained together.
Copy file name to clipboardexpand all lines: src/main/java/com/assemblyai/api/types/RealtimeBaseTranscript.java
+16-13
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ private RealtimeBaseTranscript(
53
53
}
54
54
55
55
/**
56
-
* @return Start time of audio sample relative to session start, in milliseconds.
56
+
* @return Start time of audio sample relative to session start, in milliseconds
57
57
*/
58
58
@JsonProperty("audio_start")
59
59
@Override
@@ -62,7 +62,7 @@ public int getAudioStart() {
62
62
}
63
63
64
64
/**
65
-
* @return End time of audio sample relative to session start, in milliseconds.
65
+
* @return End time of audio sample relative to session start, in milliseconds
66
66
*/
67
67
@JsonProperty("audio_end")
68
68
@Override
@@ -71,7 +71,7 @@ public int getAudioEnd() {
71
71
}
72
72
73
73
/**
74
-
* @return The confidence score of the entire transcription, between 0 and 1.
74
+
* @return The confidence score of the entire transcription, between 0 and 1
75
75
*/
76
76
@JsonProperty("confidence")
77
77
@Override
@@ -80,7 +80,7 @@ public double getConfidence() {
80
80
}
81
81
82
82
/**
83
-
* @return The partial transcript for your audio.
83
+
* @return The partial transcript for your audio
84
84
*/
85
85
@JsonProperty("text")
86
86
@Override
@@ -89,7 +89,8 @@ public String getText() {
89
89
}
90
90
91
91
/**
92
-
* @return An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).
92
+
* @return An array of objects, with the information for each word in the transcription text.
93
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
93
94
*/
94
95
@JsonProperty("words")
95
96
@Override
@@ -98,7 +99,7 @@ public List<Word> getWords() {
98
99
}
99
100
100
101
/**
101
-
* @return The timestamp for the partial transcript.
102
+
* @return The timestamp for the partial transcript
102
103
*/
103
104
@JsonProperty("created")
104
105
@Override
@@ -204,7 +205,7 @@ public Builder from(RealtimeBaseTranscript other) {
204
205
}
205
206
206
207
/**
207
-
* <p>Start time of audio sample relative to session start, in milliseconds.</p>
208
+
* <p>Start time of audio sample relative to session start, in milliseconds</p>
208
209
* @return Reference to {@code this} so that method calls can be chained together.
209
210
*/
210
211
@Override
@@ -215,7 +216,7 @@ public AudioEndStage audioStart(int audioStart) {
215
216
}
216
217
217
218
/**
218
-
* <p>End time of audio sample relative to session start, in milliseconds.</p>
219
+
* <p>End time of audio sample relative to session start, in milliseconds</p>
219
220
* @return Reference to {@code this} so that method calls can be chained together.
220
221
*/
221
222
@Override
@@ -226,7 +227,7 @@ public ConfidenceStage audioEnd(int audioEnd) {
226
227
}
227
228
228
229
/**
229
-
* <p>The confidence score of the entire transcription, between 0 and 1.</p>
230
+
* <p>The confidence score of the entire transcription, between 0 and 1</p>
230
231
* @return Reference to {@code this} so that method calls can be chained together.
231
232
*/
232
233
@Override
@@ -237,7 +238,7 @@ public TextStage confidence(double confidence) {
237
238
}
238
239
239
240
/**
240
-
* <p>The partial transcript for your audio.</p>
241
+
* <p>The partial transcript for your audio</p>
241
242
* @return Reference to {@code this} so that method calls can be chained together.
242
243
*/
243
244
@Override
@@ -248,7 +249,7 @@ public CreatedStage text(String text) {
248
249
}
249
250
250
251
/**
251
-
* <p>The timestamp for the partial transcript.</p>
252
+
* <p>The timestamp for the partial transcript</p>
252
253
* @return Reference to {@code this} so that method calls can be chained together.
253
254
*/
254
255
@Override
@@ -259,7 +260,8 @@ public _FinalStage created(String created) {
259
260
}
260
261
261
262
/**
262
-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
263
+
* <p>An array of objects, with the information for each word in the transcription text.
264
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
263
265
* @return Reference to {@code this} so that method calls can be chained together.
264
266
*/
265
267
@Override
@@ -269,7 +271,8 @@ public _FinalStage addAllWords(List<Word> words) {
269
271
}
270
272
271
273
/**
272
-
* <p>An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself).</p>
274
+
* <p>An array of objects, with the information for each word in the transcription text.
275
+
* Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.</p>
273
276
* @return Reference to {@code this} so that method calls can be chained together.
0 commit comments