voice-router-dev 0.8.3 → 0.8.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +107 -1
- package/dist/constants.d.mts +7 -8
- package/dist/constants.d.ts +7 -8
- package/dist/constants.js +4 -8
- package/dist/constants.mjs +4 -8
- package/dist/{field-configs-t_lVCkE5.d.mts → field-configs-DXAGTUfv.d.mts} +3135 -1956
- package/dist/{field-configs-t_lVCkE5.d.ts → field-configs-DXAGTUfv.d.ts} +3135 -1956
- package/dist/field-configs.d.mts +1 -1
- package/dist/field-configs.d.ts +1 -1
- package/dist/field-configs.js +2320 -1634
- package/dist/field-configs.mjs +2320 -1634
- package/dist/index.d.mts +263 -711
- package/dist/index.d.ts +263 -711
- package/dist/index.js +2080 -1532
- package/dist/index.mjs +2080 -1531
- package/dist/{speechToTextChunkResponseModel-DjL2ncnf.d.ts → speechToTextChunkResponseModel-CmxWFIjf.d.ts} +1667 -1172
- package/dist/{speechToTextChunkResponseModel-DvIT4xai.d.mts → speechToTextChunkResponseModel-Dj3Weqv1.d.mts} +1667 -1172
- package/dist/webhooks.d.mts +9 -3
- package/dist/webhooks.d.ts +9 -3
- package/package.json +6 -6
package/dist/field-configs.js
CHANGED
|
@@ -1471,23 +1471,173 @@ var import_zod3 = require("zod");
|
|
|
1471
1471
|
var uploadFileResponse = import_zod3.z.object({
|
|
1472
1472
|
upload_url: import_zod3.z.string().describe("A URL that points to your audio file, accessible only by AssemblyAI's servers\n")
|
|
1473
1473
|
});
|
|
1474
|
-
var createTranscriptBodyLanguageCodeDefault = "en_us";
|
|
1475
|
-
var createTranscriptBodyLanguageConfidenceThresholdMin = 0;
|
|
1476
|
-
var createTranscriptBodyLanguageConfidenceThresholdMax = 1;
|
|
1477
|
-
var createTranscriptBodySpeechModelDefault = "best";
|
|
1478
|
-
var createTranscriptBodyPunctuateDefault = true;
|
|
1479
|
-
var createTranscriptBodyFormatTextDefault = true;
|
|
1480
|
-
var createTranscriptBodyRedactPiiSubDefault = "hash";
|
|
1481
1474
|
var createTranscriptBodyContentSafetyConfidenceDefault = 50;
|
|
1482
|
-
var
|
|
1483
|
-
var
|
|
1484
|
-
var
|
|
1485
|
-
var
|
|
1475
|
+
var createTranscriptBodyFormatTextDefault = true;
|
|
1476
|
+
var createTranscriptBodyLanguageDetectionOptionsFallbackLanguageDefault = "auto";
|
|
1477
|
+
var createTranscriptBodyLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault = 0.3;
|
|
1478
|
+
var createTranscriptBodyPunctuateDefault = true;
|
|
1479
|
+
var createTranscriptBodySpeakerOptionsMinSpeakersExpectedDefault = 1;
|
|
1480
|
+
var createTranscriptBodySpeechUnderstandingRequestTranslationFormalDefault = true;
|
|
1486
1481
|
var createTranscriptBody = import_zod3.z.object({
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1482
|
+
audio_end_at: import_zod3.z.number().optional().describe(
|
|
1483
|
+
"The point in time, in milliseconds, to stop transcribing in your media file. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
1484
|
+
),
|
|
1485
|
+
audio_start_from: import_zod3.z.number().optional().describe(
|
|
1486
|
+
"The point in time, in milliseconds, to begin transcribing in your media file. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
1487
|
+
),
|
|
1488
|
+
auto_chapters: import_zod3.z.boolean().optional().describe(
|
|
1489
|
+
"Enable [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters), can be true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible chapter summaries. See the [updated Auto Chapters page](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
1490
|
+
),
|
|
1491
|
+
auto_highlights: import_zod3.z.boolean().optional().describe(
|
|
1492
|
+
"Enable [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases), either true or false"
|
|
1493
|
+
),
|
|
1494
|
+
content_safety: import_zod3.z.boolean().optional().describe(
|
|
1495
|
+
"Enable [Content Moderation](https://www.assemblyai.com/docs/content-moderation), can be true or false"
|
|
1496
|
+
),
|
|
1497
|
+
content_safety_confidence: import_zod3.z.number().default(createTranscriptBodyContentSafetyConfidenceDefault).describe(
|
|
1498
|
+
"The confidence threshold for the [Content Moderation](https://www.assemblyai.com/docs/content-moderation) model. Values must be between 25 and 100."
|
|
1499
|
+
),
|
|
1500
|
+
custom_spelling: import_zod3.z.array(
|
|
1501
|
+
import_zod3.z.object({
|
|
1502
|
+
from: import_zod3.z.array(import_zod3.z.string()).describe("Words or phrases to replace"),
|
|
1503
|
+
to: import_zod3.z.string().describe("Word to replace with")
|
|
1504
|
+
}).describe(
|
|
1505
|
+
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
1506
|
+
)
|
|
1507
|
+
).optional().describe(
|
|
1508
|
+
"Customize how words are spelled and formatted using to and from values. See [Custom Spelling](https://www.assemblyai.com/docs/pre-recorded-audio/custom-spelling) for more details."
|
|
1509
|
+
),
|
|
1510
|
+
disfluencies: import_zod3.z.boolean().optional().describe(
|
|
1511
|
+
'Transcribe [Filler Words](https://www.assemblyai.com/docs/pre-recorded-audio/filler-words), like "umm", in your media file; can be true or false'
|
|
1512
|
+
),
|
|
1513
|
+
domain: import_zod3.z.string().nullish().describe(
|
|
1514
|
+
'Enable domain-specific transcription models to improve accuracy for specialized terminology. Set to `"medical-v1"` to enable [Medical Mode](https://www.assemblyai.com/docs/pre-recorded-audio/medical-mode) for improved accuracy of medical terms such as medications, procedures, conditions, and dosages.\n\nSupported languages: English (`en`), Spanish (`es`), German (`de`), French (`fr`). If used with an unsupported language, the parameter is ignored and a warning is returned.\n'
|
|
1515
|
+
),
|
|
1516
|
+
entity_detection: import_zod3.z.boolean().optional().describe(
|
|
1517
|
+
"Enable [Entity Detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection), can be true or false"
|
|
1518
|
+
),
|
|
1519
|
+
filter_profanity: import_zod3.z.boolean().optional().describe(
|
|
1520
|
+
"Filter profanity from the transcribed text, can be true or false. See [Profanity Filtering](https://www.assemblyai.com/docs/profanity-filtering) for more details."
|
|
1521
|
+
),
|
|
1522
|
+
format_text: import_zod3.z.boolean().default(createTranscriptBodyFormatTextDefault).describe(
|
|
1523
|
+
"Enable [Text Formatting](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false"
|
|
1524
|
+
),
|
|
1525
|
+
iab_categories: import_zod3.z.boolean().optional().describe(
|
|
1526
|
+
"Enable [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection), can be true or false"
|
|
1527
|
+
),
|
|
1528
|
+
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
1529
|
+
"Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.\n"
|
|
1530
|
+
),
|
|
1531
|
+
language_code: import_zod3.z.enum([
|
|
1532
|
+
"en",
|
|
1533
|
+
"en_au",
|
|
1534
|
+
"en_uk",
|
|
1535
|
+
"en_us",
|
|
1536
|
+
"es",
|
|
1537
|
+
"fr",
|
|
1538
|
+
"de",
|
|
1539
|
+
"it",
|
|
1540
|
+
"pt",
|
|
1541
|
+
"nl",
|
|
1542
|
+
"af",
|
|
1543
|
+
"sq",
|
|
1544
|
+
"am",
|
|
1545
|
+
"ar",
|
|
1546
|
+
"hy",
|
|
1547
|
+
"as",
|
|
1548
|
+
"az",
|
|
1549
|
+
"ba",
|
|
1550
|
+
"eu",
|
|
1551
|
+
"be",
|
|
1552
|
+
"bn",
|
|
1553
|
+
"bs",
|
|
1554
|
+
"br",
|
|
1555
|
+
"bg",
|
|
1556
|
+
"my",
|
|
1557
|
+
"ca",
|
|
1558
|
+
"zh",
|
|
1559
|
+
"hr",
|
|
1560
|
+
"cs",
|
|
1561
|
+
"da",
|
|
1562
|
+
"et",
|
|
1563
|
+
"fo",
|
|
1564
|
+
"fi",
|
|
1565
|
+
"gl",
|
|
1566
|
+
"ka",
|
|
1567
|
+
"el",
|
|
1568
|
+
"gu",
|
|
1569
|
+
"ht",
|
|
1570
|
+
"ha",
|
|
1571
|
+
"haw",
|
|
1572
|
+
"he",
|
|
1573
|
+
"hi",
|
|
1574
|
+
"hu",
|
|
1575
|
+
"is",
|
|
1576
|
+
"id",
|
|
1577
|
+
"ja",
|
|
1578
|
+
"jw",
|
|
1579
|
+
"kn",
|
|
1580
|
+
"kk",
|
|
1581
|
+
"km",
|
|
1582
|
+
"ko",
|
|
1583
|
+
"lo",
|
|
1584
|
+
"la",
|
|
1585
|
+
"lv",
|
|
1586
|
+
"ln",
|
|
1587
|
+
"lt",
|
|
1588
|
+
"lb",
|
|
1589
|
+
"mk",
|
|
1590
|
+
"mg",
|
|
1591
|
+
"ms",
|
|
1592
|
+
"ml",
|
|
1593
|
+
"mt",
|
|
1594
|
+
"mi",
|
|
1595
|
+
"mr",
|
|
1596
|
+
"mn",
|
|
1597
|
+
"ne",
|
|
1598
|
+
"no",
|
|
1599
|
+
"nn",
|
|
1600
|
+
"oc",
|
|
1601
|
+
"pa",
|
|
1602
|
+
"ps",
|
|
1603
|
+
"fa",
|
|
1604
|
+
"pl",
|
|
1605
|
+
"ro",
|
|
1606
|
+
"ru",
|
|
1607
|
+
"sa",
|
|
1608
|
+
"sr",
|
|
1609
|
+
"sn",
|
|
1610
|
+
"sd",
|
|
1611
|
+
"si",
|
|
1612
|
+
"sk",
|
|
1613
|
+
"sl",
|
|
1614
|
+
"so",
|
|
1615
|
+
"su",
|
|
1616
|
+
"sw",
|
|
1617
|
+
"sv",
|
|
1618
|
+
"tl",
|
|
1619
|
+
"tg",
|
|
1620
|
+
"ta",
|
|
1621
|
+
"tt",
|
|
1622
|
+
"te",
|
|
1623
|
+
"th",
|
|
1624
|
+
"bo",
|
|
1625
|
+
"tr",
|
|
1626
|
+
"tk",
|
|
1627
|
+
"uk",
|
|
1628
|
+
"ur",
|
|
1629
|
+
"uz",
|
|
1630
|
+
"vi",
|
|
1631
|
+
"cy",
|
|
1632
|
+
"yi",
|
|
1633
|
+
"yo"
|
|
1634
|
+
]).describe(
|
|
1635
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
1636
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
1637
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
1638
|
+
),
|
|
1639
|
+
language_codes: import_zod3.z.array(
|
|
1640
|
+
import_zod3.z.enum([
|
|
1491
1641
|
"en",
|
|
1492
1642
|
"en_au",
|
|
1493
1643
|
"en_uk",
|
|
@@ -1591,429 +1741,62 @@ var createTranscriptBody = import_zod3.z.object({
|
|
|
1591
1741
|
"yi",
|
|
1592
1742
|
"yo"
|
|
1593
1743
|
]).describe(
|
|
1594
|
-
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/
|
|
1595
|
-
)
|
|
1596
|
-
|
|
1597
|
-
)
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
)
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
),
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
)
|
|
1607
|
-
|
|
1608
|
-
format_text: import_zod3.z.boolean().default(createTranscriptBodyFormatTextDefault).describe("Enable Text Formatting, can be true or false"),
|
|
1609
|
-
disfluencies: import_zod3.z.boolean().optional().describe(
|
|
1610
|
-
'Transcribe Filler Words, like "umm", in your media file; can be true or false'
|
|
1611
|
-
),
|
|
1612
|
-
multichannel: import_zod3.z.boolean().optional().describe(
|
|
1613
|
-
"Enable [Multichannel](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription) transcription, can be true or false."
|
|
1614
|
-
),
|
|
1615
|
-
webhook_url: import_zod3.z.string().optional().describe(
|
|
1616
|
-
"The URL to which we send webhook requests.\nWe sends two different types of webhook requests.\nOne request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.\n"
|
|
1617
|
-
),
|
|
1618
|
-
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
1619
|
-
"The header name to be sent with the transcript completed or failed webhook requests"
|
|
1620
|
-
),
|
|
1621
|
-
webhook_auth_header_value: import_zod3.z.string().nullish().describe(
|
|
1622
|
-
"The header value to send back with the transcript completed or failed webhook requests for added security"
|
|
1623
|
-
),
|
|
1624
|
-
auto_highlights: import_zod3.z.boolean().optional().describe("Enable Key Phrases, either true or false"),
|
|
1625
|
-
audio_start_from: import_zod3.z.number().optional().describe("The point in time, in milliseconds, to begin transcribing in your media file"),
|
|
1626
|
-
audio_end_at: import_zod3.z.number().optional().describe("The point in time, in milliseconds, to stop transcribing in your media file"),
|
|
1627
|
-
word_boost: import_zod3.z.array(import_zod3.z.string()).optional().describe("The list of custom vocabulary to boost transcription probability for"),
|
|
1628
|
-
boost_param: import_zod3.z.enum(["low", "default", "high"]).optional().describe("How much to boost specified words"),
|
|
1629
|
-
filter_profanity: import_zod3.z.boolean().optional().describe("Filter profanity from the transcribed text, can be true or false"),
|
|
1630
|
-
redact_pii: import_zod3.z.boolean().optional().describe(
|
|
1631
|
-
"Redact PII from the transcribed text using the Redact PII model, can be true or false"
|
|
1632
|
-
),
|
|
1633
|
-
redact_pii_audio: import_zod3.z.boolean().optional().describe(
|
|
1634
|
-
'Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.'
|
|
1635
|
-
),
|
|
1636
|
-
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).optional().describe(
|
|
1637
|
-
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details."
|
|
1638
|
-
),
|
|
1639
|
-
redact_pii_policies: import_zod3.z.array(
|
|
1640
|
-
import_zod3.z.enum([
|
|
1641
|
-
"account_number",
|
|
1642
|
-
"banking_information",
|
|
1643
|
-
"blood_type",
|
|
1644
|
-
"credit_card_cvv",
|
|
1645
|
-
"credit_card_expiration",
|
|
1646
|
-
"credit_card_number",
|
|
1647
|
-
"date",
|
|
1648
|
-
"date_interval",
|
|
1649
|
-
"date_of_birth",
|
|
1650
|
-
"drivers_license",
|
|
1651
|
-
"drug",
|
|
1652
|
-
"duration",
|
|
1653
|
-
"email_address",
|
|
1654
|
-
"event",
|
|
1655
|
-
"filename",
|
|
1656
|
-
"gender_sexuality",
|
|
1657
|
-
"healthcare_number",
|
|
1658
|
-
"injury",
|
|
1659
|
-
"ip_address",
|
|
1660
|
-
"language",
|
|
1661
|
-
"location",
|
|
1662
|
-
"marital_status",
|
|
1663
|
-
"medical_condition",
|
|
1664
|
-
"medical_process",
|
|
1665
|
-
"money_amount",
|
|
1666
|
-
"nationality",
|
|
1667
|
-
"number_sequence",
|
|
1668
|
-
"occupation",
|
|
1669
|
-
"organization",
|
|
1670
|
-
"passport_number",
|
|
1671
|
-
"password",
|
|
1672
|
-
"person_age",
|
|
1673
|
-
"person_name",
|
|
1674
|
-
"phone_number",
|
|
1675
|
-
"physical_attribute",
|
|
1676
|
-
"political_affiliation",
|
|
1677
|
-
"religion",
|
|
1678
|
-
"statistics",
|
|
1679
|
-
"time",
|
|
1680
|
-
"url",
|
|
1681
|
-
"us_social_security_number",
|
|
1682
|
-
"username",
|
|
1683
|
-
"vehicle_id",
|
|
1684
|
-
"zodiac_sign"
|
|
1685
|
-
]).describe("The type of PII to redact")
|
|
1686
|
-
).optional().describe(
|
|
1687
|
-
"The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details."
|
|
1688
|
-
),
|
|
1689
|
-
redact_pii_sub: import_zod3.z.enum(["entity_name", "hash"]).describe(
|
|
1690
|
-
'The replacement logic for detected PII, can be "entity_name" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.'
|
|
1691
|
-
).or(import_zod3.z.null()).default(createTranscriptBodyRedactPiiSubDefault).describe(
|
|
1692
|
-
'The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.'
|
|
1693
|
-
),
|
|
1694
|
-
speaker_labels: import_zod3.z.boolean().optional().describe(
|
|
1695
|
-
"Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false"
|
|
1696
|
-
),
|
|
1697
|
-
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
1698
|
-
"Tells the speaker label model how many speakers it should attempt to identify. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details."
|
|
1699
|
-
),
|
|
1700
|
-
content_safety: import_zod3.z.boolean().optional().describe(
|
|
1701
|
-
"Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false"
|
|
1702
|
-
),
|
|
1703
|
-
content_safety_confidence: import_zod3.z.number().min(createTranscriptBodyContentSafetyConfidenceMin).max(createTranscriptBodyContentSafetyConfidenceMax).default(createTranscriptBodyContentSafetyConfidenceDefault).describe(
|
|
1704
|
-
"The confidence threshold for the Content Moderation model. Values must be between 25 and 100."
|
|
1705
|
-
),
|
|
1706
|
-
iab_categories: import_zod3.z.boolean().optional().describe(
|
|
1707
|
-
"Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false"
|
|
1708
|
-
),
|
|
1709
|
-
custom_spelling: import_zod3.z.array(
|
|
1710
|
-
import_zod3.z.object({
|
|
1711
|
-
from: import_zod3.z.array(import_zod3.z.string().describe("Word or phrase to replace")).describe("Words or phrases to replace"),
|
|
1712
|
-
to: import_zod3.z.string().describe("Word to replace with")
|
|
1713
|
-
}).describe(
|
|
1714
|
-
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
1715
|
-
)
|
|
1716
|
-
).optional().describe("Customize how words are spelled and formatted using to and from values"),
|
|
1717
|
-
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
1718
|
-
"<Warning>`keyterms_prompt` is only supported when the `speech_model` is specified as `slam-1`</Warning>\nImprove accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase).\n"
|
|
1719
|
-
),
|
|
1720
|
-
prompt: import_zod3.z.string().optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
1721
|
-
sentiment_analysis: import_zod3.z.boolean().optional().describe(
|
|
1722
|
-
"Enable [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be true or false"
|
|
1723
|
-
),
|
|
1724
|
-
auto_chapters: import_zod3.z.boolean().optional().describe(
|
|
1725
|
-
"Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false"
|
|
1744
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
1745
|
+
)
|
|
1746
|
+
).nullish().describe(
|
|
1747
|
+
"The language codes of your audio file. Used for [Code switching](/docs/speech-to-text/pre-recorded-audio/code-switching)\nOne of the values specified must be `en`.\n"
|
|
1748
|
+
),
|
|
1749
|
+
language_confidence_threshold: import_zod3.z.number().optional().describe(
|
|
1750
|
+
"The confidence threshold for the automatically detected language.\nAn error will be returned if the language confidence is below this threshold.\nDefaults to 0. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n"
|
|
1751
|
+
),
|
|
1752
|
+
language_detection: import_zod3.z.boolean().optional().describe(
|
|
1753
|
+
"Enable [Automatic language detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection), either true or false."
|
|
1754
|
+
),
|
|
1755
|
+
language_detection_options: import_zod3.z.object({
|
|
1756
|
+
expected_languages: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
1757
|
+
'List of languages expected in the audio file. Defaults to `["all"]` when unspecified. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.'
|
|
1726
1758
|
),
|
|
1727
|
-
|
|
1728
|
-
"
|
|
1759
|
+
fallback_language: import_zod3.z.string().default(createTranscriptBodyLanguageDetectionOptionsFallbackLanguageDefault).describe(
|
|
1760
|
+
'If the detected language of the audio file is not in the list of expected languages, the `fallback_language` is used. Specify `["auto"]` to let our model choose the fallback language from `expected_languages` with the highest confidence score. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n'
|
|
1729
1761
|
),
|
|
1730
|
-
|
|
1731
|
-
"
|
|
1762
|
+
code_switching: import_zod3.z.boolean().optional().describe(
|
|
1763
|
+
"Whether [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) should be detected.\n"
|
|
1732
1764
|
),
|
|
1733
|
-
|
|
1734
|
-
|
|
1765
|
+
code_switching_confidence_threshold: import_zod3.z.number().default(
|
|
1766
|
+
createTranscriptBodyLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault
|
|
1767
|
+
).describe(
|
|
1768
|
+
"The confidence threshold for [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) detection. If the code switching confidence is below this threshold, the transcript will be processed in the language with the highest `language_detection_confidence` score.\n"
|
|
1769
|
+
)
|
|
1770
|
+
}).optional().describe(
|
|
1771
|
+
"Specify options for [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection)."
|
|
1772
|
+
),
|
|
1773
|
+
multichannel: import_zod3.z.boolean().optional().describe(
|
|
1774
|
+
"Enable [Multichannel](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) transcription, can be true or false."
|
|
1775
|
+
),
|
|
1776
|
+
prompt: import_zod3.z.string().optional().describe(
|
|
1777
|
+
"Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
1778
|
+
),
|
|
1779
|
+
punctuate: import_zod3.z.boolean().default(createTranscriptBodyPunctuateDefault).describe(
|
|
1780
|
+
"Enable [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false"
|
|
1781
|
+
),
|
|
1782
|
+
redact_pii: import_zod3.z.boolean().optional().describe(
|
|
1783
|
+
"Redact PII from the transcribed text using the Redact PII model, can be true or false. See [PII Redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
1784
|
+
),
|
|
1785
|
+
redact_pii_audio: import_zod3.z.boolean().optional().describe(
|
|
1786
|
+
'Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details.'
|
|
1787
|
+
),
|
|
1788
|
+
redact_pii_audio_options: import_zod3.z.object({
|
|
1789
|
+
return_redacted_no_speech_audio: import_zod3.z.boolean().optional().describe(
|
|
1790
|
+
"By default, audio redaction provides redacted audio URLs only when speech is detected. However, if your use-case specifically requires redacted audio files even for silent audio files without any dialogue, you can opt to receive these URLs by setting this parameter to `true`."
|
|
1735
1791
|
),
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
).describe("The parameters for creating a transcript");
|
|
1742
|
-
var createTranscriptResponseLanguageConfidenceThresholdMin = 0;
|
|
1743
|
-
var createTranscriptResponseLanguageConfidenceThresholdMax = 1;
|
|
1744
|
-
var createTranscriptResponseLanguageConfidenceMin = 0;
|
|
1745
|
-
var createTranscriptResponseLanguageConfidenceMax = 1;
|
|
1746
|
-
var createTranscriptResponseWordsItemConfidenceMin = 0;
|
|
1747
|
-
var createTranscriptResponseWordsItemConfidenceMax = 1;
|
|
1748
|
-
var createTranscriptResponseUtterancesItemConfidenceMin = 0;
|
|
1749
|
-
var createTranscriptResponseUtterancesItemConfidenceMax = 1;
|
|
1750
|
-
var createTranscriptResponseUtterancesItemWordsItemConfidenceMin = 0;
|
|
1751
|
-
var createTranscriptResponseUtterancesItemWordsItemConfidenceMax = 1;
|
|
1752
|
-
var createTranscriptResponseConfidenceMin = 0;
|
|
1753
|
-
var createTranscriptResponseConfidenceMax = 1;
|
|
1754
|
-
var createTranscriptResponseAutoHighlightsResultResultsItemRankMin = 0;
|
|
1755
|
-
var createTranscriptResponseAutoHighlightsResultResultsItemRankMax = 1;
|
|
1756
|
-
var createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMin = 0;
|
|
1757
|
-
var createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMax = 1;
|
|
1758
|
-
var createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMin = 0;
|
|
1759
|
-
var createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMax = 1;
|
|
1760
|
-
var createTranscriptResponseContentSafetyLabelsSummaryMinOne = 0;
|
|
1761
|
-
var createTranscriptResponseContentSafetyLabelsSummaryMaxOne = 1;
|
|
1762
|
-
var createTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMin = 0;
|
|
1763
|
-
var createTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMax = 1;
|
|
1764
|
-
var createTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMin = 0;
|
|
1765
|
-
var createTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMax = 1;
|
|
1766
|
-
var createTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMin = 0;
|
|
1767
|
-
var createTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMax = 1;
|
|
1768
|
-
var createTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMin = 0;
|
|
1769
|
-
var createTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMax = 1;
|
|
1770
|
-
var createTranscriptResponseIabCategoriesResultSummaryMinOne = 0;
|
|
1771
|
-
var createTranscriptResponseIabCategoriesResultSummaryMaxOne = 1;
|
|
1772
|
-
var createTranscriptResponseSentimentAnalysisResultsItemConfidenceMin = 0;
|
|
1773
|
-
var createTranscriptResponseSentimentAnalysisResultsItemConfidenceMax = 1;
|
|
1774
|
-
var createTranscriptResponseSpeechThresholdMin = 0;
|
|
1775
|
-
var createTranscriptResponseSpeechThresholdMax = 1;
|
|
1776
|
-
var createTranscriptResponse = import_zod3.z.object({
|
|
1777
|
-
id: import_zod3.z.string().uuid().describe("The unique identifier of your transcript"),
|
|
1778
|
-
audio_url: import_zod3.z.string().describe("The URL of the media that was transcribed"),
|
|
1779
|
-
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).describe(
|
|
1780
|
-
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
1792
|
+
override_audio_redaction_method: import_zod3.z.enum(["silence"]).optional().describe(
|
|
1793
|
+
"Specify the method used to redact audio. By default, redacted audio uses a beep sound. Set to `silence` to replace PII with silence instead of a beep."
|
|
1794
|
+
)
|
|
1795
|
+
}).optional().describe(
|
|
1796
|
+
"Specify options for [PII redacted audio](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) files."
|
|
1781
1797
|
),
|
|
1782
|
-
|
|
1783
|
-
"
|
|
1784
|
-
"en_au",
|
|
1785
|
-
"en_uk",
|
|
1786
|
-
"en_us",
|
|
1787
|
-
"es",
|
|
1788
|
-
"fr",
|
|
1789
|
-
"de",
|
|
1790
|
-
"it",
|
|
1791
|
-
"pt",
|
|
1792
|
-
"nl",
|
|
1793
|
-
"af",
|
|
1794
|
-
"sq",
|
|
1795
|
-
"am",
|
|
1796
|
-
"ar",
|
|
1797
|
-
"hy",
|
|
1798
|
-
"as",
|
|
1799
|
-
"az",
|
|
1800
|
-
"ba",
|
|
1801
|
-
"eu",
|
|
1802
|
-
"be",
|
|
1803
|
-
"bn",
|
|
1804
|
-
"bs",
|
|
1805
|
-
"br",
|
|
1806
|
-
"bg",
|
|
1807
|
-
"my",
|
|
1808
|
-
"ca",
|
|
1809
|
-
"zh",
|
|
1810
|
-
"hr",
|
|
1811
|
-
"cs",
|
|
1812
|
-
"da",
|
|
1813
|
-
"et",
|
|
1814
|
-
"fo",
|
|
1815
|
-
"fi",
|
|
1816
|
-
"gl",
|
|
1817
|
-
"ka",
|
|
1818
|
-
"el",
|
|
1819
|
-
"gu",
|
|
1820
|
-
"ht",
|
|
1821
|
-
"ha",
|
|
1822
|
-
"haw",
|
|
1823
|
-
"he",
|
|
1824
|
-
"hi",
|
|
1825
|
-
"hu",
|
|
1826
|
-
"is",
|
|
1827
|
-
"id",
|
|
1828
|
-
"ja",
|
|
1829
|
-
"jw",
|
|
1830
|
-
"kn",
|
|
1831
|
-
"kk",
|
|
1832
|
-
"km",
|
|
1833
|
-
"ko",
|
|
1834
|
-
"lo",
|
|
1835
|
-
"la",
|
|
1836
|
-
"lv",
|
|
1837
|
-
"ln",
|
|
1838
|
-
"lt",
|
|
1839
|
-
"lb",
|
|
1840
|
-
"mk",
|
|
1841
|
-
"mg",
|
|
1842
|
-
"ms",
|
|
1843
|
-
"ml",
|
|
1844
|
-
"mt",
|
|
1845
|
-
"mi",
|
|
1846
|
-
"mr",
|
|
1847
|
-
"mn",
|
|
1848
|
-
"ne",
|
|
1849
|
-
"no",
|
|
1850
|
-
"nn",
|
|
1851
|
-
"oc",
|
|
1852
|
-
"pa",
|
|
1853
|
-
"ps",
|
|
1854
|
-
"fa",
|
|
1855
|
-
"pl",
|
|
1856
|
-
"ro",
|
|
1857
|
-
"ru",
|
|
1858
|
-
"sa",
|
|
1859
|
-
"sr",
|
|
1860
|
-
"sn",
|
|
1861
|
-
"sd",
|
|
1862
|
-
"si",
|
|
1863
|
-
"sk",
|
|
1864
|
-
"sl",
|
|
1865
|
-
"so",
|
|
1866
|
-
"su",
|
|
1867
|
-
"sw",
|
|
1868
|
-
"sv",
|
|
1869
|
-
"tl",
|
|
1870
|
-
"tg",
|
|
1871
|
-
"ta",
|
|
1872
|
-
"tt",
|
|
1873
|
-
"te",
|
|
1874
|
-
"th",
|
|
1875
|
-
"bo",
|
|
1876
|
-
"tr",
|
|
1877
|
-
"tk",
|
|
1878
|
-
"uk",
|
|
1879
|
-
"ur",
|
|
1880
|
-
"uz",
|
|
1881
|
-
"vi",
|
|
1882
|
-
"cy",
|
|
1883
|
-
"yi",
|
|
1884
|
-
"yo"
|
|
1885
|
-
]).describe(
|
|
1886
|
-
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'.\n"
|
|
1887
|
-
).or(import_zod3.z.string()).optional().describe(
|
|
1888
|
-
"The language of your audio file.\nPossible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'.\n"
|
|
1889
|
-
),
|
|
1890
|
-
language_detection: import_zod3.z.boolean().nullish().describe(
|
|
1891
|
-
"Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) is enabled, either true or false"
|
|
1892
|
-
),
|
|
1893
|
-
language_confidence_threshold: import_zod3.z.number().min(createTranscriptResponseLanguageConfidenceThresholdMin).max(createTranscriptResponseLanguageConfidenceThresholdMax).nullable().describe(
|
|
1894
|
-
"The confidence threshold for the automatically detected language.\nAn error will be returned if the language confidence is below this threshold.\n"
|
|
1895
|
-
),
|
|
1896
|
-
language_confidence: import_zod3.z.number().min(createTranscriptResponseLanguageConfidenceMin).max(createTranscriptResponseLanguageConfidenceMax).nullable().describe(
|
|
1897
|
-
"The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
1898
|
-
),
|
|
1899
|
-
speech_model: import_zod3.z.enum(["best", "slam-1", "universal"]).describe("The speech model to use for the transcription.").or(import_zod3.z.null()).describe(
|
|
1900
|
-
"The speech model used for the transcription. When `null`, the default model is used."
|
|
1901
|
-
),
|
|
1902
|
-
text: import_zod3.z.string().nullish().describe("The textual transcript of your media file"),
|
|
1903
|
-
words: import_zod3.z.array(
|
|
1904
|
-
import_zod3.z.object({
|
|
1905
|
-
confidence: import_zod3.z.number().min(createTranscriptResponseWordsItemConfidenceMin).max(createTranscriptResponseWordsItemConfidenceMax).describe("The confidence score for the transcript of this word"),
|
|
1906
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
1907
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
1908
|
-
text: import_zod3.z.string().describe("The text of the word"),
|
|
1909
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
1910
|
-
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
1911
|
-
),
|
|
1912
|
-
speaker: import_zod3.z.string().nullable().describe(
|
|
1913
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null"
|
|
1914
|
-
)
|
|
1915
|
-
})
|
|
1916
|
-
).nullish().describe(
|
|
1917
|
-
"An array of temporally-sequential word objects, one for each word in the transcript.\nSee [Speech recognition](https://www.assemblyai.com/docs/models/speech-recognition) for more information.\n"
|
|
1918
|
-
),
|
|
1919
|
-
utterances: import_zod3.z.array(
|
|
1920
|
-
import_zod3.z.object({
|
|
1921
|
-
confidence: import_zod3.z.number().min(createTranscriptResponseUtterancesItemConfidenceMin).max(createTranscriptResponseUtterancesItemConfidenceMax).describe("The confidence score for the transcript of this utterance"),
|
|
1922
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the utterance in the audio file"),
|
|
1923
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the utterance in the audio file"),
|
|
1924
|
-
text: import_zod3.z.string().describe("The text for this utterance"),
|
|
1925
|
-
words: import_zod3.z.array(
|
|
1926
|
-
import_zod3.z.object({
|
|
1927
|
-
confidence: import_zod3.z.number().min(createTranscriptResponseUtterancesItemWordsItemConfidenceMin).max(createTranscriptResponseUtterancesItemWordsItemConfidenceMax).describe("The confidence score for the transcript of this word"),
|
|
1928
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
1929
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
1930
|
-
text: import_zod3.z.string().describe("The text of the word"),
|
|
1931
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
1932
|
-
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
1933
|
-
),
|
|
1934
|
-
speaker: import_zod3.z.string().nullable().describe(
|
|
1935
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null"
|
|
1936
|
-
)
|
|
1937
|
-
})
|
|
1938
|
-
).describe("The words in the utterance."),
|
|
1939
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
1940
|
-
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
1941
|
-
),
|
|
1942
|
-
speaker: import_zod3.z.string().describe(
|
|
1943
|
-
'The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.'
|
|
1944
|
-
)
|
|
1945
|
-
})
|
|
1946
|
-
).nullish().describe(
|
|
1947
|
-
"When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/speech-to-text/speaker-diarization) and [Multichannel transcription](https://www.assemblyai.com/docs/speech-to-text/speech-recognition#multichannel-transcription) for more information.\n"
|
|
1948
|
-
),
|
|
1949
|
-
confidence: import_zod3.z.number().min(createTranscriptResponseConfidenceMin).max(createTranscriptResponseConfidenceMax).nullish().describe(
|
|
1950
|
-
"The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
1951
|
-
),
|
|
1952
|
-
audio_duration: import_zod3.z.number().nullish().describe("The duration of this transcript object's media file, in seconds"),
|
|
1953
|
-
punctuate: import_zod3.z.boolean().nullish().describe("Whether Automatic Punctuation is enabled, either true or false"),
|
|
1954
|
-
format_text: import_zod3.z.boolean().nullish().describe("Whether Text Formatting is enabled, either true or false"),
|
|
1955
|
-
disfluencies: import_zod3.z.boolean().nullish().describe('Transcribe Filler Words, like "umm", in your media file; can be true or false'),
|
|
1956
|
-
multichannel: import_zod3.z.boolean().nullish().describe(
|
|
1957
|
-
"Whether [Multichannel transcription](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription) was enabled in the transcription request, either true or false"
|
|
1958
|
-
),
|
|
1959
|
-
audio_channels: import_zod3.z.number().optional().describe(
|
|
1960
|
-
"The number of audio channels in the audio file. This is only present when multichannel is enabled."
|
|
1961
|
-
),
|
|
1962
|
-
webhook_url: import_zod3.z.string().nullish().describe(
|
|
1963
|
-
"The URL to which we send webhook requests.\nWe sends two different types of webhook requests.\nOne request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.\n"
|
|
1964
|
-
),
|
|
1965
|
-
webhook_status_code: import_zod3.z.number().nullish().describe(
|
|
1966
|
-
"The status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided"
|
|
1967
|
-
),
|
|
1968
|
-
webhook_auth: import_zod3.z.boolean().describe("Whether webhook authentication details were provided"),
|
|
1969
|
-
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
1970
|
-
"The header name to be sent with the transcript completed or failed webhook requests"
|
|
1971
|
-
),
|
|
1972
|
-
speed_boost: import_zod3.z.boolean().nullish().describe("Whether speed boost is enabled"),
|
|
1973
|
-
auto_highlights: import_zod3.z.boolean().describe("Whether Key Phrases is enabled, either true or false"),
|
|
1974
|
-
auto_highlights_result: import_zod3.z.object({
|
|
1975
|
-
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
1976
|
-
results: import_zod3.z.array(
|
|
1977
|
-
import_zod3.z.object({
|
|
1978
|
-
count: import_zod3.z.number().describe("The total number of times the key phrase appears in the audio file"),
|
|
1979
|
-
rank: import_zod3.z.number().min(createTranscriptResponseAutoHighlightsResultResultsItemRankMin).max(createTranscriptResponseAutoHighlightsResultResultsItemRankMax).describe(
|
|
1980
|
-
"The total relevancy to the overall audio file of this key phrase - a greater number means more relevant"
|
|
1981
|
-
),
|
|
1982
|
-
text: import_zod3.z.string().describe("The text itself of the key phrase"),
|
|
1983
|
-
timestamps: import_zod3.z.array(
|
|
1984
|
-
import_zod3.z.object({
|
|
1985
|
-
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
1986
|
-
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
1987
|
-
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
1988
|
-
).describe("The timestamp of the of the key phrase")
|
|
1989
|
-
})
|
|
1990
|
-
).describe("A temporally-sequential array of Key Phrases")
|
|
1991
|
-
}).describe(
|
|
1992
|
-
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.\n"
|
|
1993
|
-
).or(import_zod3.z.null()).optional().describe(
|
|
1994
|
-
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key Phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.\n"
|
|
1995
|
-
),
|
|
1996
|
-
audio_start_from: import_zod3.z.number().nullish().describe(
|
|
1997
|
-
"The point in time, in milliseconds, in the file at which the transcription was started"
|
|
1998
|
-
),
|
|
1999
|
-
audio_end_at: import_zod3.z.number().nullish().describe(
|
|
2000
|
-
"The point in time, in milliseconds, in the file at which the transcription was terminated"
|
|
2001
|
-
),
|
|
2002
|
-
word_boost: import_zod3.z.array(import_zod3.z.string()).optional().describe("The list of custom vocabulary to boost transcription probability for"),
|
|
2003
|
-
boost_param: import_zod3.z.string().nullish().describe("The word boost parameter value"),
|
|
2004
|
-
filter_profanity: import_zod3.z.boolean().nullish().describe(
|
|
2005
|
-
"Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false"
|
|
2006
|
-
),
|
|
2007
|
-
redact_pii: import_zod3.z.boolean().describe(
|
|
2008
|
-
"Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false"
|
|
2009
|
-
),
|
|
2010
|
-
redact_pii_audio: import_zod3.z.boolean().nullish().describe(
|
|
2011
|
-
"Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.\n"
|
|
2012
|
-
),
|
|
2013
|
-
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).describe(
|
|
2014
|
-
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details."
|
|
2015
|
-
).or(import_zod3.z.null()).optional().describe(
|
|
2016
|
-
"The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.\n"
|
|
1798
|
+
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).optional().describe(
|
|
1799
|
+
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details."
|
|
2017
1800
|
),
|
|
2018
1801
|
redact_pii_policies: import_zod3.z.array(
|
|
2019
1802
|
import_zod3.z.enum([
|
|
@@ -2062,123 +1845,174 @@ var createTranscriptResponse = import_zod3.z.object({
|
|
|
2062
1845
|
"vehicle_id",
|
|
2063
1846
|
"zodiac_sign"
|
|
2064
1847
|
]).describe("The type of PII to redact")
|
|
2065
|
-
).
|
|
2066
|
-
"The list of PII Redaction policies
|
|
1848
|
+
).optional().describe(
|
|
1849
|
+
"The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
2067
1850
|
),
|
|
2068
|
-
redact_pii_sub: import_zod3.z.enum(["entity_name", "hash"]).
|
|
2069
|
-
|
|
1851
|
+
redact_pii_sub: import_zod3.z.enum(["entity_name", "hash"]).describe(
|
|
1852
|
+
"The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
1853
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
1854
|
+
"The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
2070
1855
|
),
|
|
2071
|
-
|
|
2072
|
-
"
|
|
1856
|
+
sentiment_analysis: import_zod3.z.boolean().optional().describe(
|
|
1857
|
+
"Enable [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis), can be true or false"
|
|
1858
|
+
),
|
|
1859
|
+
speaker_labels: import_zod3.z.boolean().optional().describe(
|
|
1860
|
+
"Enable [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization), can be true or false"
|
|
1861
|
+
),
|
|
1862
|
+
speaker_options: import_zod3.z.object({
|
|
1863
|
+
min_speakers_expected: import_zod3.z.number().default(createTranscriptBodySpeakerOptionsMinSpeakersExpectedDefault).describe(
|
|
1864
|
+
"The minimum number of speakers expected in the audio file. See [Set a range of possible speakers](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-a-range-of-possible-speakers) for more details."
|
|
1865
|
+
),
|
|
1866
|
+
max_speakers_expected: import_zod3.z.number().optional().describe(
|
|
1867
|
+
"<Warning>Setting this parameter too high may hurt model accuracy</Warning>\nThe maximum number of speakers expected in the audio file. The default depends on audio duration: no limit for 0-2 minutes, 10 for 2-10 minutes, and 30 for 10+ minutes. See [Set a range of possible speakers](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-a-range-of-possible-speakers) for more details.\n"
|
|
1868
|
+
)
|
|
1869
|
+
}).optional().describe(
|
|
1870
|
+
"Specify options for [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-a-range-of-possible-speakers). Use this to set a range of possible speakers."
|
|
2073
1871
|
),
|
|
2074
1872
|
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
2075
|
-
"
|
|
1873
|
+
"Tells the speaker label model how many speakers it should attempt to identify. See [Set number of speakers expected](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-number-of-speakers-expected) for more details."
|
|
2076
1874
|
),
|
|
2077
|
-
|
|
2078
|
-
|
|
1875
|
+
speech_models: import_zod3.z.array(
|
|
1876
|
+
import_zod3.z.string().describe(
|
|
1877
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
1878
|
+
)
|
|
1879
|
+
).describe(
|
|
1880
|
+
"List multiple speech models in priority order, allowing our system to automatically route your audio to the best available option. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models and routing behavior.\n"
|
|
2079
1881
|
),
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
confidence: import_zod3.z.number().min(
|
|
2089
|
-
createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMin
|
|
2090
|
-
).max(
|
|
2091
|
-
createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMax
|
|
2092
|
-
).describe("The confidence score for the topic being discussed, from 0 to 1"),
|
|
2093
|
-
severity: import_zod3.z.number().min(
|
|
2094
|
-
createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMin
|
|
2095
|
-
).max(
|
|
2096
|
-
createTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMax
|
|
2097
|
-
).describe("How severely the topic is discussed in the section, from 0 to 1")
|
|
2098
|
-
})
|
|
2099
|
-
).describe(
|
|
2100
|
-
"An array of safety labels, one per sensitive topic that was detected in the section"
|
|
1882
|
+
speech_threshold: import_zod3.z.number().nullish().describe(
|
|
1883
|
+
"Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive. See [Speech Threshold](https://www.assemblyai.com/docs/speech-threshold) for more details.\n"
|
|
1884
|
+
),
|
|
1885
|
+
speech_understanding: import_zod3.z.object({
|
|
1886
|
+
request: import_zod3.z.object({
|
|
1887
|
+
translation: import_zod3.z.object({
|
|
1888
|
+
target_languages: import_zod3.z.array(import_zod3.z.string()).describe(
|
|
1889
|
+
'List of target language codes (e.g., `["es", "de"]`). See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for supported languages.'
|
|
2101
1890
|
),
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
1891
|
+
formal: import_zod3.z.boolean().default(createTranscriptBodySpeechUnderstandingRequestTranslationFormalDefault).describe(
|
|
1892
|
+
"Use formal language style. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
1893
|
+
),
|
|
1894
|
+
match_original_utterance: import_zod3.z.boolean().optional().describe(
|
|
1895
|
+
"When enabled with Speaker Labels, returns translated text in the utterances array. Each utterance will include a `translated_texts` key containing translations for each target language."
|
|
1896
|
+
)
|
|
2108
1897
|
})
|
|
2109
|
-
).describe(
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
import_zod3.z.
|
|
2113
|
-
|
|
1898
|
+
}).describe(
|
|
1899
|
+
"Request body for [Translation](https://www.assemblyai.com/docs/speech-understanding/translation)."
|
|
1900
|
+
).or(
|
|
1901
|
+
import_zod3.z.object({
|
|
1902
|
+
speaker_identification: import_zod3.z.object({
|
|
1903
|
+
speaker_type: import_zod3.z.enum(["role", "name"]).describe(
|
|
1904
|
+
"Type of speaker identification. See [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification) for details on each type."
|
|
1905
|
+
),
|
|
1906
|
+
known_values: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
1907
|
+
'Required if speaker_type is "role". Each value must be 35 characters or less.'
|
|
1908
|
+
),
|
|
1909
|
+
speakers: import_zod3.z.array(
|
|
1910
|
+
import_zod3.z.object({
|
|
1911
|
+
role: import_zod3.z.string().optional().describe(
|
|
1912
|
+
'The role of the speaker. Required when `speaker_type` is "role".'
|
|
1913
|
+
),
|
|
1914
|
+
name: import_zod3.z.string().optional().describe(
|
|
1915
|
+
'The name of the speaker. Required when `speaker_type` is "name".'
|
|
1916
|
+
),
|
|
1917
|
+
description: import_zod3.z.string().optional().describe(
|
|
1918
|
+
"A description of the speaker to help the model identify them based on conversational context."
|
|
1919
|
+
)
|
|
1920
|
+
})
|
|
1921
|
+
).optional().describe(
|
|
1922
|
+
"An array of speaker objects with metadata to improve identification accuracy. Each object should include a `role` or `name` (depending on `speaker_type`) and an optional `description` to help the model identify the speaker. You can also include any additional custom properties (e.g., `company`, `title`) to provide more context. Use this as an alternative to `known_values` when you want to provide additional context about each speaker."
|
|
1923
|
+
)
|
|
1924
|
+
})
|
|
1925
|
+
}).describe(
|
|
1926
|
+
"Request body for [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification)."
|
|
2114
1927
|
)
|
|
2115
|
-
).
|
|
2116
|
-
"A summary of the Content Moderation confidence results for the entire audio file"
|
|
2117
|
-
),
|
|
2118
|
-
severity_score_summary: import_zod3.z.record(
|
|
2119
|
-
import_zod3.z.string(),
|
|
1928
|
+
).or(
|
|
2120
1929
|
import_zod3.z.object({
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
1930
|
+
custom_formatting: import_zod3.z.object({
|
|
1931
|
+
date: import_zod3.z.string().optional().describe(
|
|
1932
|
+
'Date format pattern (e.g., `"mm/dd/yyyy"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
1933
|
+
),
|
|
1934
|
+
phone_number: import_zod3.z.string().optional().describe(
|
|
1935
|
+
'Phone number format pattern (e.g., `"(xxx)xxx-xxxx"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
1936
|
+
),
|
|
1937
|
+
email: import_zod3.z.string().optional().describe(
|
|
1938
|
+
'Email format pattern (e.g., `"username@domain.com"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
1939
|
+
)
|
|
1940
|
+
})
|
|
1941
|
+
}).describe(
|
|
1942
|
+
"Request body for [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting)."
|
|
1943
|
+
)
|
|
2127
1944
|
)
|
|
2128
|
-
}).describe(
|
|
2129
|
-
"
|
|
1945
|
+
}).optional().describe(
|
|
1946
|
+
"Enable speech understanding tasks like [Translation](https://www.assemblyai.com/docs/speech-understanding/translation), [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification), and [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting). See the task-specific docs for available options and configuration.\n"
|
|
1947
|
+
),
|
|
1948
|
+
summarization: import_zod3.z.boolean().optional().describe(
|
|
1949
|
+
"Enable [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization), can be true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
1950
|
+
),
|
|
1951
|
+
summary_model: import_zod3.z.enum(["informative", "conversational", "catchy"]).optional().describe("The model to summarize the transcript"),
|
|
1952
|
+
summary_type: import_zod3.z.enum(["bullets", "bullets_verbose", "gist", "headline", "paragraph"]).optional().describe("The type of summary"),
|
|
1953
|
+
remove_audio_tags: import_zod3.z.enum(["all"]).describe(
|
|
1954
|
+
'Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n'
|
|
2130
1955
|
).or(import_zod3.z.null()).optional().describe(
|
|
2131
|
-
|
|
1956
|
+
'Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n'
|
|
2132
1957
|
),
|
|
2133
|
-
|
|
2134
|
-
"
|
|
1958
|
+
temperature: import_zod3.z.number().optional().describe(
|
|
1959
|
+
"Control the amount of randomness injected into the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.\n\nNote: This parameter can only be used with the Universal-3 Pro model.\n"
|
|
2135
1960
|
),
|
|
2136
|
-
|
|
1961
|
+
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
1962
|
+
"The header name to be sent with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests"
|
|
1963
|
+
),
|
|
1964
|
+
webhook_auth_header_value: import_zod3.z.string().nullish().describe(
|
|
1965
|
+
"The header value to send back with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests for added security"
|
|
1966
|
+
),
|
|
1967
|
+
webhook_url: import_zod3.z.string().optional().describe(
|
|
1968
|
+
"The URL to which we send [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests.\n"
|
|
1969
|
+
),
|
|
1970
|
+
custom_topics: import_zod3.z.boolean().optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
1971
|
+
topics: import_zod3.z.array(import_zod3.z.string()).optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
1972
|
+
audio_url: import_zod3.z.string().describe("The URL of the audio or video file to transcribe.")
|
|
1973
|
+
}).describe("The parameters for creating a transcript");
|
|
1974
|
+
var createTranscriptResponseLanguageDetectionOptionsFallbackLanguageDefault = "auto";
|
|
1975
|
+
var createTranscriptResponseLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault = 0.3;
|
|
1976
|
+
var createTranscriptResponseSpeechUnderstandingRequestTranslationFormalDefault = true;
|
|
1977
|
+
var createTranscriptResponse = import_zod3.z.object({
|
|
1978
|
+
audio_channels: import_zod3.z.number().optional().describe(
|
|
1979
|
+
"The number of audio channels in the audio file. This is only present when [multichannel](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) is enabled."
|
|
1980
|
+
),
|
|
1981
|
+
audio_duration: import_zod3.z.number().nullish().describe("The duration of this transcript object's media file, in seconds"),
|
|
1982
|
+
audio_end_at: import_zod3.z.number().nullish().describe(
|
|
1983
|
+
"The point in time, in milliseconds, in the file at which the transcription was terminated. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
1984
|
+
),
|
|
1985
|
+
audio_start_from: import_zod3.z.number().nullish().describe(
|
|
1986
|
+
"The point in time, in milliseconds, in the file at which the transcription was started. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
1987
|
+
),
|
|
1988
|
+
audio_url: import_zod3.z.string().describe("The URL of the media that was transcribed"),
|
|
1989
|
+
auto_chapters: import_zod3.z.boolean().nullish().describe(
|
|
1990
|
+
"Whether [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) is enabled, can be true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible chapter summaries. See the [updated Auto Chapters page](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
1991
|
+
),
|
|
1992
|
+
auto_highlights: import_zod3.z.boolean().describe(
|
|
1993
|
+
"Whether [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) is enabled, either true or false"
|
|
1994
|
+
),
|
|
1995
|
+
auto_highlights_result: import_zod3.z.object({
|
|
2137
1996
|
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2138
1997
|
results: import_zod3.z.array(
|
|
2139
1998
|
import_zod3.z.object({
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
).describe("
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
timestamp: import_zod3.z.object({
|
|
2154
|
-
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2155
|
-
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2156
|
-
}).optional().describe("Timestamp containing a start and end property in milliseconds")
|
|
2157
|
-
}).describe("The result of the topic detection model")
|
|
2158
|
-
).describe("An array of results for the Topic Detection model"),
|
|
2159
|
-
summary: import_zod3.z.record(
|
|
2160
|
-
import_zod3.z.string(),
|
|
2161
|
-
import_zod3.z.number().min(createTranscriptResponseIabCategoriesResultSummaryMinOne).max(createTranscriptResponseIabCategoriesResultSummaryMaxOne)
|
|
2162
|
-
).describe("The overall relevance of topic to the entire audio file")
|
|
1999
|
+
count: import_zod3.z.number().describe("The total number of times the key phrase appears in the audio file"),
|
|
2000
|
+
rank: import_zod3.z.number().describe(
|
|
2001
|
+
"The total relevancy to the overall audio file of this key phrase - a greater number means more relevant"
|
|
2002
|
+
),
|
|
2003
|
+
text: import_zod3.z.string().describe("The text itself of the key phrase"),
|
|
2004
|
+
timestamps: import_zod3.z.array(
|
|
2005
|
+
import_zod3.z.object({
|
|
2006
|
+
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2007
|
+
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2008
|
+
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
2009
|
+
).describe("The timestamp of the of the key phrase")
|
|
2010
|
+
})
|
|
2011
|
+
).describe("A temporally-sequential array of Key Phrases")
|
|
2163
2012
|
}).describe(
|
|
2164
|
-
"
|
|
2013
|
+
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) for more information.\n"
|
|
2165
2014
|
).or(import_zod3.z.null()).optional().describe(
|
|
2166
|
-
"
|
|
2167
|
-
),
|
|
2168
|
-
custom_spelling: import_zod3.z.array(
|
|
2169
|
-
import_zod3.z.object({
|
|
2170
|
-
from: import_zod3.z.array(import_zod3.z.string().describe("Word or phrase to replace")).describe("Words or phrases to replace"),
|
|
2171
|
-
to: import_zod3.z.string().describe("Word to replace with")
|
|
2172
|
-
}).describe(
|
|
2173
|
-
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
2174
|
-
)
|
|
2175
|
-
).nullish().describe("Customize how words are spelled and formatted using to and from values"),
|
|
2176
|
-
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
2177
|
-
"Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase).\n"
|
|
2178
|
-
),
|
|
2179
|
-
prompt: import_zod3.z.string().optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
2180
|
-
auto_chapters: import_zod3.z.boolean().nullish().describe(
|
|
2181
|
-
"Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false"
|
|
2015
|
+
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) for more information.\n"
|
|
2182
2016
|
),
|
|
2183
2017
|
chapters: import_zod3.z.array(
|
|
2184
2018
|
import_zod3.z.object({
|
|
@@ -2190,45 +2024,70 @@ var createTranscriptResponse = import_zod3.z.object({
|
|
|
2190
2024
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter"),
|
|
2191
2025
|
end: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter")
|
|
2192
2026
|
}).describe("Chapter of the audio file")
|
|
2193
|
-
).nullish().describe(
|
|
2194
|
-
|
|
2195
|
-
"Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false"
|
|
2196
|
-
),
|
|
2197
|
-
summary_type: import_zod3.z.string().nullish().describe(
|
|
2198
|
-
"The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled"
|
|
2027
|
+
).nullish().describe(
|
|
2028
|
+
"An array of temporally sequential chapters for the audio file. See [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for more information."
|
|
2199
2029
|
),
|
|
2200
|
-
|
|
2201
|
-
"The
|
|
2030
|
+
confidence: import_zod3.z.number().nullish().describe(
|
|
2031
|
+
"The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
2202
2032
|
),
|
|
2203
|
-
|
|
2204
|
-
"
|
|
2033
|
+
content_safety: import_zod3.z.boolean().nullish().describe(
|
|
2034
|
+
"Whether [Content Moderation](https://www.assemblyai.com/docs/content-moderation) is enabled, can be true or false"
|
|
2205
2035
|
),
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2036
|
+
content_safety_labels: import_zod3.z.object({
|
|
2037
|
+
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2038
|
+
results: import_zod3.z.array(
|
|
2039
|
+
import_zod3.z.object({
|
|
2040
|
+
text: import_zod3.z.string().describe("The transcript of the section flagged by the Content Moderation model"),
|
|
2041
|
+
labels: import_zod3.z.array(
|
|
2042
|
+
import_zod3.z.object({
|
|
2043
|
+
label: import_zod3.z.string().describe("The label of the sensitive topic"),
|
|
2044
|
+
confidence: import_zod3.z.number().describe("The confidence score for the topic being discussed, from 0 to 1"),
|
|
2045
|
+
severity: import_zod3.z.number().describe("How severely the topic is discussed in the section, from 0 to 1")
|
|
2046
|
+
})
|
|
2047
|
+
).describe(
|
|
2048
|
+
"An array of safety labels, one per sensitive topic that was detected in the section"
|
|
2049
|
+
),
|
|
2050
|
+
sentences_idx_start: import_zod3.z.number().describe("The sentence index at which the section begins"),
|
|
2051
|
+
sentences_idx_end: import_zod3.z.number().describe("The sentence index at which the section ends"),
|
|
2052
|
+
timestamp: import_zod3.z.object({
|
|
2053
|
+
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2054
|
+
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2055
|
+
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
2056
|
+
})
|
|
2057
|
+
).describe("An array of results for the Content Moderation model"),
|
|
2058
|
+
summary: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number()).describe(
|
|
2059
|
+
"A summary of the Content Moderation confidence results for the entire audio file"
|
|
2060
|
+
),
|
|
2061
|
+
severity_score_summary: import_zod3.z.record(
|
|
2062
|
+
import_zod3.z.string(),
|
|
2063
|
+
import_zod3.z.object({
|
|
2064
|
+
low: import_zod3.z.number(),
|
|
2065
|
+
medium: import_zod3.z.number(),
|
|
2066
|
+
high: import_zod3.z.number()
|
|
2067
|
+
})
|
|
2068
|
+
).describe(
|
|
2069
|
+
"A summary of the Content Moderation severity results for the entire audio file"
|
|
2070
|
+
)
|
|
2071
|
+
}).describe(
|
|
2072
|
+
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/content-moderation) for more information.\n"
|
|
2073
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
2074
|
+
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/content-moderation) for more information.\n"
|
|
2210
2075
|
),
|
|
2211
|
-
|
|
2076
|
+
custom_spelling: import_zod3.z.array(
|
|
2212
2077
|
import_zod3.z.object({
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
"The confidence score for the detected sentiment of the sentence, from 0 to 1"
|
|
2219
|
-
),
|
|
2220
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
2221
|
-
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
2222
|
-
),
|
|
2223
|
-
speaker: import_zod3.z.string().nullable().describe(
|
|
2224
|
-
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null"
|
|
2225
|
-
)
|
|
2226
|
-
}).describe("The result of the Sentiment Analysis model")
|
|
2078
|
+
from: import_zod3.z.array(import_zod3.z.string()).describe("Words or phrases to replace"),
|
|
2079
|
+
to: import_zod3.z.string().describe("Word to replace with")
|
|
2080
|
+
}).describe(
|
|
2081
|
+
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
2082
|
+
)
|
|
2227
2083
|
).nullish().describe(
|
|
2228
|
-
"
|
|
2084
|
+
"Customize how words are spelled and formatted using to and from values. See [Custom Spelling](https://www.assemblyai.com/docs/pre-recorded-audio/custom-spelling) for more details."
|
|
2229
2085
|
),
|
|
2230
|
-
|
|
2231
|
-
|
|
2086
|
+
disfluencies: import_zod3.z.boolean().nullish().describe(
|
|
2087
|
+
'Transcribe [Filler Words](https://www.assemblyai.com/docs/pre-recorded-audio/filler-words), like "umm", in your media file; can be true or false'
|
|
2088
|
+
),
|
|
2089
|
+
domain: import_zod3.z.string().nullish().describe(
|
|
2090
|
+
'The domain-specific model applied to the transcript. When set to `"medical-v1"`, [Medical Mode](https://www.assemblyai.com/docs/pre-recorded-audio/medical-mode) was used to improve accuracy for medical terminology.\n'
|
|
2232
2091
|
),
|
|
2233
2092
|
entities: import_zod3.z.array(
|
|
2234
2093
|
import_zod3.z.object({
|
|
@@ -2287,106 +2146,49 @@ var createTranscriptResponse = import_zod3.z.object({
|
|
|
2287
2146
|
)
|
|
2288
2147
|
}).describe("A detected entity")
|
|
2289
2148
|
).nullish().describe(
|
|
2290
|
-
"An array of results for the Entity Detection model, if it is enabled.\nSee [Entity detection](https://www.assemblyai.com/docs/
|
|
2291
|
-
),
|
|
2292
|
-
speech_threshold: import_zod3.z.number().min(createTranscriptResponseSpeechThresholdMin).max(createTranscriptResponseSpeechThresholdMax).nullish().describe(
|
|
2293
|
-
"Defaults to null. Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive.\n"
|
|
2149
|
+
"An array of results for the Entity Detection model, if it is enabled.\nSee [Entity detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection) for more information.\n"
|
|
2294
2150
|
),
|
|
2295
|
-
|
|
2296
|
-
"
|
|
2151
|
+
entity_detection: import_zod3.z.boolean().nullish().describe(
|
|
2152
|
+
"Whether [Entity Detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection) is enabled, can be true or false"
|
|
2297
2153
|
),
|
|
2298
2154
|
error: import_zod3.z.string().optional().describe("Error message of why the transcript failed"),
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
)
|
|
2155
|
+
filter_profanity: import_zod3.z.boolean().nullish().describe(
|
|
2156
|
+
"Whether [Profanity Filtering](https://www.assemblyai.com/docs/profanity-filtering) is enabled, either true or false"
|
|
2157
|
+
),
|
|
2158
|
+
format_text: import_zod3.z.boolean().nullish().describe(
|
|
2159
|
+
"Whether [Text Formatting](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false"
|
|
2160
|
+
),
|
|
2161
|
+
iab_categories: import_zod3.z.boolean().nullish().describe(
|
|
2162
|
+
"Whether [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) is enabled, can be true or false"
|
|
2163
|
+
),
|
|
2164
|
+
iab_categories_result: import_zod3.z.object({
|
|
2165
|
+
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2166
|
+
results: import_zod3.z.array(
|
|
2167
|
+
import_zod3.z.object({
|
|
2168
|
+
text: import_zod3.z.string().describe("The text in the transcript in which a detected topic occurs"),
|
|
2169
|
+
labels: import_zod3.z.array(
|
|
2170
|
+
import_zod3.z.object({
|
|
2171
|
+
relevance: import_zod3.z.number().describe("How relevant the detected topic is of a detected topic"),
|
|
2172
|
+
label: import_zod3.z.string().describe(
|
|
2173
|
+
"The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship"
|
|
2174
|
+
)
|
|
2175
|
+
})
|
|
2176
|
+
).optional().describe("An array of detected topics in the text"),
|
|
2177
|
+
timestamp: import_zod3.z.object({
|
|
2178
|
+
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2179
|
+
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2180
|
+
}).optional().describe("Timestamp containing a start and end property in milliseconds")
|
|
2181
|
+
}).describe("The result of the topic detection model")
|
|
2182
|
+
).describe("An array of results for the Topic Detection model"),
|
|
2183
|
+
summary: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number()).describe("The overall relevance of topic to the entire audio file")
|
|
2329
2184
|
}).describe(
|
|
2330
|
-
"
|
|
2185
|
+
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) for more information.\n"
|
|
2186
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
2187
|
+
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) for more information.\n"
|
|
2331
2188
|
),
|
|
2332
|
-
transcripts: import_zod3.z.array(
|
|
2333
|
-
import_zod3.z.object({
|
|
2334
|
-
id: import_zod3.z.string().uuid().describe("The unique identifier for the transcript"),
|
|
2335
|
-
resource_url: import_zod3.z.string().describe("The URL to retrieve the transcript"),
|
|
2336
|
-
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).describe(
|
|
2337
|
-
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
2338
|
-
),
|
|
2339
|
-
created: import_zod3.z.string().regex(listTranscriptsResponseTranscriptsItemCreatedRegExp).describe("The date and time the transcript was created"),
|
|
2340
|
-
completed: import_zod3.z.string().regex(listTranscriptsResponseTranscriptsItemCompletedRegExp).nullable().describe("The date and time the transcript was completed"),
|
|
2341
|
-
audio_url: import_zod3.z.string().describe("The URL to the audio file"),
|
|
2342
|
-
error: import_zod3.z.string().nullable().describe("Error message of why the transcript failed")
|
|
2343
|
-
})
|
|
2344
|
-
).describe("An array of transcripts")
|
|
2345
|
-
}).describe(
|
|
2346
|
-
"A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts."
|
|
2347
|
-
);
|
|
2348
|
-
var getTranscriptParams = import_zod3.z.object({
|
|
2349
|
-
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
2350
|
-
});
|
|
2351
|
-
var getTranscriptResponseLanguageConfidenceThresholdMin = 0;
|
|
2352
|
-
var getTranscriptResponseLanguageConfidenceThresholdMax = 1;
|
|
2353
|
-
var getTranscriptResponseLanguageConfidenceMin = 0;
|
|
2354
|
-
var getTranscriptResponseLanguageConfidenceMax = 1;
|
|
2355
|
-
var getTranscriptResponseWordsItemConfidenceMin = 0;
|
|
2356
|
-
var getTranscriptResponseWordsItemConfidenceMax = 1;
|
|
2357
|
-
var getTranscriptResponseUtterancesItemConfidenceMin = 0;
|
|
2358
|
-
var getTranscriptResponseUtterancesItemConfidenceMax = 1;
|
|
2359
|
-
var getTranscriptResponseUtterancesItemWordsItemConfidenceMin = 0;
|
|
2360
|
-
var getTranscriptResponseUtterancesItemWordsItemConfidenceMax = 1;
|
|
2361
|
-
var getTranscriptResponseConfidenceMin = 0;
|
|
2362
|
-
var getTranscriptResponseConfidenceMax = 1;
|
|
2363
|
-
var getTranscriptResponseAutoHighlightsResultResultsItemRankMin = 0;
|
|
2364
|
-
var getTranscriptResponseAutoHighlightsResultResultsItemRankMax = 1;
|
|
2365
|
-
var getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMin = 0;
|
|
2366
|
-
var getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMax = 1;
|
|
2367
|
-
var getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMin = 0;
|
|
2368
|
-
var getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMax = 1;
|
|
2369
|
-
var getTranscriptResponseContentSafetyLabelsSummaryMinOne = 0;
|
|
2370
|
-
var getTranscriptResponseContentSafetyLabelsSummaryMaxOne = 1;
|
|
2371
|
-
var getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMin = 0;
|
|
2372
|
-
var getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMax = 1;
|
|
2373
|
-
var getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMin = 0;
|
|
2374
|
-
var getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMax = 1;
|
|
2375
|
-
var getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMin = 0;
|
|
2376
|
-
var getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMax = 1;
|
|
2377
|
-
var getTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMin = 0;
|
|
2378
|
-
var getTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMax = 1;
|
|
2379
|
-
var getTranscriptResponseIabCategoriesResultSummaryMinOne = 0;
|
|
2380
|
-
var getTranscriptResponseIabCategoriesResultSummaryMaxOne = 1;
|
|
2381
|
-
var getTranscriptResponseSentimentAnalysisResultsItemConfidenceMin = 0;
|
|
2382
|
-
var getTranscriptResponseSentimentAnalysisResultsItemConfidenceMax = 1;
|
|
2383
|
-
var getTranscriptResponseSpeechThresholdMin = 0;
|
|
2384
|
-
var getTranscriptResponseSpeechThresholdMax = 1;
|
|
2385
|
-
var getTranscriptResponse = import_zod3.z.object({
|
|
2386
2189
|
id: import_zod3.z.string().uuid().describe("The unique identifier of your transcript"),
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
2190
|
+
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
2191
|
+
"Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.\n"
|
|
2390
2192
|
),
|
|
2391
2193
|
language_code: import_zod3.z.enum([
|
|
2392
2194
|
"en",
|
|
@@ -2491,138 +2293,175 @@ var getTranscriptResponse = import_zod3.z.object({
|
|
|
2491
2293
|
"cy",
|
|
2492
2294
|
"yi",
|
|
2493
2295
|
"yo"
|
|
2494
|
-
]).describe(
|
|
2495
|
-
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/
|
|
2496
|
-
).or(import_zod3.z.string()).optional().describe(
|
|
2497
|
-
"The language of your audio file.\nPossible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'.\n"
|
|
2498
|
-
),
|
|
2499
|
-
language_detection: import_zod3.z.boolean().nullish().describe(
|
|
2500
|
-
"Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) is enabled, either true or false"
|
|
2501
|
-
),
|
|
2502
|
-
language_confidence_threshold: import_zod3.z.number().min(getTranscriptResponseLanguageConfidenceThresholdMin).max(getTranscriptResponseLanguageConfidenceThresholdMax).nullable().describe(
|
|
2503
|
-
"The confidence threshold for the automatically detected language.\nAn error will be returned if the language confidence is below this threshold.\n"
|
|
2504
|
-
),
|
|
2505
|
-
language_confidence: import_zod3.z.number().min(getTranscriptResponseLanguageConfidenceMin).max(getTranscriptResponseLanguageConfidenceMax).nullable().describe(
|
|
2506
|
-
"The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
2507
|
-
),
|
|
2508
|
-
speech_model: import_zod3.z.enum(["best", "slam-1", "universal"]).describe("The speech model to use for the transcription.").or(import_zod3.z.null()).describe(
|
|
2509
|
-
"The speech model used for the transcription. When `null`, the default model is used."
|
|
2510
|
-
),
|
|
2511
|
-
text: import_zod3.z.string().nullish().describe("The textual transcript of your media file"),
|
|
2512
|
-
words: import_zod3.z.array(
|
|
2513
|
-
import_zod3.z.object({
|
|
2514
|
-
confidence: import_zod3.z.number().min(getTranscriptResponseWordsItemConfidenceMin).max(getTranscriptResponseWordsItemConfidenceMax).describe("The confidence score for the transcript of this word"),
|
|
2515
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
2516
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
2517
|
-
text: import_zod3.z.string().describe("The text of the word"),
|
|
2518
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
2519
|
-
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
2520
|
-
),
|
|
2521
|
-
speaker: import_zod3.z.string().nullable().describe(
|
|
2522
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null"
|
|
2523
|
-
)
|
|
2524
|
-
})
|
|
2525
|
-
).nullish().describe(
|
|
2526
|
-
"An array of temporally-sequential word objects, one for each word in the transcript.\nSee [Speech recognition](https://www.assemblyai.com/docs/models/speech-recognition) for more information.\n"
|
|
2527
|
-
),
|
|
2528
|
-
utterances: import_zod3.z.array(
|
|
2529
|
-
import_zod3.z.object({
|
|
2530
|
-
confidence: import_zod3.z.number().min(getTranscriptResponseUtterancesItemConfidenceMin).max(getTranscriptResponseUtterancesItemConfidenceMax).describe("The confidence score for the transcript of this utterance"),
|
|
2531
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the utterance in the audio file"),
|
|
2532
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the utterance in the audio file"),
|
|
2533
|
-
text: import_zod3.z.string().describe("The text for this utterance"),
|
|
2534
|
-
words: import_zod3.z.array(
|
|
2535
|
-
import_zod3.z.object({
|
|
2536
|
-
confidence: import_zod3.z.number().min(getTranscriptResponseUtterancesItemWordsItemConfidenceMin).max(getTranscriptResponseUtterancesItemWordsItemConfidenceMax).describe("The confidence score for the transcript of this word"),
|
|
2537
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
2538
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
2539
|
-
text: import_zod3.z.string().describe("The text of the word"),
|
|
2540
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
2541
|
-
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
2542
|
-
),
|
|
2543
|
-
speaker: import_zod3.z.string().nullable().describe(
|
|
2544
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null"
|
|
2545
|
-
)
|
|
2546
|
-
})
|
|
2547
|
-
).describe("The words in the utterance."),
|
|
2548
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
2549
|
-
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
2550
|
-
),
|
|
2551
|
-
speaker: import_zod3.z.string().describe(
|
|
2552
|
-
'The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.'
|
|
2553
|
-
)
|
|
2554
|
-
})
|
|
2555
|
-
).nullish().describe(
|
|
2556
|
-
"When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/speech-to-text/speaker-diarization) and [Multichannel transcription](https://www.assemblyai.com/docs/speech-to-text/speech-recognition#multichannel-transcription) for more information.\n"
|
|
2557
|
-
),
|
|
2558
|
-
confidence: import_zod3.z.number().min(getTranscriptResponseConfidenceMin).max(getTranscriptResponseConfidenceMax).nullish().describe(
|
|
2559
|
-
"The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
2560
|
-
),
|
|
2561
|
-
audio_duration: import_zod3.z.number().nullish().describe("The duration of this transcript object's media file, in seconds"),
|
|
2562
|
-
punctuate: import_zod3.z.boolean().nullish().describe("Whether Automatic Punctuation is enabled, either true or false"),
|
|
2563
|
-
format_text: import_zod3.z.boolean().nullish().describe("Whether Text Formatting is enabled, either true or false"),
|
|
2564
|
-
disfluencies: import_zod3.z.boolean().nullish().describe('Transcribe Filler Words, like "umm", in your media file; can be true or false'),
|
|
2565
|
-
multichannel: import_zod3.z.boolean().nullish().describe(
|
|
2566
|
-
"Whether [Multichannel transcription](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription) was enabled in the transcription request, either true or false"
|
|
2567
|
-
),
|
|
2568
|
-
audio_channels: import_zod3.z.number().optional().describe(
|
|
2569
|
-
"The number of audio channels in the audio file. This is only present when multichannel is enabled."
|
|
2570
|
-
),
|
|
2571
|
-
webhook_url: import_zod3.z.string().nullish().describe(
|
|
2572
|
-
"The URL to which we send webhook requests.\nWe sends two different types of webhook requests.\nOne request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.\n"
|
|
2573
|
-
),
|
|
2574
|
-
webhook_status_code: import_zod3.z.number().nullish().describe(
|
|
2575
|
-
"The status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided"
|
|
2576
|
-
),
|
|
2577
|
-
webhook_auth: import_zod3.z.boolean().describe("Whether webhook authentication details were provided"),
|
|
2578
|
-
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
2579
|
-
"The header name to be sent with the transcript completed or failed webhook requests"
|
|
2580
|
-
),
|
|
2581
|
-
speed_boost: import_zod3.z.boolean().nullish().describe("Whether speed boost is enabled"),
|
|
2582
|
-
auto_highlights: import_zod3.z.boolean().describe("Whether Key Phrases is enabled, either true or false"),
|
|
2583
|
-
auto_highlights_result: import_zod3.z.object({
|
|
2584
|
-
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2585
|
-
results: import_zod3.z.array(
|
|
2586
|
-
import_zod3.z.object({
|
|
2587
|
-
count: import_zod3.z.number().describe("The total number of times the key phrase appears in the audio file"),
|
|
2588
|
-
rank: import_zod3.z.number().min(getTranscriptResponseAutoHighlightsResultResultsItemRankMin).max(getTranscriptResponseAutoHighlightsResultResultsItemRankMax).describe(
|
|
2589
|
-
"The total relevancy to the overall audio file of this key phrase - a greater number means more relevant"
|
|
2590
|
-
),
|
|
2591
|
-
text: import_zod3.z.string().describe("The text itself of the key phrase"),
|
|
2592
|
-
timestamps: import_zod3.z.array(
|
|
2593
|
-
import_zod3.z.object({
|
|
2594
|
-
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2595
|
-
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2596
|
-
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
2597
|
-
).describe("The timestamp of the of the key phrase")
|
|
2598
|
-
})
|
|
2599
|
-
).describe("A temporally-sequential array of Key Phrases")
|
|
2600
|
-
}).describe(
|
|
2601
|
-
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.\n"
|
|
2602
|
-
).or(import_zod3.z.null()).optional().describe(
|
|
2603
|
-
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key Phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.\n"
|
|
2604
|
-
),
|
|
2605
|
-
audio_start_from: import_zod3.z.number().nullish().describe(
|
|
2606
|
-
"The point in time, in milliseconds, in the file at which the transcription was started"
|
|
2607
|
-
),
|
|
2608
|
-
audio_end_at: import_zod3.z.number().nullish().describe(
|
|
2609
|
-
"The point in time, in milliseconds, in the file at which the transcription was terminated"
|
|
2610
|
-
),
|
|
2611
|
-
word_boost: import_zod3.z.array(import_zod3.z.string()).optional().describe("The list of custom vocabulary to boost transcription probability for"),
|
|
2612
|
-
boost_param: import_zod3.z.string().nullish().describe("The word boost parameter value"),
|
|
2613
|
-
filter_profanity: import_zod3.z.boolean().nullish().describe(
|
|
2614
|
-
"Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false"
|
|
2615
|
-
),
|
|
2616
|
-
redact_pii: import_zod3.z.boolean().describe(
|
|
2617
|
-
"Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false"
|
|
2618
|
-
),
|
|
2619
|
-
redact_pii_audio: import_zod3.z.boolean().nullish().describe(
|
|
2620
|
-
"Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.\n"
|
|
2296
|
+
]).optional().describe(
|
|
2297
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
2621
2298
|
),
|
|
2622
|
-
|
|
2623
|
-
|
|
2299
|
+
language_codes: import_zod3.z.array(
|
|
2300
|
+
import_zod3.z.enum([
|
|
2301
|
+
"en",
|
|
2302
|
+
"en_au",
|
|
2303
|
+
"en_uk",
|
|
2304
|
+
"en_us",
|
|
2305
|
+
"es",
|
|
2306
|
+
"fr",
|
|
2307
|
+
"de",
|
|
2308
|
+
"it",
|
|
2309
|
+
"pt",
|
|
2310
|
+
"nl",
|
|
2311
|
+
"af",
|
|
2312
|
+
"sq",
|
|
2313
|
+
"am",
|
|
2314
|
+
"ar",
|
|
2315
|
+
"hy",
|
|
2316
|
+
"as",
|
|
2317
|
+
"az",
|
|
2318
|
+
"ba",
|
|
2319
|
+
"eu",
|
|
2320
|
+
"be",
|
|
2321
|
+
"bn",
|
|
2322
|
+
"bs",
|
|
2323
|
+
"br",
|
|
2324
|
+
"bg",
|
|
2325
|
+
"my",
|
|
2326
|
+
"ca",
|
|
2327
|
+
"zh",
|
|
2328
|
+
"hr",
|
|
2329
|
+
"cs",
|
|
2330
|
+
"da",
|
|
2331
|
+
"et",
|
|
2332
|
+
"fo",
|
|
2333
|
+
"fi",
|
|
2334
|
+
"gl",
|
|
2335
|
+
"ka",
|
|
2336
|
+
"el",
|
|
2337
|
+
"gu",
|
|
2338
|
+
"ht",
|
|
2339
|
+
"ha",
|
|
2340
|
+
"haw",
|
|
2341
|
+
"he",
|
|
2342
|
+
"hi",
|
|
2343
|
+
"hu",
|
|
2344
|
+
"is",
|
|
2345
|
+
"id",
|
|
2346
|
+
"ja",
|
|
2347
|
+
"jw",
|
|
2348
|
+
"kn",
|
|
2349
|
+
"kk",
|
|
2350
|
+
"km",
|
|
2351
|
+
"ko",
|
|
2352
|
+
"lo",
|
|
2353
|
+
"la",
|
|
2354
|
+
"lv",
|
|
2355
|
+
"ln",
|
|
2356
|
+
"lt",
|
|
2357
|
+
"lb",
|
|
2358
|
+
"mk",
|
|
2359
|
+
"mg",
|
|
2360
|
+
"ms",
|
|
2361
|
+
"ml",
|
|
2362
|
+
"mt",
|
|
2363
|
+
"mi",
|
|
2364
|
+
"mr",
|
|
2365
|
+
"mn",
|
|
2366
|
+
"ne",
|
|
2367
|
+
"no",
|
|
2368
|
+
"nn",
|
|
2369
|
+
"oc",
|
|
2370
|
+
"pa",
|
|
2371
|
+
"ps",
|
|
2372
|
+
"fa",
|
|
2373
|
+
"pl",
|
|
2374
|
+
"ro",
|
|
2375
|
+
"ru",
|
|
2376
|
+
"sa",
|
|
2377
|
+
"sr",
|
|
2378
|
+
"sn",
|
|
2379
|
+
"sd",
|
|
2380
|
+
"si",
|
|
2381
|
+
"sk",
|
|
2382
|
+
"sl",
|
|
2383
|
+
"so",
|
|
2384
|
+
"su",
|
|
2385
|
+
"sw",
|
|
2386
|
+
"sv",
|
|
2387
|
+
"tl",
|
|
2388
|
+
"tg",
|
|
2389
|
+
"ta",
|
|
2390
|
+
"tt",
|
|
2391
|
+
"te",
|
|
2392
|
+
"th",
|
|
2393
|
+
"bo",
|
|
2394
|
+
"tr",
|
|
2395
|
+
"tk",
|
|
2396
|
+
"uk",
|
|
2397
|
+
"ur",
|
|
2398
|
+
"uz",
|
|
2399
|
+
"vi",
|
|
2400
|
+
"cy",
|
|
2401
|
+
"yi",
|
|
2402
|
+
"yo"
|
|
2403
|
+
]).describe(
|
|
2404
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
2405
|
+
)
|
|
2406
|
+
).nullish().describe(
|
|
2407
|
+
"The language codes of your audio file. Used for [Code switching](/docs/speech-to-text/pre-recorded-audio/code-switching)\nOne of the values specified must be `en`.\n"
|
|
2408
|
+
),
|
|
2409
|
+
language_confidence: import_zod3.z.number().nullable().describe(
|
|
2410
|
+
"The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence). See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details."
|
|
2411
|
+
),
|
|
2412
|
+
language_confidence_threshold: import_zod3.z.number().nullable().describe(
|
|
2413
|
+
"The confidence threshold for the automatically detected language.\nAn error will be returned if the language confidence is below this threshold.\nSee [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n"
|
|
2414
|
+
),
|
|
2415
|
+
language_detection: import_zod3.z.boolean().nullish().describe(
|
|
2416
|
+
"Whether [Automatic language detection](/docs/pre-recorded-audio/automatic-language-detection) is enabled, either true or false"
|
|
2417
|
+
),
|
|
2418
|
+
language_detection_options: import_zod3.z.object({
|
|
2419
|
+
expected_languages: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
2420
|
+
'List of languages expected in the audio file. Defaults to `["all"]` when unspecified. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.'
|
|
2421
|
+
),
|
|
2422
|
+
fallback_language: import_zod3.z.string().default(createTranscriptResponseLanguageDetectionOptionsFallbackLanguageDefault).describe(
|
|
2423
|
+
'If the detected language of the audio file is not in the list of expected languages, the `fallback_language` is used. Specify `["auto"]` to let our model choose the fallback language from `expected_languages` with the highest confidence score. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n'
|
|
2424
|
+
),
|
|
2425
|
+
code_switching: import_zod3.z.boolean().optional().describe(
|
|
2426
|
+
"Whether [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) should be detected.\n"
|
|
2427
|
+
),
|
|
2428
|
+
code_switching_confidence_threshold: import_zod3.z.number().default(
|
|
2429
|
+
createTranscriptResponseLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault
|
|
2430
|
+
).describe(
|
|
2431
|
+
"The confidence threshold for [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) detection. If the code switching confidence is below this threshold, the transcript will be processed in the language with the highest `language_detection_confidence` score.\n"
|
|
2432
|
+
)
|
|
2433
|
+
}).optional().describe(
|
|
2434
|
+
"Specify options for [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection)."
|
|
2435
|
+
),
|
|
2436
|
+
multichannel: import_zod3.z.boolean().nullish().describe(
|
|
2437
|
+
"Whether [Multichannel transcription](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) was enabled in the transcription request, either true or false"
|
|
2438
|
+
),
|
|
2439
|
+
prompt: import_zod3.z.string().optional().describe(
|
|
2440
|
+
"Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
2441
|
+
),
|
|
2442
|
+
punctuate: import_zod3.z.boolean().nullish().describe(
|
|
2443
|
+
"Whether [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false"
|
|
2444
|
+
),
|
|
2445
|
+
redact_pii: import_zod3.z.boolean().describe(
|
|
2446
|
+
"Whether [PII Redaction](https://www.assemblyai.com/docs/pii-redaction) is enabled, either true or false"
|
|
2447
|
+
),
|
|
2448
|
+
redact_pii_audio: import_zod3.z.boolean().nullish().describe(
|
|
2449
|
+
"Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
2450
|
+
),
|
|
2451
|
+
redact_pii_audio_options: import_zod3.z.object({
|
|
2452
|
+
return_redacted_no_speech_audio: import_zod3.z.boolean().optional().describe(
|
|
2453
|
+
"By default, audio redaction provides redacted audio URLs only when speech is detected. However, if your use-case specifically requires redacted audio files even for silent audio files without any dialogue, you can opt to receive these URLs by setting this parameter to `true`."
|
|
2454
|
+
),
|
|
2455
|
+
override_audio_redaction_method: import_zod3.z.enum(["silence"]).optional().describe(
|
|
2456
|
+
"Specify the method used to redact audio. By default, redacted audio uses a beep sound. Set to `silence` to replace PII with silence instead of a beep."
|
|
2457
|
+
)
|
|
2458
|
+
}).optional().describe(
|
|
2459
|
+
"The options for PII-redacted audio, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
2460
|
+
),
|
|
2461
|
+
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).describe(
|
|
2462
|
+
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details."
|
|
2624
2463
|
).or(import_zod3.z.null()).optional().describe(
|
|
2625
|
-
"The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/
|
|
2464
|
+
"The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
2626
2465
|
),
|
|
2627
2466
|
redact_pii_policies: import_zod3.z.array(
|
|
2628
2467
|
import_zod3.z.enum([
|
|
@@ -2672,146 +2511,13 @@ var getTranscriptResponse = import_zod3.z.object({
|
|
|
2672
2511
|
"zodiac_sign"
|
|
2673
2512
|
]).describe("The type of PII to redact")
|
|
2674
2513
|
).nullish().describe(
|
|
2675
|
-
"The list of PII Redaction policies that were enabled, if PII Redaction is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/
|
|
2514
|
+
"The list of PII Redaction policies that were enabled, if PII Redaction is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more information.\n"
|
|
2676
2515
|
),
|
|
2677
2516
|
redact_pii_sub: import_zod3.z.enum(["entity_name", "hash"]).optional().describe(
|
|
2678
|
-
|
|
2679
|
-
),
|
|
2680
|
-
speaker_labels: import_zod3.z.boolean().nullish().describe(
|
|
2681
|
-
"Whether [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, can be true or false"
|
|
2682
|
-
),
|
|
2683
|
-
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
2684
|
-
"Tell the speaker label model how many speakers it should attempt to identify. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details."
|
|
2685
|
-
),
|
|
2686
|
-
content_safety: import_zod3.z.boolean().nullish().describe(
|
|
2687
|
-
"Whether [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation) is enabled, can be true or false"
|
|
2688
|
-
),
|
|
2689
|
-
content_safety_labels: import_zod3.z.object({
|
|
2690
|
-
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2691
|
-
results: import_zod3.z.array(
|
|
2692
|
-
import_zod3.z.object({
|
|
2693
|
-
text: import_zod3.z.string().describe("The transcript of the section flagged by the Content Moderation model"),
|
|
2694
|
-
labels: import_zod3.z.array(
|
|
2695
|
-
import_zod3.z.object({
|
|
2696
|
-
label: import_zod3.z.string().describe("The label of the sensitive topic"),
|
|
2697
|
-
confidence: import_zod3.z.number().min(
|
|
2698
|
-
getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMin
|
|
2699
|
-
).max(
|
|
2700
|
-
getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMax
|
|
2701
|
-
).describe("The confidence score for the topic being discussed, from 0 to 1"),
|
|
2702
|
-
severity: import_zod3.z.number().min(getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMin).max(getTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMax).describe("How severely the topic is discussed in the section, from 0 to 1")
|
|
2703
|
-
})
|
|
2704
|
-
).describe(
|
|
2705
|
-
"An array of safety labels, one per sensitive topic that was detected in the section"
|
|
2706
|
-
),
|
|
2707
|
-
sentences_idx_start: import_zod3.z.number().describe("The sentence index at which the section begins"),
|
|
2708
|
-
sentences_idx_end: import_zod3.z.number().describe("The sentence index at which the section ends"),
|
|
2709
|
-
timestamp: import_zod3.z.object({
|
|
2710
|
-
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2711
|
-
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2712
|
-
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
2713
|
-
})
|
|
2714
|
-
).describe("An array of results for the Content Moderation model"),
|
|
2715
|
-
summary: import_zod3.z.record(
|
|
2716
|
-
import_zod3.z.string(),
|
|
2717
|
-
import_zod3.z.number().min(getTranscriptResponseContentSafetyLabelsSummaryMinOne).max(getTranscriptResponseContentSafetyLabelsSummaryMaxOne).describe(
|
|
2718
|
-
'A confidence score for the presence of the sensitive topic "topic" across the entire audio file'
|
|
2719
|
-
)
|
|
2720
|
-
).describe(
|
|
2721
|
-
"A summary of the Content Moderation confidence results for the entire audio file"
|
|
2722
|
-
),
|
|
2723
|
-
severity_score_summary: import_zod3.z.record(
|
|
2724
|
-
import_zod3.z.string(),
|
|
2725
|
-
import_zod3.z.object({
|
|
2726
|
-
low: import_zod3.z.number().min(getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMin).max(getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMax),
|
|
2727
|
-
medium: import_zod3.z.number().min(getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMin).max(getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMax),
|
|
2728
|
-
high: import_zod3.z.number().min(getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMin).max(getTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMax)
|
|
2729
|
-
})
|
|
2730
|
-
).describe(
|
|
2731
|
-
"A summary of the Content Moderation severity results for the entire audio file"
|
|
2732
|
-
)
|
|
2733
|
-
}).describe(
|
|
2734
|
-
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information.\n"
|
|
2735
|
-
).or(import_zod3.z.null()).optional().describe(
|
|
2736
|
-
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information.\n"
|
|
2737
|
-
),
|
|
2738
|
-
iab_categories: import_zod3.z.boolean().nullish().describe(
|
|
2739
|
-
"Whether [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) is enabled, can be true or false"
|
|
2740
|
-
),
|
|
2741
|
-
iab_categories_result: import_zod3.z.object({
|
|
2742
|
-
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2743
|
-
results: import_zod3.z.array(
|
|
2744
|
-
import_zod3.z.object({
|
|
2745
|
-
text: import_zod3.z.string().describe("The text in the transcript in which a detected topic occurs"),
|
|
2746
|
-
labels: import_zod3.z.array(
|
|
2747
|
-
import_zod3.z.object({
|
|
2748
|
-
relevance: import_zod3.z.number().min(
|
|
2749
|
-
getTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMin
|
|
2750
|
-
).max(
|
|
2751
|
-
getTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMax
|
|
2752
|
-
).describe("How relevant the detected topic is of a detected topic"),
|
|
2753
|
-
label: import_zod3.z.string().describe(
|
|
2754
|
-
"The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship"
|
|
2755
|
-
)
|
|
2756
|
-
})
|
|
2757
|
-
).optional().describe("An array of detected topics in the text"),
|
|
2758
|
-
timestamp: import_zod3.z.object({
|
|
2759
|
-
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
2760
|
-
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
2761
|
-
}).optional().describe("Timestamp containing a start and end property in milliseconds")
|
|
2762
|
-
}).describe("The result of the topic detection model")
|
|
2763
|
-
).describe("An array of results for the Topic Detection model"),
|
|
2764
|
-
summary: import_zod3.z.record(
|
|
2765
|
-
import_zod3.z.string(),
|
|
2766
|
-
import_zod3.z.number().min(getTranscriptResponseIabCategoriesResultSummaryMinOne).max(getTranscriptResponseIabCategoriesResultSummaryMaxOne)
|
|
2767
|
-
).describe("The overall relevance of topic to the entire audio file")
|
|
2768
|
-
}).describe(
|
|
2769
|
-
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information.\n"
|
|
2770
|
-
).or(import_zod3.z.null()).optional().describe(
|
|
2771
|
-
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information.\n"
|
|
2772
|
-
),
|
|
2773
|
-
custom_spelling: import_zod3.z.array(
|
|
2774
|
-
import_zod3.z.object({
|
|
2775
|
-
from: import_zod3.z.array(import_zod3.z.string().describe("Word or phrase to replace")).describe("Words or phrases to replace"),
|
|
2776
|
-
to: import_zod3.z.string().describe("Word to replace with")
|
|
2777
|
-
}).describe(
|
|
2778
|
-
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
2779
|
-
)
|
|
2780
|
-
).nullish().describe("Customize how words are spelled and formatted using to and from values"),
|
|
2781
|
-
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
2782
|
-
"Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase).\n"
|
|
2783
|
-
),
|
|
2784
|
-
prompt: import_zod3.z.string().optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
2785
|
-
auto_chapters: import_zod3.z.boolean().nullish().describe(
|
|
2786
|
-
"Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false"
|
|
2787
|
-
),
|
|
2788
|
-
chapters: import_zod3.z.array(
|
|
2789
|
-
import_zod3.z.object({
|
|
2790
|
-
gist: import_zod3.z.string().describe(
|
|
2791
|
-
"An ultra-short summary (just a few words) of the content spoken in the chapter"
|
|
2792
|
-
),
|
|
2793
|
-
headline: import_zod3.z.string().describe("A single sentence summary of the content spoken during the chapter"),
|
|
2794
|
-
summary: import_zod3.z.string().describe("A one paragraph summary of the content spoken during the chapter"),
|
|
2795
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter"),
|
|
2796
|
-
end: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter")
|
|
2797
|
-
}).describe("Chapter of the audio file")
|
|
2798
|
-
).nullish().describe("An array of temporally sequential chapters for the audio file"),
|
|
2799
|
-
summarization: import_zod3.z.boolean().describe(
|
|
2800
|
-
"Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false"
|
|
2801
|
-
),
|
|
2802
|
-
summary_type: import_zod3.z.string().nullish().describe(
|
|
2803
|
-
"The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled"
|
|
2804
|
-
),
|
|
2805
|
-
summary_model: import_zod3.z.string().nullish().describe(
|
|
2806
|
-
"The Summarization model used to generate the summary,\nif [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled\n"
|
|
2517
|
+
"The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
2807
2518
|
),
|
|
2808
|
-
summary: import_zod3.z.string().nullish().describe(
|
|
2809
|
-
"The generated summary of the media file, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled"
|
|
2810
|
-
),
|
|
2811
|
-
custom_topics: import_zod3.z.boolean().nullish().describe("Whether custom topics is enabled, either true or false"),
|
|
2812
|
-
topics: import_zod3.z.array(import_zod3.z.string()).optional().describe("The list of custom topics provided if custom topics is enabled"),
|
|
2813
2519
|
sentiment_analysis: import_zod3.z.boolean().nullish().describe(
|
|
2814
|
-
"Whether [Sentiment Analysis](https://www.assemblyai.com/docs/
|
|
2520
|
+
"Whether [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis) is enabled, can be true or false"
|
|
2815
2521
|
),
|
|
2816
2522
|
sentiment_analysis_results: import_zod3.z.array(
|
|
2817
2523
|
import_zod3.z.object({
|
|
@@ -2819,280 +2525,158 @@ var getTranscriptResponse = import_zod3.z.object({
|
|
|
2819
2525
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the sentence"),
|
|
2820
2526
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the sentence"),
|
|
2821
2527
|
sentiment: import_zod3.z.enum(["POSITIVE", "NEUTRAL", "NEGATIVE"]),
|
|
2822
|
-
confidence: import_zod3.z.number().
|
|
2528
|
+
confidence: import_zod3.z.number().describe(
|
|
2823
2529
|
"The confidence score for the detected sentiment of the sentence, from 0 to 1"
|
|
2824
2530
|
),
|
|
2825
2531
|
channel: import_zod3.z.string().nullish().describe(
|
|
2826
2532
|
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
2827
2533
|
),
|
|
2828
2534
|
speaker: import_zod3.z.string().nullable().describe(
|
|
2829
|
-
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/
|
|
2535
|
+
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
2830
2536
|
)
|
|
2831
2537
|
}).describe("The result of the Sentiment Analysis model")
|
|
2832
2538
|
).nullish().describe(
|
|
2833
|
-
"An array of results for the Sentiment Analysis model, if it is enabled.\nSee [Sentiment Analysis](https://www.assemblyai.com/docs/
|
|
2539
|
+
"An array of results for the Sentiment Analysis model, if it is enabled.\nSee [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis) for more information.\n"
|
|
2834
2540
|
),
|
|
2835
|
-
|
|
2836
|
-
"Whether [
|
|
2541
|
+
speaker_labels: import_zod3.z.boolean().nullish().describe(
|
|
2542
|
+
"Whether [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, can be true or false"
|
|
2837
2543
|
),
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
"date_interval",
|
|
2849
|
-
"date_of_birth",
|
|
2850
|
-
"drivers_license",
|
|
2851
|
-
"drug",
|
|
2852
|
-
"duration",
|
|
2853
|
-
"email_address",
|
|
2854
|
-
"event",
|
|
2855
|
-
"filename",
|
|
2856
|
-
"gender_sexuality",
|
|
2857
|
-
"healthcare_number",
|
|
2858
|
-
"injury",
|
|
2859
|
-
"ip_address",
|
|
2860
|
-
"language",
|
|
2861
|
-
"location",
|
|
2862
|
-
"marital_status",
|
|
2863
|
-
"medical_condition",
|
|
2864
|
-
"medical_process",
|
|
2865
|
-
"money_amount",
|
|
2866
|
-
"nationality",
|
|
2867
|
-
"number_sequence",
|
|
2868
|
-
"occupation",
|
|
2869
|
-
"organization",
|
|
2870
|
-
"passport_number",
|
|
2871
|
-
"password",
|
|
2872
|
-
"person_age",
|
|
2873
|
-
"person_name",
|
|
2874
|
-
"phone_number",
|
|
2875
|
-
"physical_attribute",
|
|
2876
|
-
"political_affiliation",
|
|
2877
|
-
"religion",
|
|
2878
|
-
"statistics",
|
|
2879
|
-
"time",
|
|
2880
|
-
"url",
|
|
2881
|
-
"us_social_security_number",
|
|
2882
|
-
"username",
|
|
2883
|
-
"vehicle_id",
|
|
2884
|
-
"zodiac_sign"
|
|
2885
|
-
]).describe("The type of entity for the detected entity"),
|
|
2886
|
-
text: import_zod3.z.string().describe("The text for the detected entity"),
|
|
2887
|
-
start: import_zod3.z.number().describe(
|
|
2888
|
-
"The starting time, in milliseconds, at which the detected entity appears in the audio file"
|
|
2889
|
-
),
|
|
2890
|
-
end: import_zod3.z.number().describe(
|
|
2891
|
-
"The ending time, in milliseconds, for the detected entity in the audio file"
|
|
2892
|
-
)
|
|
2893
|
-
}).describe("A detected entity")
|
|
2544
|
+
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
2545
|
+
"Tell the speaker label model how many speakers it should attempt to identify. See [Set number of speakers expected](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-number-of-speakers-expected) for more details."
|
|
2546
|
+
),
|
|
2547
|
+
speech_model_used: import_zod3.z.string().optional().describe(
|
|
2548
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
2549
|
+
),
|
|
2550
|
+
speech_models: import_zod3.z.array(
|
|
2551
|
+
import_zod3.z.string().describe(
|
|
2552
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
2553
|
+
)
|
|
2894
2554
|
).nullish().describe(
|
|
2895
|
-
"
|
|
2555
|
+
"List multiple speech models in priority order, allowing our system to automatically route your audio to the best available option. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models and routing behavior.\n"
|
|
2896
2556
|
),
|
|
2897
|
-
speech_threshold: import_zod3.z.number().
|
|
2898
|
-
"Defaults to null. Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive.\n"
|
|
2557
|
+
speech_threshold: import_zod3.z.number().nullish().describe(
|
|
2558
|
+
"Defaults to null. Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive. See [Speech Threshold](https://www.assemblyai.com/docs/speech-threshold) for more details.\n"
|
|
2899
2559
|
),
|
|
2900
|
-
|
|
2901
|
-
|
|
2560
|
+
speech_understanding: import_zod3.z.object({
|
|
2561
|
+
request: import_zod3.z.object({
|
|
2562
|
+
translation: import_zod3.z.object({
|
|
2563
|
+
target_languages: import_zod3.z.array(import_zod3.z.string()).describe(
|
|
2564
|
+
'List of target language codes (e.g., `["es", "de"]`). See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for supported languages.'
|
|
2565
|
+
),
|
|
2566
|
+
formal: import_zod3.z.boolean().default(createTranscriptResponseSpeechUnderstandingRequestTranslationFormalDefault).describe(
|
|
2567
|
+
"Use formal language style. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
2568
|
+
),
|
|
2569
|
+
match_original_utterance: import_zod3.z.boolean().optional().describe(
|
|
2570
|
+
"When enabled with Speaker Labels, returns translated text in the utterances array. Each utterance will include a `translated_texts` key containing translations for each target language."
|
|
2571
|
+
)
|
|
2572
|
+
})
|
|
2573
|
+
}).describe(
|
|
2574
|
+
"Request body for [Translation](https://www.assemblyai.com/docs/speech-understanding/translation)."
|
|
2575
|
+
).or(
|
|
2576
|
+
import_zod3.z.object({
|
|
2577
|
+
speaker_identification: import_zod3.z.object({
|
|
2578
|
+
speaker_type: import_zod3.z.enum(["role", "name"]).describe(
|
|
2579
|
+
"Type of speaker identification. See [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification) for details on each type."
|
|
2580
|
+
),
|
|
2581
|
+
known_values: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
2582
|
+
'Required if speaker_type is "role". Each value must be 35 characters or less.'
|
|
2583
|
+
),
|
|
2584
|
+
speakers: import_zod3.z.array(
|
|
2585
|
+
import_zod3.z.object({
|
|
2586
|
+
role: import_zod3.z.string().optional().describe(
|
|
2587
|
+
'The role of the speaker. Required when `speaker_type` is "role".'
|
|
2588
|
+
),
|
|
2589
|
+
name: import_zod3.z.string().optional().describe(
|
|
2590
|
+
'The name of the speaker. Required when `speaker_type` is "name".'
|
|
2591
|
+
),
|
|
2592
|
+
description: import_zod3.z.string().optional().describe(
|
|
2593
|
+
"A description of the speaker to help the model identify them based on conversational context."
|
|
2594
|
+
)
|
|
2595
|
+
})
|
|
2596
|
+
).optional().describe(
|
|
2597
|
+
"An array of speaker objects with metadata to improve identification accuracy. Each object should include a `role` or `name` (depending on `speaker_type`) and an optional `description` to help the model identify the speaker. You can also include any additional custom properties (e.g., `company`, `title`) to provide more context. Use this as an alternative to `known_values` when you want to provide additional context about each speaker."
|
|
2598
|
+
)
|
|
2599
|
+
})
|
|
2600
|
+
}).describe(
|
|
2601
|
+
"Request body for [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification)."
|
|
2602
|
+
)
|
|
2603
|
+
).or(
|
|
2604
|
+
import_zod3.z.object({
|
|
2605
|
+
custom_formatting: import_zod3.z.object({
|
|
2606
|
+
date: import_zod3.z.string().optional().describe(
|
|
2607
|
+
'Date format pattern (e.g., `"mm/dd/yyyy"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
2608
|
+
),
|
|
2609
|
+
phone_number: import_zod3.z.string().optional().describe(
|
|
2610
|
+
'Phone number format pattern (e.g., `"(xxx)xxx-xxxx"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
2611
|
+
),
|
|
2612
|
+
email: import_zod3.z.string().optional().describe(
|
|
2613
|
+
'Email format pattern (e.g., `"username@domain.com"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
2614
|
+
)
|
|
2615
|
+
})
|
|
2616
|
+
}).describe(
|
|
2617
|
+
"Request body for [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting)."
|
|
2618
|
+
)
|
|
2619
|
+
).optional(),
|
|
2620
|
+
response: import_zod3.z.object({
|
|
2621
|
+
translation: import_zod3.z.object({
|
|
2622
|
+
status: import_zod3.z.string().optional()
|
|
2623
|
+
}).optional()
|
|
2624
|
+
}).or(
|
|
2625
|
+
import_zod3.z.object({
|
|
2626
|
+
speaker_identification: import_zod3.z.object({
|
|
2627
|
+
mapping: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional().describe(
|
|
2628
|
+
'A mapping of the original generic speaker labels (e.g., "A", "B") to the identified speaker names or roles.'
|
|
2629
|
+
),
|
|
2630
|
+
status: import_zod3.z.string().optional()
|
|
2631
|
+
}).optional()
|
|
2632
|
+
})
|
|
2633
|
+
).or(
|
|
2634
|
+
import_zod3.z.object({
|
|
2635
|
+
custom_formatting: import_zod3.z.object({
|
|
2636
|
+
mapping: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional(),
|
|
2637
|
+
formatted_text: import_zod3.z.string().optional()
|
|
2638
|
+
}).optional()
|
|
2639
|
+
})
|
|
2640
|
+
).optional()
|
|
2641
|
+
}).optional().describe(
|
|
2642
|
+
"Speech understanding tasks like [Translation](https://www.assemblyai.com/docs/speech-understanding/translation), [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification), and [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting). See the task-specific docs for available options and configuration.\n"
|
|
2902
2643
|
),
|
|
2903
|
-
error: import_zod3.z.string().optional().describe("Error message of why the transcript failed"),
|
|
2904
|
-
language_model: import_zod3.z.string().describe("The language model that was used for the transcript"),
|
|
2905
|
-
acoustic_model: import_zod3.z.string().describe("The acoustic model that was used for the transcript")
|
|
2906
|
-
}).describe("A transcript object");
|
|
2907
|
-
var deleteTranscriptParams = import_zod3.z.object({
|
|
2908
|
-
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
2909
|
-
});
|
|
2910
|
-
var deleteTranscriptResponseLanguageConfidenceThresholdMin = 0;
|
|
2911
|
-
var deleteTranscriptResponseLanguageConfidenceThresholdMax = 1;
|
|
2912
|
-
var deleteTranscriptResponseLanguageConfidenceMin = 0;
|
|
2913
|
-
var deleteTranscriptResponseLanguageConfidenceMax = 1;
|
|
2914
|
-
var deleteTranscriptResponseWordsItemConfidenceMin = 0;
|
|
2915
|
-
var deleteTranscriptResponseWordsItemConfidenceMax = 1;
|
|
2916
|
-
var deleteTranscriptResponseUtterancesItemConfidenceMin = 0;
|
|
2917
|
-
var deleteTranscriptResponseUtterancesItemConfidenceMax = 1;
|
|
2918
|
-
var deleteTranscriptResponseUtterancesItemWordsItemConfidenceMin = 0;
|
|
2919
|
-
var deleteTranscriptResponseUtterancesItemWordsItemConfidenceMax = 1;
|
|
2920
|
-
var deleteTranscriptResponseConfidenceMin = 0;
|
|
2921
|
-
var deleteTranscriptResponseConfidenceMax = 1;
|
|
2922
|
-
var deleteTranscriptResponseAutoHighlightsResultResultsItemRankMin = 0;
|
|
2923
|
-
var deleteTranscriptResponseAutoHighlightsResultResultsItemRankMax = 1;
|
|
2924
|
-
var deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMin = 0;
|
|
2925
|
-
var deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMax = 1;
|
|
2926
|
-
var deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMin = 0;
|
|
2927
|
-
var deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMax = 1;
|
|
2928
|
-
var deleteTranscriptResponseContentSafetyLabelsSummaryMinOne = 0;
|
|
2929
|
-
var deleteTranscriptResponseContentSafetyLabelsSummaryMaxOne = 1;
|
|
2930
|
-
var deleteTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMin = 0;
|
|
2931
|
-
var deleteTranscriptResponseContentSafetyLabelsSeverityScoreSummaryLowMax = 1;
|
|
2932
|
-
var deleteTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMin = 0;
|
|
2933
|
-
var deleteTranscriptResponseContentSafetyLabelsSeverityScoreSummaryMediumMax = 1;
|
|
2934
|
-
var deleteTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMin = 0;
|
|
2935
|
-
var deleteTranscriptResponseContentSafetyLabelsSeverityScoreSummaryHighMax = 1;
|
|
2936
|
-
var deleteTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMin = 0;
|
|
2937
|
-
var deleteTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMax = 1;
|
|
2938
|
-
var deleteTranscriptResponseIabCategoriesResultSummaryMinOne = 0;
|
|
2939
|
-
var deleteTranscriptResponseIabCategoriesResultSummaryMaxOne = 1;
|
|
2940
|
-
var deleteTranscriptResponseSentimentAnalysisResultsItemConfidenceMin = 0;
|
|
2941
|
-
var deleteTranscriptResponseSentimentAnalysisResultsItemConfidenceMax = 1;
|
|
2942
|
-
var deleteTranscriptResponseSpeechThresholdMin = 0;
|
|
2943
|
-
var deleteTranscriptResponseSpeechThresholdMax = 1;
|
|
2944
|
-
var deleteTranscriptResponse = import_zod3.z.object({
|
|
2945
|
-
id: import_zod3.z.string().uuid().describe("The unique identifier of your transcript"),
|
|
2946
|
-
audio_url: import_zod3.z.string().describe("The URL of the media that was transcribed"),
|
|
2947
2644
|
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).describe(
|
|
2948
2645
|
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
2949
2646
|
),
|
|
2950
|
-
|
|
2951
|
-
"
|
|
2952
|
-
"en_au",
|
|
2953
|
-
"en_uk",
|
|
2954
|
-
"en_us",
|
|
2955
|
-
"es",
|
|
2956
|
-
"fr",
|
|
2957
|
-
"de",
|
|
2958
|
-
"it",
|
|
2959
|
-
"pt",
|
|
2960
|
-
"nl",
|
|
2961
|
-
"af",
|
|
2962
|
-
"sq",
|
|
2963
|
-
"am",
|
|
2964
|
-
"ar",
|
|
2965
|
-
"hy",
|
|
2966
|
-
"as",
|
|
2967
|
-
"az",
|
|
2968
|
-
"ba",
|
|
2969
|
-
"eu",
|
|
2970
|
-
"be",
|
|
2971
|
-
"bn",
|
|
2972
|
-
"bs",
|
|
2973
|
-
"br",
|
|
2974
|
-
"bg",
|
|
2975
|
-
"my",
|
|
2976
|
-
"ca",
|
|
2977
|
-
"zh",
|
|
2978
|
-
"hr",
|
|
2979
|
-
"cs",
|
|
2980
|
-
"da",
|
|
2981
|
-
"et",
|
|
2982
|
-
"fo",
|
|
2983
|
-
"fi",
|
|
2984
|
-
"gl",
|
|
2985
|
-
"ka",
|
|
2986
|
-
"el",
|
|
2987
|
-
"gu",
|
|
2988
|
-
"ht",
|
|
2989
|
-
"ha",
|
|
2990
|
-
"haw",
|
|
2991
|
-
"he",
|
|
2992
|
-
"hi",
|
|
2993
|
-
"hu",
|
|
2994
|
-
"is",
|
|
2995
|
-
"id",
|
|
2996
|
-
"ja",
|
|
2997
|
-
"jw",
|
|
2998
|
-
"kn",
|
|
2999
|
-
"kk",
|
|
3000
|
-
"km",
|
|
3001
|
-
"ko",
|
|
3002
|
-
"lo",
|
|
3003
|
-
"la",
|
|
3004
|
-
"lv",
|
|
3005
|
-
"ln",
|
|
3006
|
-
"lt",
|
|
3007
|
-
"lb",
|
|
3008
|
-
"mk",
|
|
3009
|
-
"mg",
|
|
3010
|
-
"ms",
|
|
3011
|
-
"ml",
|
|
3012
|
-
"mt",
|
|
3013
|
-
"mi",
|
|
3014
|
-
"mr",
|
|
3015
|
-
"mn",
|
|
3016
|
-
"ne",
|
|
3017
|
-
"no",
|
|
3018
|
-
"nn",
|
|
3019
|
-
"oc",
|
|
3020
|
-
"pa",
|
|
3021
|
-
"ps",
|
|
3022
|
-
"fa",
|
|
3023
|
-
"pl",
|
|
3024
|
-
"ro",
|
|
3025
|
-
"ru",
|
|
3026
|
-
"sa",
|
|
3027
|
-
"sr",
|
|
3028
|
-
"sn",
|
|
3029
|
-
"sd",
|
|
3030
|
-
"si",
|
|
3031
|
-
"sk",
|
|
3032
|
-
"sl",
|
|
3033
|
-
"so",
|
|
3034
|
-
"su",
|
|
3035
|
-
"sw",
|
|
3036
|
-
"sv",
|
|
3037
|
-
"tl",
|
|
3038
|
-
"tg",
|
|
3039
|
-
"ta",
|
|
3040
|
-
"tt",
|
|
3041
|
-
"te",
|
|
3042
|
-
"th",
|
|
3043
|
-
"bo",
|
|
3044
|
-
"tr",
|
|
3045
|
-
"tk",
|
|
3046
|
-
"uk",
|
|
3047
|
-
"ur",
|
|
3048
|
-
"uz",
|
|
3049
|
-
"vi",
|
|
3050
|
-
"cy",
|
|
3051
|
-
"yi",
|
|
3052
|
-
"yo"
|
|
3053
|
-
]).describe(
|
|
3054
|
-
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'.\n"
|
|
3055
|
-
).or(import_zod3.z.string()).optional().describe(
|
|
3056
|
-
"The language of your audio file.\nPossible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).\nThe default value is 'en_us'.\n"
|
|
2647
|
+
summarization: import_zod3.z.boolean().describe(
|
|
2648
|
+
"Whether [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization) is enabled, either true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
3057
2649
|
),
|
|
3058
|
-
|
|
3059
|
-
"
|
|
2650
|
+
summary: import_zod3.z.string().nullish().describe(
|
|
2651
|
+
"The generated summary of the media file, if [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details."
|
|
2652
|
+
),
|
|
2653
|
+
summary_model: import_zod3.z.string().nullish().describe(
|
|
2654
|
+
"The Summarization model used to generate the summary,\nif [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization#summary-models) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n"
|
|
3060
2655
|
),
|
|
3061
|
-
|
|
3062
|
-
"The
|
|
2656
|
+
summary_type: import_zod3.z.string().nullish().describe(
|
|
2657
|
+
"The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization#summary-types) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details."
|
|
3063
2658
|
),
|
|
3064
|
-
|
|
3065
|
-
"
|
|
2659
|
+
remove_audio_tags: import_zod3.z.enum(["all"]).describe(
|
|
2660
|
+
"Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
2661
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
2662
|
+
"Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
3066
2663
|
),
|
|
3067
|
-
|
|
3068
|
-
"The
|
|
2664
|
+
temperature: import_zod3.z.number().nullish().describe(
|
|
2665
|
+
"The temperature that was used for the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.\n\nNote: This parameter can only be used with the Universal-3 Pro model.\n"
|
|
3069
2666
|
),
|
|
3070
2667
|
text: import_zod3.z.string().nullish().describe("The textual transcript of your media file"),
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
confidence: import_zod3.z.number().min(deleteTranscriptResponseWordsItemConfidenceMin).max(deleteTranscriptResponseWordsItemConfidenceMax).describe("The confidence score for the transcript of this word"),
|
|
3074
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
3075
|
-
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
3076
|
-
text: import_zod3.z.string().describe("The text of the word"),
|
|
3077
|
-
channel: import_zod3.z.string().nullish().describe(
|
|
3078
|
-
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3079
|
-
),
|
|
3080
|
-
speaker: import_zod3.z.string().nullable().describe(
|
|
3081
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null"
|
|
3082
|
-
)
|
|
3083
|
-
})
|
|
3084
|
-
).nullish().describe(
|
|
3085
|
-
"An array of temporally-sequential word objects, one for each word in the transcript.\nSee [Speech recognition](https://www.assemblyai.com/docs/models/speech-recognition) for more information.\n"
|
|
2668
|
+
throttled: import_zod3.z.boolean().nullish().describe(
|
|
2669
|
+
"True while a request is throttled and false when a request is no longer throttled"
|
|
3086
2670
|
),
|
|
3087
2671
|
utterances: import_zod3.z.array(
|
|
3088
2672
|
import_zod3.z.object({
|
|
3089
|
-
confidence: import_zod3.z.number().
|
|
2673
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this utterance"),
|
|
3090
2674
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the utterance in the audio file"),
|
|
3091
2675
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the utterance in the audio file"),
|
|
3092
2676
|
text: import_zod3.z.string().describe("The text for this utterance"),
|
|
3093
2677
|
words: import_zod3.z.array(
|
|
3094
2678
|
import_zod3.z.object({
|
|
3095
|
-
confidence: import_zod3.z.number().
|
|
2679
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
3096
2680
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
3097
2681
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
3098
2682
|
text: import_zod3.z.string().describe("The text of the word"),
|
|
@@ -3100,7 +2684,7 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3100
2684
|
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3101
2685
|
),
|
|
3102
2686
|
speaker: import_zod3.z.string().nullable().describe(
|
|
3103
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/
|
|
2687
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3104
2688
|
)
|
|
3105
2689
|
})
|
|
3106
2690
|
).describe("The words in the utterance."),
|
|
@@ -3109,42 +2693,127 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3109
2693
|
),
|
|
3110
2694
|
speaker: import_zod3.z.string().describe(
|
|
3111
2695
|
'The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.'
|
|
2696
|
+
),
|
|
2697
|
+
translated_texts: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional().describe(
|
|
2698
|
+
'Translations keyed by language code (e.g., `{"es": "Texto traducido", "de": "\xDCbersetzter Text"}`). Only present when `match_original_utterance` is enabled with translation.'
|
|
3112
2699
|
)
|
|
3113
2700
|
})
|
|
3114
2701
|
).nullish().describe(
|
|
3115
|
-
"When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/
|
|
2702
|
+
"When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) and [Multichannel transcription](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) for more information.\n"
|
|
3116
2703
|
),
|
|
3117
|
-
|
|
3118
|
-
"
|
|
2704
|
+
webhook_auth: import_zod3.z.boolean().describe(
|
|
2705
|
+
"Whether [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) authentication details were provided"
|
|
3119
2706
|
),
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
format_text: import_zod3.z.boolean().nullish().describe("Whether Text Formatting is enabled, either true or false"),
|
|
3123
|
-
disfluencies: import_zod3.z.boolean().nullish().describe('Transcribe Filler Words, like "umm", in your media file; can be true or false'),
|
|
3124
|
-
multichannel: import_zod3.z.boolean().nullish().describe(
|
|
3125
|
-
"Whether [Multichannel transcription](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription) was enabled in the transcription request, either true or false"
|
|
2707
|
+
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
2708
|
+
"The header name to be sent with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests"
|
|
3126
2709
|
),
|
|
3127
|
-
|
|
3128
|
-
"The
|
|
2710
|
+
webhook_status_code: import_zod3.z.number().nullish().describe(
|
|
2711
|
+
"The status code we received from your server when delivering the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) request, if a webhook URL was provided"
|
|
3129
2712
|
),
|
|
3130
2713
|
webhook_url: import_zod3.z.string().nullish().describe(
|
|
3131
|
-
"The URL to which we send webhook requests.\
|
|
2714
|
+
"The URL to which we send [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests.\n"
|
|
3132
2715
|
),
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
2716
|
+
words: import_zod3.z.array(
|
|
2717
|
+
import_zod3.z.object({
|
|
2718
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
2719
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
2720
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
2721
|
+
text: import_zod3.z.string().describe("The text of the word"),
|
|
2722
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
2723
|
+
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
2724
|
+
),
|
|
2725
|
+
speaker: import_zod3.z.string().nullable().describe(
|
|
2726
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
2727
|
+
)
|
|
2728
|
+
})
|
|
2729
|
+
).nullish().describe(
|
|
2730
|
+
"An array of temporally-sequential word objects, one for each word in the transcript.\n"
|
|
2731
|
+
),
|
|
2732
|
+
acoustic_model: import_zod3.z.string().describe("This parameter does not currently have any functionality attached to it."),
|
|
2733
|
+
custom_topics: import_zod3.z.boolean().nullish().describe("This parameter does not currently have any functionality attached to it."),
|
|
2734
|
+
language_model: import_zod3.z.string().describe("This parameter does not currently have any functionality attached to it."),
|
|
2735
|
+
speech_model: import_zod3.z.string().describe(
|
|
2736
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
2737
|
+
).or(import_zod3.z.null()).describe(
|
|
2738
|
+
"This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model).\n"
|
|
2739
|
+
),
|
|
2740
|
+
speed_boost: import_zod3.z.boolean().nullish().describe("This parameter does not currently have any functionality attached to it."),
|
|
2741
|
+
topics: import_zod3.z.array(import_zod3.z.string()).optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
2742
|
+
translated_texts: import_zod3.z.object({
|
|
2743
|
+
language_code: import_zod3.z.string().optional().describe("Translated text for this language code")
|
|
2744
|
+
}).optional().describe(
|
|
2745
|
+
"Translated text keyed by language code. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
2746
|
+
)
|
|
2747
|
+
}).describe("A transcript object");
|
|
2748
|
+
var listTranscriptsQueryLimitDefault = 10;
|
|
2749
|
+
var listTranscriptsQueryParams = import_zod3.z.object({
|
|
2750
|
+
limit: import_zod3.z.number().default(listTranscriptsQueryLimitDefault).describe("Maximum amount of transcripts to retrieve"),
|
|
2751
|
+
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).optional().describe("Filter by transcript status"),
|
|
2752
|
+
created_on: import_zod3.z.string().date().optional().describe("Only get transcripts created on this date"),
|
|
2753
|
+
before_id: import_zod3.z.string().uuid().optional().describe("Get transcripts that were created before this transcript ID"),
|
|
2754
|
+
after_id: import_zod3.z.string().uuid().optional().describe("Get transcripts that were created after this transcript ID"),
|
|
2755
|
+
throttled_only: import_zod3.z.boolean().optional().describe("Only get throttled transcripts, overrides the status filter")
|
|
2756
|
+
});
|
|
2757
|
+
var listTranscriptsResponse = import_zod3.z.object({
|
|
2758
|
+
page_details: import_zod3.z.object({
|
|
2759
|
+
limit: import_zod3.z.number().describe("The number of results this page is limited to"),
|
|
2760
|
+
result_count: import_zod3.z.number().describe("The actual number of results in the page"),
|
|
2761
|
+
current_url: import_zod3.z.string().describe("The URL used to retrieve the current page of transcripts"),
|
|
2762
|
+
prev_url: import_zod3.z.string().nullable().describe(
|
|
2763
|
+
"The URL to the next page of transcripts. The previous URL always points to a page with older transcripts."
|
|
2764
|
+
),
|
|
2765
|
+
next_url: import_zod3.z.string().nullable().describe(
|
|
2766
|
+
"The URL to the next page of transcripts. The next URL always points to a page with newer transcripts."
|
|
2767
|
+
)
|
|
2768
|
+
}).describe(
|
|
2769
|
+
"Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts."
|
|
3139
2770
|
),
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
2771
|
+
transcripts: import_zod3.z.array(
|
|
2772
|
+
import_zod3.z.object({
|
|
2773
|
+
id: import_zod3.z.string().uuid().describe("The unique identifier for the transcript"),
|
|
2774
|
+
resource_url: import_zod3.z.string().describe("The URL to retrieve the transcript"),
|
|
2775
|
+
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).describe(
|
|
2776
|
+
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
2777
|
+
),
|
|
2778
|
+
created: import_zod3.z.string().datetime({}).describe("The date and time the transcript was created"),
|
|
2779
|
+
completed: import_zod3.z.string().datetime({}).optional().describe("The date and time the transcript was completed"),
|
|
2780
|
+
audio_url: import_zod3.z.string().describe("The URL to the audio file"),
|
|
2781
|
+
error: import_zod3.z.string().nullable().describe("Error message of why the transcript failed")
|
|
2782
|
+
})
|
|
2783
|
+
).describe("An array of transcripts")
|
|
2784
|
+
}).describe(
|
|
2785
|
+
"A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts."
|
|
2786
|
+
);
|
|
2787
|
+
var getTranscriptParams = import_zod3.z.object({
|
|
2788
|
+
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
2789
|
+
});
|
|
2790
|
+
var getTranscriptResponseLanguageDetectionOptionsFallbackLanguageDefault = "auto";
|
|
2791
|
+
var getTranscriptResponseLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault = 0.3;
|
|
2792
|
+
var getTranscriptResponseSpeechUnderstandingRequestTranslationFormalDefault = true;
|
|
2793
|
+
var getTranscriptResponse = import_zod3.z.object({
|
|
2794
|
+
audio_channels: import_zod3.z.number().optional().describe(
|
|
2795
|
+
"The number of audio channels in the audio file. This is only present when [multichannel](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) is enabled."
|
|
2796
|
+
),
|
|
2797
|
+
audio_duration: import_zod3.z.number().nullish().describe("The duration of this transcript object's media file, in seconds"),
|
|
2798
|
+
audio_end_at: import_zod3.z.number().nullish().describe(
|
|
2799
|
+
"The point in time, in milliseconds, in the file at which the transcription was terminated. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
2800
|
+
),
|
|
2801
|
+
audio_start_from: import_zod3.z.number().nullish().describe(
|
|
2802
|
+
"The point in time, in milliseconds, in the file at which the transcription was started. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
2803
|
+
),
|
|
2804
|
+
audio_url: import_zod3.z.string().describe("The URL of the media that was transcribed"),
|
|
2805
|
+
auto_chapters: import_zod3.z.boolean().nullish().describe(
|
|
2806
|
+
"Whether [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) is enabled, can be true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible chapter summaries. See the [updated Auto Chapters page](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
2807
|
+
),
|
|
2808
|
+
auto_highlights: import_zod3.z.boolean().describe(
|
|
2809
|
+
"Whether [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) is enabled, either true or false"
|
|
2810
|
+
),
|
|
2811
|
+
auto_highlights_result: import_zod3.z.object({
|
|
2812
|
+
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
2813
|
+
results: import_zod3.z.array(
|
|
2814
|
+
import_zod3.z.object({
|
|
2815
|
+
count: import_zod3.z.number().describe("The total number of times the key phrase appears in the audio file"),
|
|
2816
|
+
rank: import_zod3.z.number().describe(
|
|
3148
2817
|
"The total relevancy to the overall audio file of this key phrase - a greater number means more relevant"
|
|
3149
2818
|
),
|
|
3150
2819
|
text: import_zod3.z.string().describe("The text itself of the key phrase"),
|
|
@@ -3157,93 +2826,28 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3157
2826
|
})
|
|
3158
2827
|
).describe("A temporally-sequential array of Key Phrases")
|
|
3159
2828
|
}).describe(
|
|
3160
|
-
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/
|
|
3161
|
-
).or(import_zod3.z.null()).optional().describe(
|
|
3162
|
-
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key Phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.\n"
|
|
3163
|
-
),
|
|
3164
|
-
audio_start_from: import_zod3.z.number().nullish().describe(
|
|
3165
|
-
"The point in time, in milliseconds, in the file at which the transcription was started"
|
|
3166
|
-
),
|
|
3167
|
-
audio_end_at: import_zod3.z.number().nullish().describe(
|
|
3168
|
-
"The point in time, in milliseconds, in the file at which the transcription was terminated"
|
|
3169
|
-
),
|
|
3170
|
-
word_boost: import_zod3.z.array(import_zod3.z.string()).optional().describe("The list of custom vocabulary to boost transcription probability for"),
|
|
3171
|
-
boost_param: import_zod3.z.string().nullish().describe("The word boost parameter value"),
|
|
3172
|
-
filter_profanity: import_zod3.z.boolean().nullish().describe(
|
|
3173
|
-
"Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false"
|
|
3174
|
-
),
|
|
3175
|
-
redact_pii: import_zod3.z.boolean().describe(
|
|
3176
|
-
"Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false"
|
|
3177
|
-
),
|
|
3178
|
-
redact_pii_audio: import_zod3.z.boolean().nullish().describe(
|
|
3179
|
-
"Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.\n"
|
|
3180
|
-
),
|
|
3181
|
-
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).describe(
|
|
3182
|
-
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details."
|
|
2829
|
+
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) for more information.\n"
|
|
3183
2830
|
).or(import_zod3.z.null()).optional().describe(
|
|
3184
|
-
"
|
|
2831
|
+
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) for more information.\n"
|
|
3185
2832
|
),
|
|
3186
|
-
|
|
3187
|
-
import_zod3.z.
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
"
|
|
3192
|
-
"
|
|
3193
|
-
"
|
|
3194
|
-
"
|
|
3195
|
-
|
|
3196
|
-
"date_of_birth",
|
|
3197
|
-
"drivers_license",
|
|
3198
|
-
"drug",
|
|
3199
|
-
"duration",
|
|
3200
|
-
"email_address",
|
|
3201
|
-
"event",
|
|
3202
|
-
"filename",
|
|
3203
|
-
"gender_sexuality",
|
|
3204
|
-
"healthcare_number",
|
|
3205
|
-
"injury",
|
|
3206
|
-
"ip_address",
|
|
3207
|
-
"language",
|
|
3208
|
-
"location",
|
|
3209
|
-
"marital_status",
|
|
3210
|
-
"medical_condition",
|
|
3211
|
-
"medical_process",
|
|
3212
|
-
"money_amount",
|
|
3213
|
-
"nationality",
|
|
3214
|
-
"number_sequence",
|
|
3215
|
-
"occupation",
|
|
3216
|
-
"organization",
|
|
3217
|
-
"passport_number",
|
|
3218
|
-
"password",
|
|
3219
|
-
"person_age",
|
|
3220
|
-
"person_name",
|
|
3221
|
-
"phone_number",
|
|
3222
|
-
"physical_attribute",
|
|
3223
|
-
"political_affiliation",
|
|
3224
|
-
"religion",
|
|
3225
|
-
"statistics",
|
|
3226
|
-
"time",
|
|
3227
|
-
"url",
|
|
3228
|
-
"us_social_security_number",
|
|
3229
|
-
"username",
|
|
3230
|
-
"vehicle_id",
|
|
3231
|
-
"zodiac_sign"
|
|
3232
|
-
]).describe("The type of PII to redact")
|
|
2833
|
+
chapters: import_zod3.z.array(
|
|
2834
|
+
import_zod3.z.object({
|
|
2835
|
+
gist: import_zod3.z.string().describe(
|
|
2836
|
+
"An ultra-short summary (just a few words) of the content spoken in the chapter"
|
|
2837
|
+
),
|
|
2838
|
+
headline: import_zod3.z.string().describe("A single sentence summary of the content spoken during the chapter"),
|
|
2839
|
+
summary: import_zod3.z.string().describe("A one paragraph summary of the content spoken during the chapter"),
|
|
2840
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter"),
|
|
2841
|
+
end: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter")
|
|
2842
|
+
}).describe("Chapter of the audio file")
|
|
3233
2843
|
).nullish().describe(
|
|
3234
|
-
"
|
|
2844
|
+
"An array of temporally sequential chapters for the audio file. See [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for more information."
|
|
3235
2845
|
),
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
),
|
|
3239
|
-
speaker_labels: import_zod3.z.boolean().nullish().describe(
|
|
3240
|
-
"Whether [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, can be true or false"
|
|
3241
|
-
),
|
|
3242
|
-
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
3243
|
-
"Tell the speaker label model how many speakers it should attempt to identify. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details."
|
|
2846
|
+
confidence: import_zod3.z.number().nullish().describe(
|
|
2847
|
+
"The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
3244
2848
|
),
|
|
3245
2849
|
content_safety: import_zod3.z.boolean().nullish().describe(
|
|
3246
|
-
"Whether [Content Moderation](https://www.assemblyai.com/docs/
|
|
2850
|
+
"Whether [Content Moderation](https://www.assemblyai.com/docs/content-moderation) is enabled, can be true or false"
|
|
3247
2851
|
),
|
|
3248
2852
|
content_safety_labels: import_zod3.z.object({
|
|
3249
2853
|
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
@@ -3253,16 +2857,8 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3253
2857
|
labels: import_zod3.z.array(
|
|
3254
2858
|
import_zod3.z.object({
|
|
3255
2859
|
label: import_zod3.z.string().describe("The label of the sensitive topic"),
|
|
3256
|
-
confidence: import_zod3.z.number().
|
|
3257
|
-
|
|
3258
|
-
).max(
|
|
3259
|
-
deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemConfidenceMax
|
|
3260
|
-
).describe("The confidence score for the topic being discussed, from 0 to 1"),
|
|
3261
|
-
severity: import_zod3.z.number().min(
|
|
3262
|
-
deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMin
|
|
3263
|
-
).max(
|
|
3264
|
-
deleteTranscriptResponseContentSafetyLabelsResultsItemLabelsItemSeverityMax
|
|
3265
|
-
).describe("How severely the topic is discussed in the section, from 0 to 1")
|
|
2860
|
+
confidence: import_zod3.z.number().describe("The confidence score for the topic being discussed, from 0 to 1"),
|
|
2861
|
+
severity: import_zod3.z.number().describe("How severely the topic is discussed in the section, from 0 to 1")
|
|
3266
2862
|
})
|
|
3267
2863
|
).describe(
|
|
3268
2864
|
"An array of safety labels, one per sensitive topic that was detected in the section"
|
|
@@ -3275,31 +2871,111 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3275
2871
|
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
3276
2872
|
})
|
|
3277
2873
|
).describe("An array of results for the Content Moderation model"),
|
|
3278
|
-
summary: import_zod3.z.record(
|
|
3279
|
-
import_zod3.z.string(),
|
|
3280
|
-
import_zod3.z.number().min(deleteTranscriptResponseContentSafetyLabelsSummaryMinOne).max(deleteTranscriptResponseContentSafetyLabelsSummaryMaxOne).describe(
|
|
3281
|
-
'A confidence score for the presence of the sensitive topic "topic" across the entire audio file'
|
|
3282
|
-
)
|
|
3283
|
-
).describe(
|
|
2874
|
+
summary: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number()).describe(
|
|
3284
2875
|
"A summary of the Content Moderation confidence results for the entire audio file"
|
|
3285
2876
|
),
|
|
3286
2877
|
severity_score_summary: import_zod3.z.record(
|
|
3287
2878
|
import_zod3.z.string(),
|
|
3288
2879
|
import_zod3.z.object({
|
|
3289
|
-
low: import_zod3.z.number()
|
|
3290
|
-
medium: import_zod3.z.number()
|
|
3291
|
-
high: import_zod3.z.number()
|
|
2880
|
+
low: import_zod3.z.number(),
|
|
2881
|
+
medium: import_zod3.z.number(),
|
|
2882
|
+
high: import_zod3.z.number()
|
|
3292
2883
|
})
|
|
3293
2884
|
).describe(
|
|
3294
2885
|
"A summary of the Content Moderation severity results for the entire audio file"
|
|
3295
2886
|
)
|
|
3296
2887
|
}).describe(
|
|
3297
|
-
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/
|
|
2888
|
+
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/content-moderation) for more information.\n"
|
|
3298
2889
|
).or(import_zod3.z.null()).optional().describe(
|
|
3299
|
-
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/
|
|
2890
|
+
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/content-moderation) for more information.\n"
|
|
2891
|
+
),
|
|
2892
|
+
custom_spelling: import_zod3.z.array(
|
|
2893
|
+
import_zod3.z.object({
|
|
2894
|
+
from: import_zod3.z.array(import_zod3.z.string()).describe("Words or phrases to replace"),
|
|
2895
|
+
to: import_zod3.z.string().describe("Word to replace with")
|
|
2896
|
+
}).describe(
|
|
2897
|
+
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
2898
|
+
)
|
|
2899
|
+
).nullish().describe(
|
|
2900
|
+
"Customize how words are spelled and formatted using to and from values. See [Custom Spelling](https://www.assemblyai.com/docs/pre-recorded-audio/custom-spelling) for more details."
|
|
2901
|
+
),
|
|
2902
|
+
disfluencies: import_zod3.z.boolean().nullish().describe(
|
|
2903
|
+
'Transcribe [Filler Words](https://www.assemblyai.com/docs/pre-recorded-audio/filler-words), like "umm", in your media file; can be true or false'
|
|
2904
|
+
),
|
|
2905
|
+
domain: import_zod3.z.string().nullish().describe(
|
|
2906
|
+
'The domain-specific model applied to the transcript. When set to `"medical-v1"`, [Medical Mode](https://www.assemblyai.com/docs/pre-recorded-audio/medical-mode) was used to improve accuracy for medical terminology.\n'
|
|
2907
|
+
),
|
|
2908
|
+
entities: import_zod3.z.array(
|
|
2909
|
+
import_zod3.z.object({
|
|
2910
|
+
entity_type: import_zod3.z.enum([
|
|
2911
|
+
"account_number",
|
|
2912
|
+
"banking_information",
|
|
2913
|
+
"blood_type",
|
|
2914
|
+
"credit_card_cvv",
|
|
2915
|
+
"credit_card_expiration",
|
|
2916
|
+
"credit_card_number",
|
|
2917
|
+
"date",
|
|
2918
|
+
"date_interval",
|
|
2919
|
+
"date_of_birth",
|
|
2920
|
+
"drivers_license",
|
|
2921
|
+
"drug",
|
|
2922
|
+
"duration",
|
|
2923
|
+
"email_address",
|
|
2924
|
+
"event",
|
|
2925
|
+
"filename",
|
|
2926
|
+
"gender_sexuality",
|
|
2927
|
+
"healthcare_number",
|
|
2928
|
+
"injury",
|
|
2929
|
+
"ip_address",
|
|
2930
|
+
"language",
|
|
2931
|
+
"location",
|
|
2932
|
+
"marital_status",
|
|
2933
|
+
"medical_condition",
|
|
2934
|
+
"medical_process",
|
|
2935
|
+
"money_amount",
|
|
2936
|
+
"nationality",
|
|
2937
|
+
"number_sequence",
|
|
2938
|
+
"occupation",
|
|
2939
|
+
"organization",
|
|
2940
|
+
"passport_number",
|
|
2941
|
+
"password",
|
|
2942
|
+
"person_age",
|
|
2943
|
+
"person_name",
|
|
2944
|
+
"phone_number",
|
|
2945
|
+
"physical_attribute",
|
|
2946
|
+
"political_affiliation",
|
|
2947
|
+
"religion",
|
|
2948
|
+
"statistics",
|
|
2949
|
+
"time",
|
|
2950
|
+
"url",
|
|
2951
|
+
"us_social_security_number",
|
|
2952
|
+
"username",
|
|
2953
|
+
"vehicle_id",
|
|
2954
|
+
"zodiac_sign"
|
|
2955
|
+
]).describe("The type of entity for the detected entity"),
|
|
2956
|
+
text: import_zod3.z.string().describe("The text for the detected entity"),
|
|
2957
|
+
start: import_zod3.z.number().describe(
|
|
2958
|
+
"The starting time, in milliseconds, at which the detected entity appears in the audio file"
|
|
2959
|
+
),
|
|
2960
|
+
end: import_zod3.z.number().describe(
|
|
2961
|
+
"The ending time, in milliseconds, for the detected entity in the audio file"
|
|
2962
|
+
)
|
|
2963
|
+
}).describe("A detected entity")
|
|
2964
|
+
).nullish().describe(
|
|
2965
|
+
"An array of results for the Entity Detection model, if it is enabled.\nSee [Entity detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection) for more information.\n"
|
|
2966
|
+
),
|
|
2967
|
+
entity_detection: import_zod3.z.boolean().nullish().describe(
|
|
2968
|
+
"Whether [Entity Detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection) is enabled, can be true or false"
|
|
2969
|
+
),
|
|
2970
|
+
error: import_zod3.z.string().optional().describe("Error message of why the transcript failed"),
|
|
2971
|
+
filter_profanity: import_zod3.z.boolean().nullish().describe(
|
|
2972
|
+
"Whether [Profanity Filtering](https://www.assemblyai.com/docs/profanity-filtering) is enabled, either true or false"
|
|
2973
|
+
),
|
|
2974
|
+
format_text: import_zod3.z.boolean().nullish().describe(
|
|
2975
|
+
"Whether [Text Formatting](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false"
|
|
3300
2976
|
),
|
|
3301
2977
|
iab_categories: import_zod3.z.boolean().nullish().describe(
|
|
3302
|
-
"Whether [Topic Detection](https://www.assemblyai.com/docs/
|
|
2978
|
+
"Whether [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) is enabled, can be true or false"
|
|
3303
2979
|
),
|
|
3304
2980
|
iab_categories_result: import_zod3.z.object({
|
|
3305
2981
|
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
@@ -3308,11 +2984,7 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3308
2984
|
text: import_zod3.z.string().describe("The text in the transcript in which a detected topic occurs"),
|
|
3309
2985
|
labels: import_zod3.z.array(
|
|
3310
2986
|
import_zod3.z.object({
|
|
3311
|
-
relevance: import_zod3.z.number().
|
|
3312
|
-
deleteTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMin
|
|
3313
|
-
).max(
|
|
3314
|
-
deleteTranscriptResponseIabCategoriesResultResultsItemLabelsItemRelevanceMax
|
|
3315
|
-
).describe("How relevant the detected topic is of a detected topic"),
|
|
2987
|
+
relevance: import_zod3.z.number().describe("How relevant the detected topic is of a detected topic"),
|
|
3316
2988
|
label: import_zod3.z.string().describe(
|
|
3317
2989
|
"The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship"
|
|
3318
2990
|
)
|
|
@@ -3324,57 +2996,1121 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3324
2996
|
}).optional().describe("Timestamp containing a start and end property in milliseconds")
|
|
3325
2997
|
}).describe("The result of the topic detection model")
|
|
3326
2998
|
).describe("An array of results for the Topic Detection model"),
|
|
3327
|
-
summary: import_zod3.z.record(
|
|
3328
|
-
import_zod3.z.string(),
|
|
3329
|
-
import_zod3.z.number().min(deleteTranscriptResponseIabCategoriesResultSummaryMinOne).max(deleteTranscriptResponseIabCategoriesResultSummaryMaxOne)
|
|
3330
|
-
).describe("The overall relevance of topic to the entire audio file")
|
|
2999
|
+
summary: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number()).describe("The overall relevance of topic to the entire audio file")
|
|
3331
3000
|
}).describe(
|
|
3332
|
-
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/
|
|
3001
|
+
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) for more information.\n"
|
|
3333
3002
|
).or(import_zod3.z.null()).optional().describe(
|
|
3334
|
-
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/
|
|
3003
|
+
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) for more information.\n"
|
|
3335
3004
|
),
|
|
3336
|
-
|
|
3337
|
-
import_zod3.z.object({
|
|
3338
|
-
from: import_zod3.z.array(import_zod3.z.string().describe("Word or phrase to replace")).describe("Words or phrases to replace"),
|
|
3339
|
-
to: import_zod3.z.string().describe("Word to replace with")
|
|
3340
|
-
}).describe(
|
|
3341
|
-
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
3342
|
-
)
|
|
3343
|
-
).nullish().describe("Customize how words are spelled and formatted using to and from values"),
|
|
3005
|
+
id: import_zod3.z.string().uuid().describe("The unique identifier of your transcript"),
|
|
3344
3006
|
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
3345
|
-
"Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase).\n"
|
|
3346
|
-
),
|
|
3347
|
-
prompt: import_zod3.z.string().optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
3348
|
-
auto_chapters: import_zod3.z.boolean().nullish().describe(
|
|
3349
|
-
"Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false"
|
|
3350
|
-
),
|
|
3351
|
-
chapters: import_zod3.z.array(
|
|
3352
|
-
import_zod3.z.object({
|
|
3353
|
-
gist: import_zod3.z.string().describe(
|
|
3354
|
-
"An ultra-short summary (just a few words) of the content spoken in the chapter"
|
|
3355
|
-
),
|
|
3356
|
-
headline: import_zod3.z.string().describe("A single sentence summary of the content spoken during the chapter"),
|
|
3357
|
-
summary: import_zod3.z.string().describe("A one paragraph summary of the content spoken during the chapter"),
|
|
3358
|
-
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter"),
|
|
3359
|
-
end: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter")
|
|
3360
|
-
}).describe("Chapter of the audio file")
|
|
3361
|
-
).nullish().describe("An array of temporally sequential chapters for the audio file"),
|
|
3362
|
-
summarization: import_zod3.z.boolean().describe(
|
|
3363
|
-
"Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false"
|
|
3007
|
+
"Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.\n"
|
|
3364
3008
|
),
|
|
3365
|
-
|
|
3366
|
-
"
|
|
3367
|
-
|
|
3368
|
-
|
|
3369
|
-
"
|
|
3009
|
+
language_code: import_zod3.z.enum([
|
|
3010
|
+
"en",
|
|
3011
|
+
"en_au",
|
|
3012
|
+
"en_uk",
|
|
3013
|
+
"en_us",
|
|
3014
|
+
"es",
|
|
3015
|
+
"fr",
|
|
3016
|
+
"de",
|
|
3017
|
+
"it",
|
|
3018
|
+
"pt",
|
|
3019
|
+
"nl",
|
|
3020
|
+
"af",
|
|
3021
|
+
"sq",
|
|
3022
|
+
"am",
|
|
3023
|
+
"ar",
|
|
3024
|
+
"hy",
|
|
3025
|
+
"as",
|
|
3026
|
+
"az",
|
|
3027
|
+
"ba",
|
|
3028
|
+
"eu",
|
|
3029
|
+
"be",
|
|
3030
|
+
"bn",
|
|
3031
|
+
"bs",
|
|
3032
|
+
"br",
|
|
3033
|
+
"bg",
|
|
3034
|
+
"my",
|
|
3035
|
+
"ca",
|
|
3036
|
+
"zh",
|
|
3037
|
+
"hr",
|
|
3038
|
+
"cs",
|
|
3039
|
+
"da",
|
|
3040
|
+
"et",
|
|
3041
|
+
"fo",
|
|
3042
|
+
"fi",
|
|
3043
|
+
"gl",
|
|
3044
|
+
"ka",
|
|
3045
|
+
"el",
|
|
3046
|
+
"gu",
|
|
3047
|
+
"ht",
|
|
3048
|
+
"ha",
|
|
3049
|
+
"haw",
|
|
3050
|
+
"he",
|
|
3051
|
+
"hi",
|
|
3052
|
+
"hu",
|
|
3053
|
+
"is",
|
|
3054
|
+
"id",
|
|
3055
|
+
"ja",
|
|
3056
|
+
"jw",
|
|
3057
|
+
"kn",
|
|
3058
|
+
"kk",
|
|
3059
|
+
"km",
|
|
3060
|
+
"ko",
|
|
3061
|
+
"lo",
|
|
3062
|
+
"la",
|
|
3063
|
+
"lv",
|
|
3064
|
+
"ln",
|
|
3065
|
+
"lt",
|
|
3066
|
+
"lb",
|
|
3067
|
+
"mk",
|
|
3068
|
+
"mg",
|
|
3069
|
+
"ms",
|
|
3070
|
+
"ml",
|
|
3071
|
+
"mt",
|
|
3072
|
+
"mi",
|
|
3073
|
+
"mr",
|
|
3074
|
+
"mn",
|
|
3075
|
+
"ne",
|
|
3076
|
+
"no",
|
|
3077
|
+
"nn",
|
|
3078
|
+
"oc",
|
|
3079
|
+
"pa",
|
|
3080
|
+
"ps",
|
|
3081
|
+
"fa",
|
|
3082
|
+
"pl",
|
|
3083
|
+
"ro",
|
|
3084
|
+
"ru",
|
|
3085
|
+
"sa",
|
|
3086
|
+
"sr",
|
|
3087
|
+
"sn",
|
|
3088
|
+
"sd",
|
|
3089
|
+
"si",
|
|
3090
|
+
"sk",
|
|
3091
|
+
"sl",
|
|
3092
|
+
"so",
|
|
3093
|
+
"su",
|
|
3094
|
+
"sw",
|
|
3095
|
+
"sv",
|
|
3096
|
+
"tl",
|
|
3097
|
+
"tg",
|
|
3098
|
+
"ta",
|
|
3099
|
+
"tt",
|
|
3100
|
+
"te",
|
|
3101
|
+
"th",
|
|
3102
|
+
"bo",
|
|
3103
|
+
"tr",
|
|
3104
|
+
"tk",
|
|
3105
|
+
"uk",
|
|
3106
|
+
"ur",
|
|
3107
|
+
"uz",
|
|
3108
|
+
"vi",
|
|
3109
|
+
"cy",
|
|
3110
|
+
"yi",
|
|
3111
|
+
"yo"
|
|
3112
|
+
]).optional().describe(
|
|
3113
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
3114
|
+
),
|
|
3115
|
+
language_codes: import_zod3.z.array(
|
|
3116
|
+
import_zod3.z.enum([
|
|
3117
|
+
"en",
|
|
3118
|
+
"en_au",
|
|
3119
|
+
"en_uk",
|
|
3120
|
+
"en_us",
|
|
3121
|
+
"es",
|
|
3122
|
+
"fr",
|
|
3123
|
+
"de",
|
|
3124
|
+
"it",
|
|
3125
|
+
"pt",
|
|
3126
|
+
"nl",
|
|
3127
|
+
"af",
|
|
3128
|
+
"sq",
|
|
3129
|
+
"am",
|
|
3130
|
+
"ar",
|
|
3131
|
+
"hy",
|
|
3132
|
+
"as",
|
|
3133
|
+
"az",
|
|
3134
|
+
"ba",
|
|
3135
|
+
"eu",
|
|
3136
|
+
"be",
|
|
3137
|
+
"bn",
|
|
3138
|
+
"bs",
|
|
3139
|
+
"br",
|
|
3140
|
+
"bg",
|
|
3141
|
+
"my",
|
|
3142
|
+
"ca",
|
|
3143
|
+
"zh",
|
|
3144
|
+
"hr",
|
|
3145
|
+
"cs",
|
|
3146
|
+
"da",
|
|
3147
|
+
"et",
|
|
3148
|
+
"fo",
|
|
3149
|
+
"fi",
|
|
3150
|
+
"gl",
|
|
3151
|
+
"ka",
|
|
3152
|
+
"el",
|
|
3153
|
+
"gu",
|
|
3154
|
+
"ht",
|
|
3155
|
+
"ha",
|
|
3156
|
+
"haw",
|
|
3157
|
+
"he",
|
|
3158
|
+
"hi",
|
|
3159
|
+
"hu",
|
|
3160
|
+
"is",
|
|
3161
|
+
"id",
|
|
3162
|
+
"ja",
|
|
3163
|
+
"jw",
|
|
3164
|
+
"kn",
|
|
3165
|
+
"kk",
|
|
3166
|
+
"km",
|
|
3167
|
+
"ko",
|
|
3168
|
+
"lo",
|
|
3169
|
+
"la",
|
|
3170
|
+
"lv",
|
|
3171
|
+
"ln",
|
|
3172
|
+
"lt",
|
|
3173
|
+
"lb",
|
|
3174
|
+
"mk",
|
|
3175
|
+
"mg",
|
|
3176
|
+
"ms",
|
|
3177
|
+
"ml",
|
|
3178
|
+
"mt",
|
|
3179
|
+
"mi",
|
|
3180
|
+
"mr",
|
|
3181
|
+
"mn",
|
|
3182
|
+
"ne",
|
|
3183
|
+
"no",
|
|
3184
|
+
"nn",
|
|
3185
|
+
"oc",
|
|
3186
|
+
"pa",
|
|
3187
|
+
"ps",
|
|
3188
|
+
"fa",
|
|
3189
|
+
"pl",
|
|
3190
|
+
"ro",
|
|
3191
|
+
"ru",
|
|
3192
|
+
"sa",
|
|
3193
|
+
"sr",
|
|
3194
|
+
"sn",
|
|
3195
|
+
"sd",
|
|
3196
|
+
"si",
|
|
3197
|
+
"sk",
|
|
3198
|
+
"sl",
|
|
3199
|
+
"so",
|
|
3200
|
+
"su",
|
|
3201
|
+
"sw",
|
|
3202
|
+
"sv",
|
|
3203
|
+
"tl",
|
|
3204
|
+
"tg",
|
|
3205
|
+
"ta",
|
|
3206
|
+
"tt",
|
|
3207
|
+
"te",
|
|
3208
|
+
"th",
|
|
3209
|
+
"bo",
|
|
3210
|
+
"tr",
|
|
3211
|
+
"tk",
|
|
3212
|
+
"uk",
|
|
3213
|
+
"ur",
|
|
3214
|
+
"uz",
|
|
3215
|
+
"vi",
|
|
3216
|
+
"cy",
|
|
3217
|
+
"yi",
|
|
3218
|
+
"yo"
|
|
3219
|
+
]).describe(
|
|
3220
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
3221
|
+
)
|
|
3222
|
+
).nullish().describe(
|
|
3223
|
+
"The language codes of your audio file. Used for [Code switching](/docs/speech-to-text/pre-recorded-audio/code-switching)\nOne of the values specified must be `en`.\n"
|
|
3224
|
+
),
|
|
3225
|
+
language_confidence: import_zod3.z.number().nullable().describe(
|
|
3226
|
+
"The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence). See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details."
|
|
3227
|
+
),
|
|
3228
|
+
language_confidence_threshold: import_zod3.z.number().nullable().describe(
|
|
3229
|
+
"The confidence threshold for the automatically detected language.\nAn error will be returned if the language confidence is below this threshold.\nSee [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n"
|
|
3230
|
+
),
|
|
3231
|
+
language_detection: import_zod3.z.boolean().nullish().describe(
|
|
3232
|
+
"Whether [Automatic language detection](/docs/pre-recorded-audio/automatic-language-detection) is enabled, either true or false"
|
|
3233
|
+
),
|
|
3234
|
+
language_detection_options: import_zod3.z.object({
|
|
3235
|
+
expected_languages: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
3236
|
+
'List of languages expected in the audio file. Defaults to `["all"]` when unspecified. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.'
|
|
3237
|
+
),
|
|
3238
|
+
fallback_language: import_zod3.z.string().default(getTranscriptResponseLanguageDetectionOptionsFallbackLanguageDefault).describe(
|
|
3239
|
+
'If the detected language of the audio file is not in the list of expected languages, the `fallback_language` is used. Specify `["auto"]` to let our model choose the fallback language from `expected_languages` with the highest confidence score. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n'
|
|
3240
|
+
),
|
|
3241
|
+
code_switching: import_zod3.z.boolean().optional().describe(
|
|
3242
|
+
"Whether [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) should be detected.\n"
|
|
3243
|
+
),
|
|
3244
|
+
code_switching_confidence_threshold: import_zod3.z.number().default(
|
|
3245
|
+
getTranscriptResponseLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault
|
|
3246
|
+
).describe(
|
|
3247
|
+
"The confidence threshold for [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) detection. If the code switching confidence is below this threshold, the transcript will be processed in the language with the highest `language_detection_confidence` score.\n"
|
|
3248
|
+
)
|
|
3249
|
+
}).optional().describe(
|
|
3250
|
+
"Specify options for [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection)."
|
|
3251
|
+
),
|
|
3252
|
+
multichannel: import_zod3.z.boolean().nullish().describe(
|
|
3253
|
+
"Whether [Multichannel transcription](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) was enabled in the transcription request, either true or false"
|
|
3254
|
+
),
|
|
3255
|
+
prompt: import_zod3.z.string().optional().describe(
|
|
3256
|
+
"Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
3257
|
+
),
|
|
3258
|
+
punctuate: import_zod3.z.boolean().nullish().describe(
|
|
3259
|
+
"Whether [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false"
|
|
3260
|
+
),
|
|
3261
|
+
redact_pii: import_zod3.z.boolean().describe(
|
|
3262
|
+
"Whether [PII Redaction](https://www.assemblyai.com/docs/pii-redaction) is enabled, either true or false"
|
|
3263
|
+
),
|
|
3264
|
+
redact_pii_audio: import_zod3.z.boolean().nullish().describe(
|
|
3265
|
+
"Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
3266
|
+
),
|
|
3267
|
+
redact_pii_audio_options: import_zod3.z.object({
|
|
3268
|
+
return_redacted_no_speech_audio: import_zod3.z.boolean().optional().describe(
|
|
3269
|
+
"By default, audio redaction provides redacted audio URLs only when speech is detected. However, if your use-case specifically requires redacted audio files even for silent audio files without any dialogue, you can opt to receive these URLs by setting this parameter to `true`."
|
|
3270
|
+
),
|
|
3271
|
+
override_audio_redaction_method: import_zod3.z.enum(["silence"]).optional().describe(
|
|
3272
|
+
"Specify the method used to redact audio. By default, redacted audio uses a beep sound. Set to `silence` to replace PII with silence instead of a beep."
|
|
3273
|
+
)
|
|
3274
|
+
}).optional().describe(
|
|
3275
|
+
"The options for PII-redacted audio, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
3276
|
+
),
|
|
3277
|
+
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).describe(
|
|
3278
|
+
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details."
|
|
3279
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
3280
|
+
"The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
3281
|
+
),
|
|
3282
|
+
redact_pii_policies: import_zod3.z.array(
|
|
3283
|
+
import_zod3.z.enum([
|
|
3284
|
+
"account_number",
|
|
3285
|
+
"banking_information",
|
|
3286
|
+
"blood_type",
|
|
3287
|
+
"credit_card_cvv",
|
|
3288
|
+
"credit_card_expiration",
|
|
3289
|
+
"credit_card_number",
|
|
3290
|
+
"date",
|
|
3291
|
+
"date_interval",
|
|
3292
|
+
"date_of_birth",
|
|
3293
|
+
"drivers_license",
|
|
3294
|
+
"drug",
|
|
3295
|
+
"duration",
|
|
3296
|
+
"email_address",
|
|
3297
|
+
"event",
|
|
3298
|
+
"filename",
|
|
3299
|
+
"gender_sexuality",
|
|
3300
|
+
"healthcare_number",
|
|
3301
|
+
"injury",
|
|
3302
|
+
"ip_address",
|
|
3303
|
+
"language",
|
|
3304
|
+
"location",
|
|
3305
|
+
"marital_status",
|
|
3306
|
+
"medical_condition",
|
|
3307
|
+
"medical_process",
|
|
3308
|
+
"money_amount",
|
|
3309
|
+
"nationality",
|
|
3310
|
+
"number_sequence",
|
|
3311
|
+
"occupation",
|
|
3312
|
+
"organization",
|
|
3313
|
+
"passport_number",
|
|
3314
|
+
"password",
|
|
3315
|
+
"person_age",
|
|
3316
|
+
"person_name",
|
|
3317
|
+
"phone_number",
|
|
3318
|
+
"physical_attribute",
|
|
3319
|
+
"political_affiliation",
|
|
3320
|
+
"religion",
|
|
3321
|
+
"statistics",
|
|
3322
|
+
"time",
|
|
3323
|
+
"url",
|
|
3324
|
+
"us_social_security_number",
|
|
3325
|
+
"username",
|
|
3326
|
+
"vehicle_id",
|
|
3327
|
+
"zodiac_sign"
|
|
3328
|
+
]).describe("The type of PII to redact")
|
|
3329
|
+
).nullish().describe(
|
|
3330
|
+
"The list of PII Redaction policies that were enabled, if PII Redaction is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more information.\n"
|
|
3331
|
+
),
|
|
3332
|
+
redact_pii_sub: import_zod3.z.enum(["entity_name", "hash"]).optional().describe(
|
|
3333
|
+
"The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
3334
|
+
),
|
|
3335
|
+
sentiment_analysis: import_zod3.z.boolean().nullish().describe(
|
|
3336
|
+
"Whether [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis) is enabled, can be true or false"
|
|
3337
|
+
),
|
|
3338
|
+
sentiment_analysis_results: import_zod3.z.array(
|
|
3339
|
+
import_zod3.z.object({
|
|
3340
|
+
text: import_zod3.z.string().describe("The transcript of the sentence"),
|
|
3341
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the sentence"),
|
|
3342
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the sentence"),
|
|
3343
|
+
sentiment: import_zod3.z.enum(["POSITIVE", "NEUTRAL", "NEGATIVE"]),
|
|
3344
|
+
confidence: import_zod3.z.number().describe(
|
|
3345
|
+
"The confidence score for the detected sentiment of the sentence, from 0 to 1"
|
|
3346
|
+
),
|
|
3347
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
3348
|
+
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3349
|
+
),
|
|
3350
|
+
speaker: import_zod3.z.string().nullable().describe(
|
|
3351
|
+
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3352
|
+
)
|
|
3353
|
+
}).describe("The result of the Sentiment Analysis model")
|
|
3354
|
+
).nullish().describe(
|
|
3355
|
+
"An array of results for the Sentiment Analysis model, if it is enabled.\nSee [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis) for more information.\n"
|
|
3356
|
+
),
|
|
3357
|
+
speaker_labels: import_zod3.z.boolean().nullish().describe(
|
|
3358
|
+
"Whether [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, can be true or false"
|
|
3359
|
+
),
|
|
3360
|
+
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
3361
|
+
"Tell the speaker label model how many speakers it should attempt to identify. See [Set number of speakers expected](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-number-of-speakers-expected) for more details."
|
|
3362
|
+
),
|
|
3363
|
+
speech_model_used: import_zod3.z.string().optional().describe(
|
|
3364
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
3365
|
+
),
|
|
3366
|
+
speech_models: import_zod3.z.array(
|
|
3367
|
+
import_zod3.z.string().describe(
|
|
3368
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
3369
|
+
)
|
|
3370
|
+
).nullish().describe(
|
|
3371
|
+
"List multiple speech models in priority order, allowing our system to automatically route your audio to the best available option. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models and routing behavior.\n"
|
|
3372
|
+
),
|
|
3373
|
+
speech_threshold: import_zod3.z.number().nullish().describe(
|
|
3374
|
+
"Defaults to null. Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive. See [Speech Threshold](https://www.assemblyai.com/docs/speech-threshold) for more details.\n"
|
|
3375
|
+
),
|
|
3376
|
+
speech_understanding: import_zod3.z.object({
|
|
3377
|
+
request: import_zod3.z.object({
|
|
3378
|
+
translation: import_zod3.z.object({
|
|
3379
|
+
target_languages: import_zod3.z.array(import_zod3.z.string()).describe(
|
|
3380
|
+
'List of target language codes (e.g., `["es", "de"]`). See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for supported languages.'
|
|
3381
|
+
),
|
|
3382
|
+
formal: import_zod3.z.boolean().default(getTranscriptResponseSpeechUnderstandingRequestTranslationFormalDefault).describe(
|
|
3383
|
+
"Use formal language style. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
3384
|
+
),
|
|
3385
|
+
match_original_utterance: import_zod3.z.boolean().optional().describe(
|
|
3386
|
+
"When enabled with Speaker Labels, returns translated text in the utterances array. Each utterance will include a `translated_texts` key containing translations for each target language."
|
|
3387
|
+
)
|
|
3388
|
+
})
|
|
3389
|
+
}).describe(
|
|
3390
|
+
"Request body for [Translation](https://www.assemblyai.com/docs/speech-understanding/translation)."
|
|
3391
|
+
).or(
|
|
3392
|
+
import_zod3.z.object({
|
|
3393
|
+
speaker_identification: import_zod3.z.object({
|
|
3394
|
+
speaker_type: import_zod3.z.enum(["role", "name"]).describe(
|
|
3395
|
+
"Type of speaker identification. See [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification) for details on each type."
|
|
3396
|
+
),
|
|
3397
|
+
known_values: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
3398
|
+
'Required if speaker_type is "role". Each value must be 35 characters or less.'
|
|
3399
|
+
),
|
|
3400
|
+
speakers: import_zod3.z.array(
|
|
3401
|
+
import_zod3.z.object({
|
|
3402
|
+
role: import_zod3.z.string().optional().describe(
|
|
3403
|
+
'The role of the speaker. Required when `speaker_type` is "role".'
|
|
3404
|
+
),
|
|
3405
|
+
name: import_zod3.z.string().optional().describe(
|
|
3406
|
+
'The name of the speaker. Required when `speaker_type` is "name".'
|
|
3407
|
+
),
|
|
3408
|
+
description: import_zod3.z.string().optional().describe(
|
|
3409
|
+
"A description of the speaker to help the model identify them based on conversational context."
|
|
3410
|
+
)
|
|
3411
|
+
})
|
|
3412
|
+
).optional().describe(
|
|
3413
|
+
"An array of speaker objects with metadata to improve identification accuracy. Each object should include a `role` or `name` (depending on `speaker_type`) and an optional `description` to help the model identify the speaker. You can also include any additional custom properties (e.g., `company`, `title`) to provide more context. Use this as an alternative to `known_values` when you want to provide additional context about each speaker."
|
|
3414
|
+
)
|
|
3415
|
+
})
|
|
3416
|
+
}).describe(
|
|
3417
|
+
"Request body for [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification)."
|
|
3418
|
+
)
|
|
3419
|
+
).or(
|
|
3420
|
+
import_zod3.z.object({
|
|
3421
|
+
custom_formatting: import_zod3.z.object({
|
|
3422
|
+
date: import_zod3.z.string().optional().describe(
|
|
3423
|
+
'Date format pattern (e.g., `"mm/dd/yyyy"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
3424
|
+
),
|
|
3425
|
+
phone_number: import_zod3.z.string().optional().describe(
|
|
3426
|
+
'Phone number format pattern (e.g., `"(xxx)xxx-xxxx"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
3427
|
+
),
|
|
3428
|
+
email: import_zod3.z.string().optional().describe(
|
|
3429
|
+
'Email format pattern (e.g., `"username@domain.com"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
3430
|
+
)
|
|
3431
|
+
})
|
|
3432
|
+
}).describe(
|
|
3433
|
+
"Request body for [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting)."
|
|
3434
|
+
)
|
|
3435
|
+
).optional(),
|
|
3436
|
+
response: import_zod3.z.object({
|
|
3437
|
+
translation: import_zod3.z.object({
|
|
3438
|
+
status: import_zod3.z.string().optional()
|
|
3439
|
+
}).optional()
|
|
3440
|
+
}).or(
|
|
3441
|
+
import_zod3.z.object({
|
|
3442
|
+
speaker_identification: import_zod3.z.object({
|
|
3443
|
+
mapping: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional().describe(
|
|
3444
|
+
'A mapping of the original generic speaker labels (e.g., "A", "B") to the identified speaker names or roles.'
|
|
3445
|
+
),
|
|
3446
|
+
status: import_zod3.z.string().optional()
|
|
3447
|
+
}).optional()
|
|
3448
|
+
})
|
|
3449
|
+
).or(
|
|
3450
|
+
import_zod3.z.object({
|
|
3451
|
+
custom_formatting: import_zod3.z.object({
|
|
3452
|
+
mapping: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional(),
|
|
3453
|
+
formatted_text: import_zod3.z.string().optional()
|
|
3454
|
+
}).optional()
|
|
3455
|
+
})
|
|
3456
|
+
).optional()
|
|
3457
|
+
}).optional().describe(
|
|
3458
|
+
"Speech understanding tasks like [Translation](https://www.assemblyai.com/docs/speech-understanding/translation), [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification), and [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting). See the task-specific docs for available options and configuration.\n"
|
|
3459
|
+
),
|
|
3460
|
+
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).describe(
|
|
3461
|
+
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
3462
|
+
),
|
|
3463
|
+
summarization: import_zod3.z.boolean().describe(
|
|
3464
|
+
"Whether [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization) is enabled, either true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
3465
|
+
),
|
|
3466
|
+
summary: import_zod3.z.string().nullish().describe(
|
|
3467
|
+
"The generated summary of the media file, if [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details."
|
|
3468
|
+
),
|
|
3469
|
+
summary_model: import_zod3.z.string().nullish().describe(
|
|
3470
|
+
"The Summarization model used to generate the summary,\nif [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization#summary-models) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n"
|
|
3471
|
+
),
|
|
3472
|
+
summary_type: import_zod3.z.string().nullish().describe(
|
|
3473
|
+
"The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization#summary-types) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details."
|
|
3474
|
+
),
|
|
3475
|
+
remove_audio_tags: import_zod3.z.enum(["all"]).describe(
|
|
3476
|
+
"Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
3477
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
3478
|
+
"Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
3479
|
+
),
|
|
3480
|
+
temperature: import_zod3.z.number().nullish().describe(
|
|
3481
|
+
"The temperature that was used for the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.\n\nNote: This parameter can only be used with the Universal-3 Pro model.\n"
|
|
3482
|
+
),
|
|
3483
|
+
text: import_zod3.z.string().nullish().describe("The textual transcript of your media file"),
|
|
3484
|
+
throttled: import_zod3.z.boolean().nullish().describe(
|
|
3485
|
+
"True while a request is throttled and false when a request is no longer throttled"
|
|
3486
|
+
),
|
|
3487
|
+
utterances: import_zod3.z.array(
|
|
3488
|
+
import_zod3.z.object({
|
|
3489
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this utterance"),
|
|
3490
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the utterance in the audio file"),
|
|
3491
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the utterance in the audio file"),
|
|
3492
|
+
text: import_zod3.z.string().describe("The text for this utterance"),
|
|
3493
|
+
words: import_zod3.z.array(
|
|
3494
|
+
import_zod3.z.object({
|
|
3495
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
3496
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
3497
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
3498
|
+
text: import_zod3.z.string().describe("The text of the word"),
|
|
3499
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
3500
|
+
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3501
|
+
),
|
|
3502
|
+
speaker: import_zod3.z.string().nullable().describe(
|
|
3503
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3504
|
+
)
|
|
3505
|
+
})
|
|
3506
|
+
).describe("The words in the utterance."),
|
|
3507
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
3508
|
+
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3509
|
+
),
|
|
3510
|
+
speaker: import_zod3.z.string().describe(
|
|
3511
|
+
'The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.'
|
|
3512
|
+
),
|
|
3513
|
+
translated_texts: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional().describe(
|
|
3514
|
+
'Translations keyed by language code (e.g., `{"es": "Texto traducido", "de": "\xDCbersetzter Text"}`). Only present when `match_original_utterance` is enabled with translation.'
|
|
3515
|
+
)
|
|
3516
|
+
})
|
|
3517
|
+
).nullish().describe(
|
|
3518
|
+
"When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) and [Multichannel transcription](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) for more information.\n"
|
|
3519
|
+
),
|
|
3520
|
+
webhook_auth: import_zod3.z.boolean().describe(
|
|
3521
|
+
"Whether [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) authentication details were provided"
|
|
3522
|
+
),
|
|
3523
|
+
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
3524
|
+
"The header name to be sent with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests"
|
|
3525
|
+
),
|
|
3526
|
+
webhook_status_code: import_zod3.z.number().nullish().describe(
|
|
3527
|
+
"The status code we received from your server when delivering the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) request, if a webhook URL was provided"
|
|
3528
|
+
),
|
|
3529
|
+
webhook_url: import_zod3.z.string().nullish().describe(
|
|
3530
|
+
"The URL to which we send [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests.\n"
|
|
3531
|
+
),
|
|
3532
|
+
words: import_zod3.z.array(
|
|
3533
|
+
import_zod3.z.object({
|
|
3534
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
3535
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
3536
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
3537
|
+
text: import_zod3.z.string().describe("The text of the word"),
|
|
3538
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
3539
|
+
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3540
|
+
),
|
|
3541
|
+
speaker: import_zod3.z.string().nullable().describe(
|
|
3542
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3543
|
+
)
|
|
3544
|
+
})
|
|
3545
|
+
).nullish().describe(
|
|
3546
|
+
"An array of temporally-sequential word objects, one for each word in the transcript.\n"
|
|
3547
|
+
),
|
|
3548
|
+
acoustic_model: import_zod3.z.string().describe("This parameter does not currently have any functionality attached to it."),
|
|
3549
|
+
custom_topics: import_zod3.z.boolean().nullish().describe("This parameter does not currently have any functionality attached to it."),
|
|
3550
|
+
language_model: import_zod3.z.string().describe("This parameter does not currently have any functionality attached to it."),
|
|
3551
|
+
speech_model: import_zod3.z.string().describe(
|
|
3552
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
3553
|
+
).or(import_zod3.z.null()).describe(
|
|
3554
|
+
"This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model).\n"
|
|
3555
|
+
),
|
|
3556
|
+
speed_boost: import_zod3.z.boolean().nullish().describe("This parameter does not currently have any functionality attached to it."),
|
|
3557
|
+
topics: import_zod3.z.array(import_zod3.z.string()).optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
3558
|
+
translated_texts: import_zod3.z.object({
|
|
3559
|
+
language_code: import_zod3.z.string().optional().describe("Translated text for this language code")
|
|
3560
|
+
}).optional().describe(
|
|
3561
|
+
"Translated text keyed by language code. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
3562
|
+
)
|
|
3563
|
+
}).describe("A transcript object");
|
|
3564
|
+
var deleteTranscriptParams = import_zod3.z.object({
|
|
3565
|
+
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
3566
|
+
});
|
|
3567
|
+
var deleteTranscriptResponseLanguageDetectionOptionsFallbackLanguageDefault = "auto";
|
|
3568
|
+
var deleteTranscriptResponseLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault = 0.3;
|
|
3569
|
+
var deleteTranscriptResponseSpeechUnderstandingRequestTranslationFormalDefault = true;
|
|
3570
|
+
var deleteTranscriptResponse = import_zod3.z.object({
|
|
3571
|
+
audio_channels: import_zod3.z.number().optional().describe(
|
|
3572
|
+
"The number of audio channels in the audio file. This is only present when [multichannel](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) is enabled."
|
|
3573
|
+
),
|
|
3574
|
+
audio_duration: import_zod3.z.number().nullish().describe("The duration of this transcript object's media file, in seconds"),
|
|
3575
|
+
audio_end_at: import_zod3.z.number().nullish().describe(
|
|
3576
|
+
"The point in time, in milliseconds, in the file at which the transcription was terminated. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
3577
|
+
),
|
|
3578
|
+
audio_start_from: import_zod3.z.number().nullish().describe(
|
|
3579
|
+
"The point in time, in milliseconds, in the file at which the transcription was started. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details."
|
|
3580
|
+
),
|
|
3581
|
+
audio_url: import_zod3.z.string().describe("The URL of the media that was transcribed"),
|
|
3582
|
+
auto_chapters: import_zod3.z.boolean().nullish().describe(
|
|
3583
|
+
"Whether [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) is enabled, can be true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible chapter summaries. See the [updated Auto Chapters page](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
3584
|
+
),
|
|
3585
|
+
auto_highlights: import_zod3.z.boolean().describe(
|
|
3586
|
+
"Whether [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) is enabled, either true or false"
|
|
3587
|
+
),
|
|
3588
|
+
auto_highlights_result: import_zod3.z.object({
|
|
3589
|
+
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
3590
|
+
results: import_zod3.z.array(
|
|
3591
|
+
import_zod3.z.object({
|
|
3592
|
+
count: import_zod3.z.number().describe("The total number of times the key phrase appears in the audio file"),
|
|
3593
|
+
rank: import_zod3.z.number().describe(
|
|
3594
|
+
"The total relevancy to the overall audio file of this key phrase - a greater number means more relevant"
|
|
3595
|
+
),
|
|
3596
|
+
text: import_zod3.z.string().describe("The text itself of the key phrase"),
|
|
3597
|
+
timestamps: import_zod3.z.array(
|
|
3598
|
+
import_zod3.z.object({
|
|
3599
|
+
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
3600
|
+
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
3601
|
+
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
3602
|
+
).describe("The timestamp of the of the key phrase")
|
|
3603
|
+
})
|
|
3604
|
+
).describe("A temporally-sequential array of Key Phrases")
|
|
3605
|
+
}).describe(
|
|
3606
|
+
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) for more information.\n"
|
|
3607
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
3608
|
+
"An array of results for the Key Phrases model, if it is enabled.\nSee [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases) for more information.\n"
|
|
3609
|
+
),
|
|
3610
|
+
chapters: import_zod3.z.array(
|
|
3611
|
+
import_zod3.z.object({
|
|
3612
|
+
gist: import_zod3.z.string().describe(
|
|
3613
|
+
"An ultra-short summary (just a few words) of the content spoken in the chapter"
|
|
3614
|
+
),
|
|
3615
|
+
headline: import_zod3.z.string().describe("A single sentence summary of the content spoken during the chapter"),
|
|
3616
|
+
summary: import_zod3.z.string().describe("A one paragraph summary of the content spoken during the chapter"),
|
|
3617
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter"),
|
|
3618
|
+
end: import_zod3.z.number().describe("The starting time, in milliseconds, for the chapter")
|
|
3619
|
+
}).describe("Chapter of the audio file")
|
|
3620
|
+
).nullish().describe(
|
|
3621
|
+
"An array of temporally sequential chapters for the audio file. See [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters) for more information."
|
|
3622
|
+
),
|
|
3623
|
+
confidence: import_zod3.z.number().nullish().describe(
|
|
3624
|
+
"The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)"
|
|
3625
|
+
),
|
|
3626
|
+
content_safety: import_zod3.z.boolean().nullish().describe(
|
|
3627
|
+
"Whether [Content Moderation](https://www.assemblyai.com/docs/content-moderation) is enabled, can be true or false"
|
|
3628
|
+
),
|
|
3629
|
+
content_safety_labels: import_zod3.z.object({
|
|
3630
|
+
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
3631
|
+
results: import_zod3.z.array(
|
|
3632
|
+
import_zod3.z.object({
|
|
3633
|
+
text: import_zod3.z.string().describe("The transcript of the section flagged by the Content Moderation model"),
|
|
3634
|
+
labels: import_zod3.z.array(
|
|
3635
|
+
import_zod3.z.object({
|
|
3636
|
+
label: import_zod3.z.string().describe("The label of the sensitive topic"),
|
|
3637
|
+
confidence: import_zod3.z.number().describe("The confidence score for the topic being discussed, from 0 to 1"),
|
|
3638
|
+
severity: import_zod3.z.number().describe("How severely the topic is discussed in the section, from 0 to 1")
|
|
3639
|
+
})
|
|
3640
|
+
).describe(
|
|
3641
|
+
"An array of safety labels, one per sensitive topic that was detected in the section"
|
|
3642
|
+
),
|
|
3643
|
+
sentences_idx_start: import_zod3.z.number().describe("The sentence index at which the section begins"),
|
|
3644
|
+
sentences_idx_end: import_zod3.z.number().describe("The sentence index at which the section ends"),
|
|
3645
|
+
timestamp: import_zod3.z.object({
|
|
3646
|
+
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
3647
|
+
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
3648
|
+
}).describe("Timestamp containing a start and end property in milliseconds")
|
|
3649
|
+
})
|
|
3650
|
+
).describe("An array of results for the Content Moderation model"),
|
|
3651
|
+
summary: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number()).describe(
|
|
3652
|
+
"A summary of the Content Moderation confidence results for the entire audio file"
|
|
3653
|
+
),
|
|
3654
|
+
severity_score_summary: import_zod3.z.record(
|
|
3655
|
+
import_zod3.z.string(),
|
|
3656
|
+
import_zod3.z.object({
|
|
3657
|
+
low: import_zod3.z.number(),
|
|
3658
|
+
medium: import_zod3.z.number(),
|
|
3659
|
+
high: import_zod3.z.number()
|
|
3660
|
+
})
|
|
3661
|
+
).describe(
|
|
3662
|
+
"A summary of the Content Moderation severity results for the entire audio file"
|
|
3663
|
+
)
|
|
3664
|
+
}).describe(
|
|
3665
|
+
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/content-moderation) for more information.\n"
|
|
3666
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
3667
|
+
"An array of results for the Content Moderation model, if it is enabled.\nSee [Content moderation](https://www.assemblyai.com/docs/content-moderation) for more information.\n"
|
|
3668
|
+
),
|
|
3669
|
+
custom_spelling: import_zod3.z.array(
|
|
3670
|
+
import_zod3.z.object({
|
|
3671
|
+
from: import_zod3.z.array(import_zod3.z.string()).describe("Words or phrases to replace"),
|
|
3672
|
+
to: import_zod3.z.string().describe("Word to replace with")
|
|
3673
|
+
}).describe(
|
|
3674
|
+
"Object containing words or phrases to replace, and the word or phrase to replace with"
|
|
3675
|
+
)
|
|
3676
|
+
).nullish().describe(
|
|
3677
|
+
"Customize how words are spelled and formatted using to and from values. See [Custom Spelling](https://www.assemblyai.com/docs/pre-recorded-audio/custom-spelling) for more details."
|
|
3678
|
+
),
|
|
3679
|
+
disfluencies: import_zod3.z.boolean().nullish().describe(
|
|
3680
|
+
'Transcribe [Filler Words](https://www.assemblyai.com/docs/pre-recorded-audio/filler-words), like "umm", in your media file; can be true or false'
|
|
3681
|
+
),
|
|
3682
|
+
domain: import_zod3.z.string().nullish().describe(
|
|
3683
|
+
'The domain-specific model applied to the transcript. When set to `"medical-v1"`, [Medical Mode](https://www.assemblyai.com/docs/pre-recorded-audio/medical-mode) was used to improve accuracy for medical terminology.\n'
|
|
3684
|
+
),
|
|
3685
|
+
entities: import_zod3.z.array(
|
|
3686
|
+
import_zod3.z.object({
|
|
3687
|
+
entity_type: import_zod3.z.enum([
|
|
3688
|
+
"account_number",
|
|
3689
|
+
"banking_information",
|
|
3690
|
+
"blood_type",
|
|
3691
|
+
"credit_card_cvv",
|
|
3692
|
+
"credit_card_expiration",
|
|
3693
|
+
"credit_card_number",
|
|
3694
|
+
"date",
|
|
3695
|
+
"date_interval",
|
|
3696
|
+
"date_of_birth",
|
|
3697
|
+
"drivers_license",
|
|
3698
|
+
"drug",
|
|
3699
|
+
"duration",
|
|
3700
|
+
"email_address",
|
|
3701
|
+
"event",
|
|
3702
|
+
"filename",
|
|
3703
|
+
"gender_sexuality",
|
|
3704
|
+
"healthcare_number",
|
|
3705
|
+
"injury",
|
|
3706
|
+
"ip_address",
|
|
3707
|
+
"language",
|
|
3708
|
+
"location",
|
|
3709
|
+
"marital_status",
|
|
3710
|
+
"medical_condition",
|
|
3711
|
+
"medical_process",
|
|
3712
|
+
"money_amount",
|
|
3713
|
+
"nationality",
|
|
3714
|
+
"number_sequence",
|
|
3715
|
+
"occupation",
|
|
3716
|
+
"organization",
|
|
3717
|
+
"passport_number",
|
|
3718
|
+
"password",
|
|
3719
|
+
"person_age",
|
|
3720
|
+
"person_name",
|
|
3721
|
+
"phone_number",
|
|
3722
|
+
"physical_attribute",
|
|
3723
|
+
"political_affiliation",
|
|
3724
|
+
"religion",
|
|
3725
|
+
"statistics",
|
|
3726
|
+
"time",
|
|
3727
|
+
"url",
|
|
3728
|
+
"us_social_security_number",
|
|
3729
|
+
"username",
|
|
3730
|
+
"vehicle_id",
|
|
3731
|
+
"zodiac_sign"
|
|
3732
|
+
]).describe("The type of entity for the detected entity"),
|
|
3733
|
+
text: import_zod3.z.string().describe("The text for the detected entity"),
|
|
3734
|
+
start: import_zod3.z.number().describe(
|
|
3735
|
+
"The starting time, in milliseconds, at which the detected entity appears in the audio file"
|
|
3736
|
+
),
|
|
3737
|
+
end: import_zod3.z.number().describe(
|
|
3738
|
+
"The ending time, in milliseconds, for the detected entity in the audio file"
|
|
3739
|
+
)
|
|
3740
|
+
}).describe("A detected entity")
|
|
3741
|
+
).nullish().describe(
|
|
3742
|
+
"An array of results for the Entity Detection model, if it is enabled.\nSee [Entity detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection) for more information.\n"
|
|
3743
|
+
),
|
|
3744
|
+
entity_detection: import_zod3.z.boolean().nullish().describe(
|
|
3745
|
+
"Whether [Entity Detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection) is enabled, can be true or false"
|
|
3746
|
+
),
|
|
3747
|
+
error: import_zod3.z.string().optional().describe("Error message of why the transcript failed"),
|
|
3748
|
+
filter_profanity: import_zod3.z.boolean().nullish().describe(
|
|
3749
|
+
"Whether [Profanity Filtering](https://www.assemblyai.com/docs/profanity-filtering) is enabled, either true or false"
|
|
3750
|
+
),
|
|
3751
|
+
format_text: import_zod3.z.boolean().nullish().describe(
|
|
3752
|
+
"Whether [Text Formatting](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false"
|
|
3753
|
+
),
|
|
3754
|
+
iab_categories: import_zod3.z.boolean().nullish().describe(
|
|
3755
|
+
"Whether [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) is enabled, can be true or false"
|
|
3756
|
+
),
|
|
3757
|
+
iab_categories_result: import_zod3.z.object({
|
|
3758
|
+
status: import_zod3.z.enum(["success", "unavailable"]).describe("Either success, or unavailable in the rare case that the model failed"),
|
|
3759
|
+
results: import_zod3.z.array(
|
|
3760
|
+
import_zod3.z.object({
|
|
3761
|
+
text: import_zod3.z.string().describe("The text in the transcript in which a detected topic occurs"),
|
|
3762
|
+
labels: import_zod3.z.array(
|
|
3763
|
+
import_zod3.z.object({
|
|
3764
|
+
relevance: import_zod3.z.number().describe("How relevant the detected topic is of a detected topic"),
|
|
3765
|
+
label: import_zod3.z.string().describe(
|
|
3766
|
+
"The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship"
|
|
3767
|
+
)
|
|
3768
|
+
})
|
|
3769
|
+
).optional().describe("An array of detected topics in the text"),
|
|
3770
|
+
timestamp: import_zod3.z.object({
|
|
3771
|
+
start: import_zod3.z.number().describe("The start time in milliseconds"),
|
|
3772
|
+
end: import_zod3.z.number().describe("The end time in milliseconds")
|
|
3773
|
+
}).optional().describe("Timestamp containing a start and end property in milliseconds")
|
|
3774
|
+
}).describe("The result of the topic detection model")
|
|
3775
|
+
).describe("An array of results for the Topic Detection model"),
|
|
3776
|
+
summary: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.number()).describe("The overall relevance of topic to the entire audio file")
|
|
3777
|
+
}).describe(
|
|
3778
|
+
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) for more information.\n"
|
|
3779
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
3780
|
+
"The result of the Topic Detection model, if it is enabled.\nSee [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection) for more information.\n"
|
|
3781
|
+
),
|
|
3782
|
+
id: import_zod3.z.string().uuid().describe("The unique identifier of your transcript"),
|
|
3783
|
+
keyterms_prompt: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
3784
|
+
"Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.\n"
|
|
3785
|
+
),
|
|
3786
|
+
language_code: import_zod3.z.enum([
|
|
3787
|
+
"en",
|
|
3788
|
+
"en_au",
|
|
3789
|
+
"en_uk",
|
|
3790
|
+
"en_us",
|
|
3791
|
+
"es",
|
|
3792
|
+
"fr",
|
|
3793
|
+
"de",
|
|
3794
|
+
"it",
|
|
3795
|
+
"pt",
|
|
3796
|
+
"nl",
|
|
3797
|
+
"af",
|
|
3798
|
+
"sq",
|
|
3799
|
+
"am",
|
|
3800
|
+
"ar",
|
|
3801
|
+
"hy",
|
|
3802
|
+
"as",
|
|
3803
|
+
"az",
|
|
3804
|
+
"ba",
|
|
3805
|
+
"eu",
|
|
3806
|
+
"be",
|
|
3807
|
+
"bn",
|
|
3808
|
+
"bs",
|
|
3809
|
+
"br",
|
|
3810
|
+
"bg",
|
|
3811
|
+
"my",
|
|
3812
|
+
"ca",
|
|
3813
|
+
"zh",
|
|
3814
|
+
"hr",
|
|
3815
|
+
"cs",
|
|
3816
|
+
"da",
|
|
3817
|
+
"et",
|
|
3818
|
+
"fo",
|
|
3819
|
+
"fi",
|
|
3820
|
+
"gl",
|
|
3821
|
+
"ka",
|
|
3822
|
+
"el",
|
|
3823
|
+
"gu",
|
|
3824
|
+
"ht",
|
|
3825
|
+
"ha",
|
|
3826
|
+
"haw",
|
|
3827
|
+
"he",
|
|
3828
|
+
"hi",
|
|
3829
|
+
"hu",
|
|
3830
|
+
"is",
|
|
3831
|
+
"id",
|
|
3832
|
+
"ja",
|
|
3833
|
+
"jw",
|
|
3834
|
+
"kn",
|
|
3835
|
+
"kk",
|
|
3836
|
+
"km",
|
|
3837
|
+
"ko",
|
|
3838
|
+
"lo",
|
|
3839
|
+
"la",
|
|
3840
|
+
"lv",
|
|
3841
|
+
"ln",
|
|
3842
|
+
"lt",
|
|
3843
|
+
"lb",
|
|
3844
|
+
"mk",
|
|
3845
|
+
"mg",
|
|
3846
|
+
"ms",
|
|
3847
|
+
"ml",
|
|
3848
|
+
"mt",
|
|
3849
|
+
"mi",
|
|
3850
|
+
"mr",
|
|
3851
|
+
"mn",
|
|
3852
|
+
"ne",
|
|
3853
|
+
"no",
|
|
3854
|
+
"nn",
|
|
3855
|
+
"oc",
|
|
3856
|
+
"pa",
|
|
3857
|
+
"ps",
|
|
3858
|
+
"fa",
|
|
3859
|
+
"pl",
|
|
3860
|
+
"ro",
|
|
3861
|
+
"ru",
|
|
3862
|
+
"sa",
|
|
3863
|
+
"sr",
|
|
3864
|
+
"sn",
|
|
3865
|
+
"sd",
|
|
3866
|
+
"si",
|
|
3867
|
+
"sk",
|
|
3868
|
+
"sl",
|
|
3869
|
+
"so",
|
|
3870
|
+
"su",
|
|
3871
|
+
"sw",
|
|
3872
|
+
"sv",
|
|
3873
|
+
"tl",
|
|
3874
|
+
"tg",
|
|
3875
|
+
"ta",
|
|
3876
|
+
"tt",
|
|
3877
|
+
"te",
|
|
3878
|
+
"th",
|
|
3879
|
+
"bo",
|
|
3880
|
+
"tr",
|
|
3881
|
+
"tk",
|
|
3882
|
+
"uk",
|
|
3883
|
+
"ur",
|
|
3884
|
+
"uz",
|
|
3885
|
+
"vi",
|
|
3886
|
+
"cy",
|
|
3887
|
+
"yi",
|
|
3888
|
+
"yo"
|
|
3889
|
+
]).optional().describe(
|
|
3890
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
3891
|
+
),
|
|
3892
|
+
language_codes: import_zod3.z.array(
|
|
3893
|
+
import_zod3.z.enum([
|
|
3894
|
+
"en",
|
|
3895
|
+
"en_au",
|
|
3896
|
+
"en_uk",
|
|
3897
|
+
"en_us",
|
|
3898
|
+
"es",
|
|
3899
|
+
"fr",
|
|
3900
|
+
"de",
|
|
3901
|
+
"it",
|
|
3902
|
+
"pt",
|
|
3903
|
+
"nl",
|
|
3904
|
+
"af",
|
|
3905
|
+
"sq",
|
|
3906
|
+
"am",
|
|
3907
|
+
"ar",
|
|
3908
|
+
"hy",
|
|
3909
|
+
"as",
|
|
3910
|
+
"az",
|
|
3911
|
+
"ba",
|
|
3912
|
+
"eu",
|
|
3913
|
+
"be",
|
|
3914
|
+
"bn",
|
|
3915
|
+
"bs",
|
|
3916
|
+
"br",
|
|
3917
|
+
"bg",
|
|
3918
|
+
"my",
|
|
3919
|
+
"ca",
|
|
3920
|
+
"zh",
|
|
3921
|
+
"hr",
|
|
3922
|
+
"cs",
|
|
3923
|
+
"da",
|
|
3924
|
+
"et",
|
|
3925
|
+
"fo",
|
|
3926
|
+
"fi",
|
|
3927
|
+
"gl",
|
|
3928
|
+
"ka",
|
|
3929
|
+
"el",
|
|
3930
|
+
"gu",
|
|
3931
|
+
"ht",
|
|
3932
|
+
"ha",
|
|
3933
|
+
"haw",
|
|
3934
|
+
"he",
|
|
3935
|
+
"hi",
|
|
3936
|
+
"hu",
|
|
3937
|
+
"is",
|
|
3938
|
+
"id",
|
|
3939
|
+
"ja",
|
|
3940
|
+
"jw",
|
|
3941
|
+
"kn",
|
|
3942
|
+
"kk",
|
|
3943
|
+
"km",
|
|
3944
|
+
"ko",
|
|
3945
|
+
"lo",
|
|
3946
|
+
"la",
|
|
3947
|
+
"lv",
|
|
3948
|
+
"ln",
|
|
3949
|
+
"lt",
|
|
3950
|
+
"lb",
|
|
3951
|
+
"mk",
|
|
3952
|
+
"mg",
|
|
3953
|
+
"ms",
|
|
3954
|
+
"ml",
|
|
3955
|
+
"mt",
|
|
3956
|
+
"mi",
|
|
3957
|
+
"mr",
|
|
3958
|
+
"mn",
|
|
3959
|
+
"ne",
|
|
3960
|
+
"no",
|
|
3961
|
+
"nn",
|
|
3962
|
+
"oc",
|
|
3963
|
+
"pa",
|
|
3964
|
+
"ps",
|
|
3965
|
+
"fa",
|
|
3966
|
+
"pl",
|
|
3967
|
+
"ro",
|
|
3968
|
+
"ru",
|
|
3969
|
+
"sa",
|
|
3970
|
+
"sr",
|
|
3971
|
+
"sn",
|
|
3972
|
+
"sd",
|
|
3973
|
+
"si",
|
|
3974
|
+
"sk",
|
|
3975
|
+
"sl",
|
|
3976
|
+
"so",
|
|
3977
|
+
"su",
|
|
3978
|
+
"sw",
|
|
3979
|
+
"sv",
|
|
3980
|
+
"tl",
|
|
3981
|
+
"tg",
|
|
3982
|
+
"ta",
|
|
3983
|
+
"tt",
|
|
3984
|
+
"te",
|
|
3985
|
+
"th",
|
|
3986
|
+
"bo",
|
|
3987
|
+
"tr",
|
|
3988
|
+
"tk",
|
|
3989
|
+
"uk",
|
|
3990
|
+
"ur",
|
|
3991
|
+
"uz",
|
|
3992
|
+
"vi",
|
|
3993
|
+
"cy",
|
|
3994
|
+
"yi",
|
|
3995
|
+
"yo"
|
|
3996
|
+
]).describe(
|
|
3997
|
+
"The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).\nThe default value is 'en_us'.\n"
|
|
3998
|
+
)
|
|
3999
|
+
).nullish().describe(
|
|
4000
|
+
"The language codes of your audio file. Used for [Code switching](/docs/speech-to-text/pre-recorded-audio/code-switching)\nOne of the values specified must be `en`.\n"
|
|
4001
|
+
),
|
|
4002
|
+
language_confidence: import_zod3.z.number().nullable().describe(
|
|
4003
|
+
"The confidence score for the detected language, between 0.0 (low confidence) and 1.0 (high confidence). See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details."
|
|
4004
|
+
),
|
|
4005
|
+
language_confidence_threshold: import_zod3.z.number().nullable().describe(
|
|
4006
|
+
"The confidence threshold for the automatically detected language.\nAn error will be returned if the language confidence is below this threshold.\nSee [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n"
|
|
4007
|
+
),
|
|
4008
|
+
language_detection: import_zod3.z.boolean().nullish().describe(
|
|
4009
|
+
"Whether [Automatic language detection](/docs/pre-recorded-audio/automatic-language-detection) is enabled, either true or false"
|
|
4010
|
+
),
|
|
4011
|
+
language_detection_options: import_zod3.z.object({
|
|
4012
|
+
expected_languages: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
4013
|
+
'List of languages expected in the audio file. Defaults to `["all"]` when unspecified. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.'
|
|
4014
|
+
),
|
|
4015
|
+
fallback_language: import_zod3.z.string().default(deleteTranscriptResponseLanguageDetectionOptionsFallbackLanguageDefault).describe(
|
|
4016
|
+
'If the detected language of the audio file is not in the list of expected languages, the `fallback_language` is used. Specify `["auto"]` to let our model choose the fallback language from `expected_languages` with the highest confidence score. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details.\n'
|
|
4017
|
+
),
|
|
4018
|
+
code_switching: import_zod3.z.boolean().optional().describe(
|
|
4019
|
+
"Whether [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) should be detected.\n"
|
|
4020
|
+
),
|
|
4021
|
+
code_switching_confidence_threshold: import_zod3.z.number().default(
|
|
4022
|
+
deleteTranscriptResponseLanguageDetectionOptionsCodeSwitchingConfidenceThresholdDefault
|
|
4023
|
+
).describe(
|
|
4024
|
+
"The confidence threshold for [code switching](/docs/speech-to-text/pre-recorded-audio/code-switching) detection. If the code switching confidence is below this threshold, the transcript will be processed in the language with the highest `language_detection_confidence` score.\n"
|
|
4025
|
+
)
|
|
4026
|
+
}).optional().describe(
|
|
4027
|
+
"Specify options for [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection)."
|
|
4028
|
+
),
|
|
4029
|
+
multichannel: import_zod3.z.boolean().nullish().describe(
|
|
4030
|
+
"Whether [Multichannel transcription](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) was enabled in the transcription request, either true or false"
|
|
4031
|
+
),
|
|
4032
|
+
prompt: import_zod3.z.string().optional().describe(
|
|
4033
|
+
"Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
4034
|
+
),
|
|
4035
|
+
punctuate: import_zod3.z.boolean().nullish().describe(
|
|
4036
|
+
"Whether [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false"
|
|
4037
|
+
),
|
|
4038
|
+
redact_pii: import_zod3.z.boolean().describe(
|
|
4039
|
+
"Whether [PII Redaction](https://www.assemblyai.com/docs/pii-redaction) is enabled, either true or false"
|
|
4040
|
+
),
|
|
4041
|
+
redact_pii_audio: import_zod3.z.boolean().nullish().describe(
|
|
4042
|
+
"Whether a redacted version of the audio file was generated,\neither true or false. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
4043
|
+
),
|
|
4044
|
+
redact_pii_audio_options: import_zod3.z.object({
|
|
4045
|
+
return_redacted_no_speech_audio: import_zod3.z.boolean().optional().describe(
|
|
4046
|
+
"By default, audio redaction provides redacted audio URLs only when speech is detected. However, if your use-case specifically requires redacted audio files even for silent audio files without any dialogue, you can opt to receive these URLs by setting this parameter to `true`."
|
|
4047
|
+
),
|
|
4048
|
+
override_audio_redaction_method: import_zod3.z.enum(["silence"]).optional().describe(
|
|
4049
|
+
"Specify the method used to redact audio. By default, redacted audio uses a beep sound. Set to `silence` to replace PII with silence instead of a beep."
|
|
4050
|
+
)
|
|
4051
|
+
}).optional().describe(
|
|
4052
|
+
"The options for PII-redacted audio, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
4053
|
+
),
|
|
4054
|
+
redact_pii_audio_quality: import_zod3.z.enum(["mp3", "wav"]).describe(
|
|
4055
|
+
"Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details."
|
|
4056
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
4057
|
+
"The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more information.\n"
|
|
4058
|
+
),
|
|
4059
|
+
redact_pii_policies: import_zod3.z.array(
|
|
4060
|
+
import_zod3.z.enum([
|
|
4061
|
+
"account_number",
|
|
4062
|
+
"banking_information",
|
|
4063
|
+
"blood_type",
|
|
4064
|
+
"credit_card_cvv",
|
|
4065
|
+
"credit_card_expiration",
|
|
4066
|
+
"credit_card_number",
|
|
4067
|
+
"date",
|
|
4068
|
+
"date_interval",
|
|
4069
|
+
"date_of_birth",
|
|
4070
|
+
"drivers_license",
|
|
4071
|
+
"drug",
|
|
4072
|
+
"duration",
|
|
4073
|
+
"email_address",
|
|
4074
|
+
"event",
|
|
4075
|
+
"filename",
|
|
4076
|
+
"gender_sexuality",
|
|
4077
|
+
"healthcare_number",
|
|
4078
|
+
"injury",
|
|
4079
|
+
"ip_address",
|
|
4080
|
+
"language",
|
|
4081
|
+
"location",
|
|
4082
|
+
"marital_status",
|
|
4083
|
+
"medical_condition",
|
|
4084
|
+
"medical_process",
|
|
4085
|
+
"money_amount",
|
|
4086
|
+
"nationality",
|
|
4087
|
+
"number_sequence",
|
|
4088
|
+
"occupation",
|
|
4089
|
+
"organization",
|
|
4090
|
+
"passport_number",
|
|
4091
|
+
"password",
|
|
4092
|
+
"person_age",
|
|
4093
|
+
"person_name",
|
|
4094
|
+
"phone_number",
|
|
4095
|
+
"physical_attribute",
|
|
4096
|
+
"political_affiliation",
|
|
4097
|
+
"religion",
|
|
4098
|
+
"statistics",
|
|
4099
|
+
"time",
|
|
4100
|
+
"url",
|
|
4101
|
+
"us_social_security_number",
|
|
4102
|
+
"username",
|
|
4103
|
+
"vehicle_id",
|
|
4104
|
+
"zodiac_sign"
|
|
4105
|
+
]).describe("The type of PII to redact")
|
|
4106
|
+
).nullish().describe(
|
|
4107
|
+
"The list of PII Redaction policies that were enabled, if PII Redaction is enabled.\nSee [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more information.\n"
|
|
3370
4108
|
),
|
|
3371
|
-
|
|
3372
|
-
"The
|
|
4109
|
+
redact_pii_sub: import_zod3.z.enum(["entity_name", "hash"]).optional().describe(
|
|
4110
|
+
"The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details."
|
|
3373
4111
|
),
|
|
3374
|
-
custom_topics: import_zod3.z.boolean().nullish().describe("Whether custom topics is enabled, either true or false"),
|
|
3375
|
-
topics: import_zod3.z.array(import_zod3.z.string()).optional().describe("The list of custom topics provided if custom topics is enabled"),
|
|
3376
4112
|
sentiment_analysis: import_zod3.z.boolean().nullish().describe(
|
|
3377
|
-
"Whether [Sentiment Analysis](https://www.assemblyai.com/docs/
|
|
4113
|
+
"Whether [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis) is enabled, can be true or false"
|
|
3378
4114
|
),
|
|
3379
4115
|
sentiment_analysis_results: import_zod3.z.array(
|
|
3380
4116
|
import_zod3.z.object({
|
|
@@ -3382,120 +4118,242 @@ var deleteTranscriptResponse = import_zod3.z.object({
|
|
|
3382
4118
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the sentence"),
|
|
3383
4119
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the sentence"),
|
|
3384
4120
|
sentiment: import_zod3.z.enum(["POSITIVE", "NEUTRAL", "NEGATIVE"]),
|
|
3385
|
-
confidence: import_zod3.z.number().
|
|
4121
|
+
confidence: import_zod3.z.number().describe(
|
|
3386
4122
|
"The confidence score for the detected sentiment of the sentence, from 0 to 1"
|
|
3387
4123
|
),
|
|
3388
4124
|
channel: import_zod3.z.string().nullish().describe(
|
|
3389
4125
|
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3390
4126
|
),
|
|
3391
4127
|
speaker: import_zod3.z.string().nullable().describe(
|
|
3392
|
-
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/
|
|
4128
|
+
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3393
4129
|
)
|
|
3394
4130
|
}).describe("The result of the Sentiment Analysis model")
|
|
3395
4131
|
).nullish().describe(
|
|
3396
|
-
"An array of results for the Sentiment Analysis model, if it is enabled.\nSee [Sentiment Analysis](https://www.assemblyai.com/docs/
|
|
4132
|
+
"An array of results for the Sentiment Analysis model, if it is enabled.\nSee [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis) for more information.\n"
|
|
3397
4133
|
),
|
|
3398
|
-
|
|
3399
|
-
"Whether [
|
|
4134
|
+
speaker_labels: import_zod3.z.boolean().nullish().describe(
|
|
4135
|
+
"Whether [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, can be true or false"
|
|
3400
4136
|
),
|
|
3401
|
-
|
|
4137
|
+
speakers_expected: import_zod3.z.number().nullish().describe(
|
|
4138
|
+
"Tell the speaker label model how many speakers it should attempt to identify. See [Set number of speakers expected](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-number-of-speakers-expected) for more details."
|
|
4139
|
+
),
|
|
4140
|
+
speech_model_used: import_zod3.z.string().optional().describe(
|
|
4141
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
4142
|
+
),
|
|
4143
|
+
speech_models: import_zod3.z.array(
|
|
4144
|
+
import_zod3.z.string().describe(
|
|
4145
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
4146
|
+
)
|
|
4147
|
+
).nullish().describe(
|
|
4148
|
+
"List multiple speech models in priority order, allowing our system to automatically route your audio to the best available option. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models and routing behavior.\n"
|
|
4149
|
+
),
|
|
4150
|
+
speech_threshold: import_zod3.z.number().nullish().describe(
|
|
4151
|
+
"Defaults to null. Reject audio files that contain less than this fraction of speech.\nValid values are in the range [0, 1] inclusive. See [Speech Threshold](https://www.assemblyai.com/docs/speech-threshold) for more details.\n"
|
|
4152
|
+
),
|
|
4153
|
+
speech_understanding: import_zod3.z.object({
|
|
4154
|
+
request: import_zod3.z.object({
|
|
4155
|
+
translation: import_zod3.z.object({
|
|
4156
|
+
target_languages: import_zod3.z.array(import_zod3.z.string()).describe(
|
|
4157
|
+
'List of target language codes (e.g., `["es", "de"]`). See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for supported languages.'
|
|
4158
|
+
),
|
|
4159
|
+
formal: import_zod3.z.boolean().default(deleteTranscriptResponseSpeechUnderstandingRequestTranslationFormalDefault).describe(
|
|
4160
|
+
"Use formal language style. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
4161
|
+
),
|
|
4162
|
+
match_original_utterance: import_zod3.z.boolean().optional().describe(
|
|
4163
|
+
"When enabled with Speaker Labels, returns translated text in the utterances array. Each utterance will include a `translated_texts` key containing translations for each target language."
|
|
4164
|
+
)
|
|
4165
|
+
})
|
|
4166
|
+
}).describe(
|
|
4167
|
+
"Request body for [Translation](https://www.assemblyai.com/docs/speech-understanding/translation)."
|
|
4168
|
+
).or(
|
|
4169
|
+
import_zod3.z.object({
|
|
4170
|
+
speaker_identification: import_zod3.z.object({
|
|
4171
|
+
speaker_type: import_zod3.z.enum(["role", "name"]).describe(
|
|
4172
|
+
"Type of speaker identification. See [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification) for details on each type."
|
|
4173
|
+
),
|
|
4174
|
+
known_values: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
4175
|
+
'Required if speaker_type is "role". Each value must be 35 characters or less.'
|
|
4176
|
+
),
|
|
4177
|
+
speakers: import_zod3.z.array(
|
|
4178
|
+
import_zod3.z.object({
|
|
4179
|
+
role: import_zod3.z.string().optional().describe(
|
|
4180
|
+
'The role of the speaker. Required when `speaker_type` is "role".'
|
|
4181
|
+
),
|
|
4182
|
+
name: import_zod3.z.string().optional().describe(
|
|
4183
|
+
'The name of the speaker. Required when `speaker_type` is "name".'
|
|
4184
|
+
),
|
|
4185
|
+
description: import_zod3.z.string().optional().describe(
|
|
4186
|
+
"A description of the speaker to help the model identify them based on conversational context."
|
|
4187
|
+
)
|
|
4188
|
+
})
|
|
4189
|
+
).optional().describe(
|
|
4190
|
+
"An array of speaker objects with metadata to improve identification accuracy. Each object should include a `role` or `name` (depending on `speaker_type`) and an optional `description` to help the model identify the speaker. You can also include any additional custom properties (e.g., `company`, `title`) to provide more context. Use this as an alternative to `known_values` when you want to provide additional context about each speaker."
|
|
4191
|
+
)
|
|
4192
|
+
})
|
|
4193
|
+
}).describe(
|
|
4194
|
+
"Request body for [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification)."
|
|
4195
|
+
)
|
|
4196
|
+
).or(
|
|
4197
|
+
import_zod3.z.object({
|
|
4198
|
+
custom_formatting: import_zod3.z.object({
|
|
4199
|
+
date: import_zod3.z.string().optional().describe(
|
|
4200
|
+
'Date format pattern (e.g., `"mm/dd/yyyy"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
4201
|
+
),
|
|
4202
|
+
phone_number: import_zod3.z.string().optional().describe(
|
|
4203
|
+
'Phone number format pattern (e.g., `"(xxx)xxx-xxxx"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
4204
|
+
),
|
|
4205
|
+
email: import_zod3.z.string().optional().describe(
|
|
4206
|
+
'Email format pattern (e.g., `"username@domain.com"`). See [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting) for more details.'
|
|
4207
|
+
)
|
|
4208
|
+
})
|
|
4209
|
+
}).describe(
|
|
4210
|
+
"Request body for [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting)."
|
|
4211
|
+
)
|
|
4212
|
+
).optional(),
|
|
4213
|
+
response: import_zod3.z.object({
|
|
4214
|
+
translation: import_zod3.z.object({
|
|
4215
|
+
status: import_zod3.z.string().optional()
|
|
4216
|
+
}).optional()
|
|
4217
|
+
}).or(
|
|
4218
|
+
import_zod3.z.object({
|
|
4219
|
+
speaker_identification: import_zod3.z.object({
|
|
4220
|
+
mapping: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional().describe(
|
|
4221
|
+
'A mapping of the original generic speaker labels (e.g., "A", "B") to the identified speaker names or roles.'
|
|
4222
|
+
),
|
|
4223
|
+
status: import_zod3.z.string().optional()
|
|
4224
|
+
}).optional()
|
|
4225
|
+
})
|
|
4226
|
+
).or(
|
|
4227
|
+
import_zod3.z.object({
|
|
4228
|
+
custom_formatting: import_zod3.z.object({
|
|
4229
|
+
mapping: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional(),
|
|
4230
|
+
formatted_text: import_zod3.z.string().optional()
|
|
4231
|
+
}).optional()
|
|
4232
|
+
})
|
|
4233
|
+
).optional()
|
|
4234
|
+
}).optional().describe(
|
|
4235
|
+
"Speech understanding tasks like [Translation](https://www.assemblyai.com/docs/speech-understanding/translation), [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification), and [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting). See the task-specific docs for available options and configuration.\n"
|
|
4236
|
+
),
|
|
4237
|
+
status: import_zod3.z.enum(["queued", "processing", "completed", "error"]).describe(
|
|
4238
|
+
"The status of your transcript. Possible values are queued, processing, completed, or error."
|
|
4239
|
+
),
|
|
4240
|
+
summarization: import_zod3.z.boolean().describe(
|
|
4241
|
+
"Whether [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization) is enabled, either true or false. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n\nNote: This parameter is only supported for the Universal-2 model.\n"
|
|
4242
|
+
),
|
|
4243
|
+
summary: import_zod3.z.string().nullish().describe(
|
|
4244
|
+
"The generated summary of the media file, if [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details."
|
|
4245
|
+
),
|
|
4246
|
+
summary_model: import_zod3.z.string().nullish().describe(
|
|
4247
|
+
"The Summarization model used to generate the summary,\nif [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization#summary-models) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details.\n"
|
|
4248
|
+
),
|
|
4249
|
+
summary_type: import_zod3.z.string().nullish().describe(
|
|
4250
|
+
"The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization#summary-types) is enabled. Deprecated - use [LLM Gateway](https://www.assemblyai.com/docs/llm-gateway/overview) instead for more flexible summaries. See the [updated Summarization page](https://www.assemblyai.com/docs/speech-understanding/summarization) for details."
|
|
4251
|
+
),
|
|
4252
|
+
remove_audio_tags: import_zod3.z.enum(["all"]).describe(
|
|
4253
|
+
"Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
4254
|
+
).or(import_zod3.z.null()).optional().describe(
|
|
4255
|
+
"Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.\n\nNote: This parameter is only supported for the Universal-3 Pro model.\n"
|
|
4256
|
+
),
|
|
4257
|
+
temperature: import_zod3.z.number().nullish().describe(
|
|
4258
|
+
"The temperature that was used for the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.\n\nNote: This parameter can only be used with the Universal-3 Pro model.\n"
|
|
4259
|
+
),
|
|
4260
|
+
text: import_zod3.z.string().nullish().describe("The textual transcript of your media file"),
|
|
4261
|
+
throttled: import_zod3.z.boolean().nullish().describe(
|
|
4262
|
+
"True while a request is throttled and false when a request is no longer throttled"
|
|
4263
|
+
),
|
|
4264
|
+
utterances: import_zod3.z.array(
|
|
3402
4265
|
import_zod3.z.object({
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3415
|
-
|
|
3416
|
-
|
|
3417
|
-
|
|
3418
|
-
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
"
|
|
3423
|
-
"language",
|
|
3424
|
-
"location",
|
|
3425
|
-
"marital_status",
|
|
3426
|
-
"medical_condition",
|
|
3427
|
-
"medical_process",
|
|
3428
|
-
"money_amount",
|
|
3429
|
-
"nationality",
|
|
3430
|
-
"number_sequence",
|
|
3431
|
-
"occupation",
|
|
3432
|
-
"organization",
|
|
3433
|
-
"passport_number",
|
|
3434
|
-
"password",
|
|
3435
|
-
"person_age",
|
|
3436
|
-
"person_name",
|
|
3437
|
-
"phone_number",
|
|
3438
|
-
"physical_attribute",
|
|
3439
|
-
"political_affiliation",
|
|
3440
|
-
"religion",
|
|
3441
|
-
"statistics",
|
|
3442
|
-
"time",
|
|
3443
|
-
"url",
|
|
3444
|
-
"us_social_security_number",
|
|
3445
|
-
"username",
|
|
3446
|
-
"vehicle_id",
|
|
3447
|
-
"zodiac_sign"
|
|
3448
|
-
]).describe("The type of entity for the detected entity"),
|
|
3449
|
-
text: import_zod3.z.string().describe("The text for the detected entity"),
|
|
3450
|
-
start: import_zod3.z.number().describe(
|
|
3451
|
-
"The starting time, in milliseconds, at which the detected entity appears in the audio file"
|
|
4266
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this utterance"),
|
|
4267
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the utterance in the audio file"),
|
|
4268
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the utterance in the audio file"),
|
|
4269
|
+
text: import_zod3.z.string().describe("The text for this utterance"),
|
|
4270
|
+
words: import_zod3.z.array(
|
|
4271
|
+
import_zod3.z.object({
|
|
4272
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
4273
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
4274
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
4275
|
+
text: import_zod3.z.string().describe("The text of the word"),
|
|
4276
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
4277
|
+
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
4278
|
+
),
|
|
4279
|
+
speaker: import_zod3.z.string().nullable().describe(
|
|
4280
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
4281
|
+
)
|
|
4282
|
+
})
|
|
4283
|
+
).describe("The words in the utterance."),
|
|
4284
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
4285
|
+
"The channel of this utterance. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3452
4286
|
),
|
|
3453
|
-
|
|
3454
|
-
|
|
4287
|
+
speaker: import_zod3.z.string().describe(
|
|
4288
|
+
'The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.'
|
|
4289
|
+
),
|
|
4290
|
+
translated_texts: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.string()).optional().describe(
|
|
4291
|
+
'Translations keyed by language code (e.g., `{"es": "Texto traducido", "de": "\xDCbersetzter Text"}`). Only present when `match_original_utterance` is enabled with translation.'
|
|
3455
4292
|
)
|
|
3456
|
-
})
|
|
4293
|
+
})
|
|
3457
4294
|
).nullish().describe(
|
|
3458
|
-
"
|
|
4295
|
+
"When multichannel or speaker_labels is enabled, a list of turn-by-turn utterance objects.\nSee [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) and [Multichannel transcription](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) for more information.\n"
|
|
3459
4296
|
),
|
|
3460
|
-
|
|
3461
|
-
"
|
|
4297
|
+
webhook_auth: import_zod3.z.boolean().describe(
|
|
4298
|
+
"Whether [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) authentication details were provided"
|
|
3462
4299
|
),
|
|
3463
|
-
|
|
3464
|
-
"
|
|
4300
|
+
webhook_auth_header_name: import_zod3.z.string().nullish().describe(
|
|
4301
|
+
"The header name to be sent with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests"
|
|
3465
4302
|
),
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
4303
|
+
webhook_status_code: import_zod3.z.number().nullish().describe(
|
|
4304
|
+
"The status code we received from your server when delivering the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) request, if a webhook URL was provided"
|
|
4305
|
+
),
|
|
4306
|
+
webhook_url: import_zod3.z.string().nullish().describe(
|
|
4307
|
+
"The URL to which we send [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests.\n"
|
|
4308
|
+
),
|
|
4309
|
+
words: import_zod3.z.array(
|
|
4310
|
+
import_zod3.z.object({
|
|
4311
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
4312
|
+
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
4313
|
+
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
4314
|
+
text: import_zod3.z.string().describe("The text of the word"),
|
|
4315
|
+
channel: import_zod3.z.string().nullish().describe(
|
|
4316
|
+
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
4317
|
+
),
|
|
4318
|
+
speaker: import_zod3.z.string().nullable().describe(
|
|
4319
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
4320
|
+
)
|
|
4321
|
+
})
|
|
4322
|
+
).nullish().describe(
|
|
4323
|
+
"An array of temporally-sequential word objects, one for each word in the transcript.\n"
|
|
4324
|
+
),
|
|
4325
|
+
acoustic_model: import_zod3.z.string().describe("This parameter does not currently have any functionality attached to it."),
|
|
4326
|
+
custom_topics: import_zod3.z.boolean().nullish().describe("This parameter does not currently have any functionality attached to it."),
|
|
4327
|
+
language_model: import_zod3.z.string().describe("This parameter does not currently have any functionality attached to it."),
|
|
4328
|
+
speech_model: import_zod3.z.string().describe(
|
|
4329
|
+
"The speech model to use for the transcription. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models."
|
|
4330
|
+
).or(import_zod3.z.null()).describe(
|
|
4331
|
+
"This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model).\n"
|
|
4332
|
+
),
|
|
4333
|
+
speed_boost: import_zod3.z.boolean().nullish().describe("This parameter does not currently have any functionality attached to it."),
|
|
4334
|
+
topics: import_zod3.z.array(import_zod3.z.string()).optional().describe("This parameter does not currently have any functionality attached to it."),
|
|
4335
|
+
translated_texts: import_zod3.z.object({
|
|
4336
|
+
language_code: import_zod3.z.string().optional().describe("Translated text for this language code")
|
|
4337
|
+
}).optional().describe(
|
|
4338
|
+
"Translated text keyed by language code. See [Translation](https://www.assemblyai.com/docs/speech-understanding/translation) for more details."
|
|
4339
|
+
)
|
|
3469
4340
|
}).describe("A transcript object");
|
|
3470
|
-
var getSubtitlesParams = import_zod3.z.object({
|
|
3471
|
-
transcript_id: import_zod3.z.string().describe("ID of the transcript"),
|
|
3472
|
-
subtitle_format: import_zod3.z.enum(["srt", "vtt"]).describe("The format of the captions")
|
|
3473
|
-
});
|
|
3474
|
-
var getSubtitlesQueryParams = import_zod3.z.object({
|
|
3475
|
-
chars_per_caption: import_zod3.z.number().optional().describe("The maximum number of characters per caption")
|
|
3476
|
-
});
|
|
3477
4341
|
var getTranscriptSentencesParams = import_zod3.z.object({
|
|
3478
4342
|
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
3479
4343
|
});
|
|
3480
|
-
var getTranscriptSentencesResponseConfidenceMin = 0;
|
|
3481
|
-
var getTranscriptSentencesResponseConfidenceMax = 1;
|
|
3482
|
-
var getTranscriptSentencesResponseSentencesItemConfidenceMin = 0;
|
|
3483
|
-
var getTranscriptSentencesResponseSentencesItemConfidenceMax = 1;
|
|
3484
|
-
var getTranscriptSentencesResponseSentencesItemWordsItemConfidenceMin = 0;
|
|
3485
|
-
var getTranscriptSentencesResponseSentencesItemWordsItemConfidenceMax = 1;
|
|
3486
4344
|
var getTranscriptSentencesResponse = import_zod3.z.object({
|
|
3487
4345
|
id: import_zod3.z.string().uuid().describe("The unique identifier for the transcript"),
|
|
3488
|
-
confidence: import_zod3.z.number().
|
|
4346
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript"),
|
|
3489
4347
|
audio_duration: import_zod3.z.number().describe("The duration of the audio file in seconds"),
|
|
3490
4348
|
sentences: import_zod3.z.array(
|
|
3491
4349
|
import_zod3.z.object({
|
|
3492
4350
|
text: import_zod3.z.string().describe("The transcript of the sentence"),
|
|
3493
4351
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the sentence"),
|
|
3494
4352
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the sentence"),
|
|
3495
|
-
confidence: import_zod3.z.number().
|
|
4353
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this sentence"),
|
|
3496
4354
|
words: import_zod3.z.array(
|
|
3497
4355
|
import_zod3.z.object({
|
|
3498
|
-
confidence: import_zod3.z.number().
|
|
4356
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
3499
4357
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
3500
4358
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
3501
4359
|
text: import_zod3.z.string().describe("The text of the word"),
|
|
@@ -3503,7 +4361,7 @@ var getTranscriptSentencesResponse = import_zod3.z.object({
|
|
|
3503
4361
|
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3504
4362
|
),
|
|
3505
4363
|
speaker: import_zod3.z.string().nullable().describe(
|
|
3506
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/
|
|
4364
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3507
4365
|
)
|
|
3508
4366
|
})
|
|
3509
4367
|
).describe("An array of words in the sentence"),
|
|
@@ -3511,7 +4369,7 @@ var getTranscriptSentencesResponse = import_zod3.z.object({
|
|
|
3511
4369
|
"The channel of the sentence. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3512
4370
|
),
|
|
3513
4371
|
speaker: import_zod3.z.string().nullable().describe(
|
|
3514
|
-
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/
|
|
4372
|
+
"The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3515
4373
|
)
|
|
3516
4374
|
})
|
|
3517
4375
|
).describe("An array of sentences in the transcript")
|
|
@@ -3519,25 +4377,19 @@ var getTranscriptSentencesResponse = import_zod3.z.object({
|
|
|
3519
4377
|
var getTranscriptParagraphsParams = import_zod3.z.object({
|
|
3520
4378
|
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
3521
4379
|
});
|
|
3522
|
-
var getTranscriptParagraphsResponseConfidenceMin = 0;
|
|
3523
|
-
var getTranscriptParagraphsResponseConfidenceMax = 1;
|
|
3524
|
-
var getTranscriptParagraphsResponseParagraphsItemConfidenceMin = 0;
|
|
3525
|
-
var getTranscriptParagraphsResponseParagraphsItemConfidenceMax = 1;
|
|
3526
|
-
var getTranscriptParagraphsResponseParagraphsItemWordsItemConfidenceMin = 0;
|
|
3527
|
-
var getTranscriptParagraphsResponseParagraphsItemWordsItemConfidenceMax = 1;
|
|
3528
4380
|
var getTranscriptParagraphsResponse = import_zod3.z.object({
|
|
3529
4381
|
id: import_zod3.z.string().uuid().describe("The unique identifier of your transcript"),
|
|
3530
|
-
confidence: import_zod3.z.number().
|
|
4382
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript"),
|
|
3531
4383
|
audio_duration: import_zod3.z.number().describe("The duration of the audio file in seconds"),
|
|
3532
4384
|
paragraphs: import_zod3.z.array(
|
|
3533
4385
|
import_zod3.z.object({
|
|
3534
4386
|
text: import_zod3.z.string().describe("The transcript of the paragraph"),
|
|
3535
4387
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, of the paragraph"),
|
|
3536
4388
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, of the paragraph"),
|
|
3537
|
-
confidence: import_zod3.z.number().
|
|
4389
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this paragraph"),
|
|
3538
4390
|
words: import_zod3.z.array(
|
|
3539
4391
|
import_zod3.z.object({
|
|
3540
|
-
confidence: import_zod3.z.number().
|
|
4392
|
+
confidence: import_zod3.z.number().describe("The confidence score for the transcript of this word"),
|
|
3541
4393
|
start: import_zod3.z.number().describe("The starting time, in milliseconds, for the word"),
|
|
3542
4394
|
end: import_zod3.z.number().describe("The ending time, in milliseconds, for the word"),
|
|
3543
4395
|
text: import_zod3.z.string().describe("The text of the word"),
|
|
@@ -3545,13 +4397,28 @@ var getTranscriptParagraphsResponse = import_zod3.z.object({
|
|
|
3545
4397
|
"The channel of the word. The left and right channels are channels 1 and 2. Additional channels increment the channel number sequentially."
|
|
3546
4398
|
),
|
|
3547
4399
|
speaker: import_zod3.z.string().nullable().describe(
|
|
3548
|
-
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/
|
|
4400
|
+
"The speaker of the word if [Speaker Diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization) is enabled, else null"
|
|
3549
4401
|
)
|
|
3550
4402
|
})
|
|
3551
4403
|
).describe("An array of words in the paragraph")
|
|
3552
4404
|
})
|
|
3553
4405
|
).describe("An array of paragraphs in the transcript")
|
|
3554
4406
|
});
|
|
4407
|
+
var getSubtitlesParams = import_zod3.z.object({
|
|
4408
|
+
transcript_id: import_zod3.z.string().describe("ID of the transcript"),
|
|
4409
|
+
subtitle_format: import_zod3.z.enum(["srt", "vtt"]).describe("The format of the captions")
|
|
4410
|
+
});
|
|
4411
|
+
var getSubtitlesQueryParams = import_zod3.z.object({
|
|
4412
|
+
chars_per_caption: import_zod3.z.number().optional().describe("The maximum number of characters per caption")
|
|
4413
|
+
});
|
|
4414
|
+
var getSubtitlesResponse = import_zod3.z.object({});
|
|
4415
|
+
var getRedactedAudioParams = import_zod3.z.object({
|
|
4416
|
+
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
4417
|
+
});
|
|
4418
|
+
var getRedactedAudioResponse = import_zod3.z.object({
|
|
4419
|
+
status: import_zod3.z.enum(["redacted_audio_ready"]).describe("The status of the redacted audio"),
|
|
4420
|
+
redacted_audio_url: import_zod3.z.string().describe("The URL of the redacted audio file")
|
|
4421
|
+
});
|
|
3555
4422
|
var wordSearchParams = import_zod3.z.object({
|
|
3556
4423
|
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
3557
4424
|
});
|
|
@@ -3568,7 +4435,7 @@ var wordSearchResponse = import_zod3.z.object({
|
|
|
3568
4435
|
text: import_zod3.z.string().describe("The matched word"),
|
|
3569
4436
|
count: import_zod3.z.number().describe("The total amount of times the word is in the transcript"),
|
|
3570
4437
|
timestamps: import_zod3.z.array(
|
|
3571
|
-
import_zod3.z.array(import_zod3.z.number()
|
|
4438
|
+
import_zod3.z.array(import_zod3.z.number()).describe(
|
|
3572
4439
|
"An array of timestamps structured as [`start_time`, `end_time`] in milliseconds"
|
|
3573
4440
|
)
|
|
3574
4441
|
).describe("An array of timestamps"),
|
|
@@ -3578,199 +4445,6 @@ var wordSearchResponse = import_zod3.z.object({
|
|
|
3578
4445
|
})
|
|
3579
4446
|
).describe("The matches of the search")
|
|
3580
4447
|
});
|
|
3581
|
-
var getRedactedAudioParams = import_zod3.z.object({
|
|
3582
|
-
transcript_id: import_zod3.z.string().describe("ID of the transcript")
|
|
3583
|
-
});
|
|
3584
|
-
var getRedactedAudioResponse = import_zod3.z.object({
|
|
3585
|
-
status: import_zod3.z.enum(["redacted_audio_ready"]).describe("The status of the redacted audio"),
|
|
3586
|
-
redacted_audio_url: import_zod3.z.string().describe("The URL of the redacted audio file")
|
|
3587
|
-
});
|
|
3588
|
-
var createTemporaryTokenBodyExpiresInMin = 60;
|
|
3589
|
-
var createTemporaryTokenBody = import_zod3.z.object({
|
|
3590
|
-
expires_in: import_zod3.z.number().min(createTemporaryTokenBodyExpiresInMin).describe("The amount of time until the token expires in seconds")
|
|
3591
|
-
});
|
|
3592
|
-
var createTemporaryTokenResponse = import_zod3.z.object({
|
|
3593
|
-
token: import_zod3.z.string().describe("The temporary authentication token for Streaming Speech-to-Text")
|
|
3594
|
-
});
|
|
3595
|
-
var lemurTaskBodyMaxOutputSizeDefault = 2e3;
|
|
3596
|
-
var lemurTaskBodyTemperatureMin = 0;
|
|
3597
|
-
var lemurTaskBodyTemperatureMax = 1;
|
|
3598
|
-
var lemurTaskBody = import_zod3.z.object({
|
|
3599
|
-
prompt: import_zod3.z.string().describe(
|
|
3600
|
-
"Your text to prompt the model to produce a desired output, including any context you want to pass into the model."
|
|
3601
|
-
)
|
|
3602
|
-
}).and(
|
|
3603
|
-
import_zod3.z.object({
|
|
3604
|
-
transcript_ids: import_zod3.z.array(import_zod3.z.string().uuid()).optional().describe(
|
|
3605
|
-
"A list of completed transcripts with text. Up to a maximum of 100 hours of audio.\nUse either transcript_ids or input_text as input into LeMUR.\n"
|
|
3606
|
-
),
|
|
3607
|
-
input_text: import_zod3.z.string().optional().describe(
|
|
3608
|
-
"Custom formatted transcript data. Maximum size is the context limit of the selected model.\nUse either transcript_ids or input_text as input into LeMUR.\n"
|
|
3609
|
-
),
|
|
3610
|
-
context: import_zod3.z.string().or(import_zod3.z.record(import_zod3.z.string(), import_zod3.z.any())).optional().describe("Context to provide the model. This can be a string or a free-form JSON value."),
|
|
3611
|
-
final_model: import_zod3.z.enum([
|
|
3612
|
-
"anthropic/claude-3-5-sonnet",
|
|
3613
|
-
"anthropic/claude-3-opus",
|
|
3614
|
-
"anthropic/claude-3-haiku"
|
|
3615
|
-
]).describe("The model that is used for the final prompt after compression is performed.\n").or(import_zod3.z.string()).describe("The model that is used for the final prompt after compression is performed.\n"),
|
|
3616
|
-
max_output_size: import_zod3.z.number().default(lemurTaskBodyMaxOutputSizeDefault).describe("Max output size in tokens."),
|
|
3617
|
-
temperature: import_zod3.z.number().min(lemurTaskBodyTemperatureMin).max(lemurTaskBodyTemperatureMax).optional().describe(
|
|
3618
|
-
"The temperature to use for the model.\nHigher values result in answers that are more creative, lower values are more conservative.\nCan be any value between 0.0 and 1.0 inclusive.\n"
|
|
3619
|
-
)
|
|
3620
|
-
})
|
|
3621
|
-
);
|
|
3622
|
-
var lemurTaskResponseUsageInputTokensMin = 0;
|
|
3623
|
-
var lemurTaskResponseUsageOutputTokensMin = 0;
|
|
3624
|
-
var lemurTaskResponse = import_zod3.z.object({
|
|
3625
|
-
response: import_zod3.z.string().describe("The response generated by LeMUR.")
|
|
3626
|
-
}).and(
|
|
3627
|
-
import_zod3.z.object({
|
|
3628
|
-
request_id: import_zod3.z.string().uuid().describe("The ID of the LeMUR request"),
|
|
3629
|
-
usage: import_zod3.z.object({
|
|
3630
|
-
input_tokens: import_zod3.z.number().min(lemurTaskResponseUsageInputTokensMin).describe("The number of input tokens used by the model"),
|
|
3631
|
-
output_tokens: import_zod3.z.number().min(lemurTaskResponseUsageOutputTokensMin).describe("The number of output tokens generated by the model")
|
|
3632
|
-
}).describe("The usage numbers for the LeMUR request")
|
|
3633
|
-
})
|
|
3634
|
-
);
|
|
3635
|
-
var lemurSummaryBodyMaxOutputSizeDefault = 2e3;
|
|
3636
|
-
var lemurSummaryBodyTemperatureMin = 0;
|
|
3637
|
-
var lemurSummaryBodyTemperatureMax = 1;
|
|
3638
|
-
var lemurSummaryBody = import_zod3.z.object({
|
|
3639
|
-
transcript_ids: import_zod3.z.array(import_zod3.z.string().uuid()).optional().describe(
|
|
3640
|
-
"A list of completed transcripts with text. Up to a maximum of 100 hours of audio.\nUse either transcript_ids or input_text as input into LeMUR.\n"
|
|
3641
|
-
),
|
|
3642
|
-
input_text: import_zod3.z.string().optional().describe(
|
|
3643
|
-
"Custom formatted transcript data. Maximum size is the context limit of the selected model.\nUse either transcript_ids or input_text as input into LeMUR.\n"
|
|
3644
|
-
),
|
|
3645
|
-
context: import_zod3.z.string().or(import_zod3.z.record(import_zod3.z.string(), import_zod3.z.any())).optional().describe("Context to provide the model. This can be a string or a free-form JSON value."),
|
|
3646
|
-
final_model: import_zod3.z.enum(["anthropic/claude-3-5-sonnet", "anthropic/claude-3-opus", "anthropic/claude-3-haiku"]).describe("The model that is used for the final prompt after compression is performed.\n").or(import_zod3.z.string()).describe("The model that is used for the final prompt after compression is performed.\n"),
|
|
3647
|
-
max_output_size: import_zod3.z.number().default(lemurSummaryBodyMaxOutputSizeDefault).describe("Max output size in tokens."),
|
|
3648
|
-
temperature: import_zod3.z.number().min(lemurSummaryBodyTemperatureMin).max(lemurSummaryBodyTemperatureMax).optional().describe(
|
|
3649
|
-
"The temperature to use for the model.\nHigher values result in answers that are more creative, lower values are more conservative.\nCan be any value between 0.0 and 1.0 inclusive.\n"
|
|
3650
|
-
)
|
|
3651
|
-
}).and(
|
|
3652
|
-
import_zod3.z.object({
|
|
3653
|
-
answer_format: import_zod3.z.string().optional().describe(
|
|
3654
|
-
'How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points"\n'
|
|
3655
|
-
)
|
|
3656
|
-
})
|
|
3657
|
-
);
|
|
3658
|
-
var lemurSummaryResponseUsageInputTokensMin = 0;
|
|
3659
|
-
var lemurSummaryResponseUsageOutputTokensMin = 0;
|
|
3660
|
-
var lemurSummaryResponse = import_zod3.z.object({
|
|
3661
|
-
response: import_zod3.z.string().describe("The response generated by LeMUR.")
|
|
3662
|
-
}).and(
|
|
3663
|
-
import_zod3.z.object({
|
|
3664
|
-
request_id: import_zod3.z.string().uuid().describe("The ID of the LeMUR request"),
|
|
3665
|
-
usage: import_zod3.z.object({
|
|
3666
|
-
input_tokens: import_zod3.z.number().min(lemurSummaryResponseUsageInputTokensMin).describe("The number of input tokens used by the model"),
|
|
3667
|
-
output_tokens: import_zod3.z.number().min(lemurSummaryResponseUsageOutputTokensMin).describe("The number of output tokens generated by the model")
|
|
3668
|
-
}).describe("The usage numbers for the LeMUR request")
|
|
3669
|
-
})
|
|
3670
|
-
);
|
|
3671
|
-
var lemurQuestionAnswerBodyMaxOutputSizeDefault = 2e3;
|
|
3672
|
-
var lemurQuestionAnswerBodyTemperatureMin = 0;
|
|
3673
|
-
var lemurQuestionAnswerBodyTemperatureMax = 1;
|
|
3674
|
-
var lemurQuestionAnswerBody = import_zod3.z.object({
|
|
3675
|
-
transcript_ids: import_zod3.z.array(import_zod3.z.string().uuid()).optional().describe(
|
|
3676
|
-
"A list of completed transcripts with text. Up to a maximum of 100 hours of audio.\nUse either transcript_ids or input_text as input into LeMUR.\n"
|
|
3677
|
-
),
|
|
3678
|
-
input_text: import_zod3.z.string().optional().describe(
|
|
3679
|
-
"Custom formatted transcript data. Maximum size is the context limit of the selected model.\nUse either transcript_ids or input_text as input into LeMUR.\n"
|
|
3680
|
-
),
|
|
3681
|
-
context: import_zod3.z.string().or(import_zod3.z.record(import_zod3.z.string(), import_zod3.z.any())).optional().describe("Context to provide the model. This can be a string or a free-form JSON value."),
|
|
3682
|
-
final_model: import_zod3.z.enum(["anthropic/claude-3-5-sonnet", "anthropic/claude-3-opus", "anthropic/claude-3-haiku"]).describe("The model that is used for the final prompt after compression is performed.\n").or(import_zod3.z.string()).describe("The model that is used for the final prompt after compression is performed.\n"),
|
|
3683
|
-
max_output_size: import_zod3.z.number().default(lemurQuestionAnswerBodyMaxOutputSizeDefault).describe("Max output size in tokens."),
|
|
3684
|
-
temperature: import_zod3.z.number().min(lemurQuestionAnswerBodyTemperatureMin).max(lemurQuestionAnswerBodyTemperatureMax).optional().describe(
|
|
3685
|
-
"The temperature to use for the model.\nHigher values result in answers that are more creative, lower values are more conservative.\nCan be any value between 0.0 and 1.0 inclusive.\n"
|
|
3686
|
-
)
|
|
3687
|
-
}).and(
|
|
3688
|
-
import_zod3.z.object({
|
|
3689
|
-
questions: import_zod3.z.array(
|
|
3690
|
-
import_zod3.z.object({
|
|
3691
|
-
question: import_zod3.z.string().describe(
|
|
3692
|
-
"The question you wish to ask. For more complex questions use default model."
|
|
3693
|
-
),
|
|
3694
|
-
context: import_zod3.z.string().or(import_zod3.z.record(import_zod3.z.string(), import_zod3.z.any())).optional().describe(
|
|
3695
|
-
"Any context about the transcripts you wish to provide. This can be a string or any object."
|
|
3696
|
-
),
|
|
3697
|
-
answer_format: import_zod3.z.string().optional().describe(
|
|
3698
|
-
`How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points"
|
|
3699
|
-
`
|
|
3700
|
-
),
|
|
3701
|
-
answer_options: import_zod3.z.array(import_zod3.z.string()).optional().describe(
|
|
3702
|
-
`What discrete options to return. Useful for precise responses. Can't be used with answer_format. Example: ["Yes", "No"]
|
|
3703
|
-
`
|
|
3704
|
-
)
|
|
3705
|
-
})
|
|
3706
|
-
).describe("A list of questions to ask")
|
|
3707
|
-
})
|
|
3708
|
-
);
|
|
3709
|
-
var lemurQuestionAnswerResponseUsageInputTokensMin = 0;
|
|
3710
|
-
var lemurQuestionAnswerResponseUsageOutputTokensMin = 0;
|
|
3711
|
-
var lemurQuestionAnswerResponse = import_zod3.z.object({
|
|
3712
|
-
request_id: import_zod3.z.string().uuid().describe("The ID of the LeMUR request"),
|
|
3713
|
-
usage: import_zod3.z.object({
|
|
3714
|
-
input_tokens: import_zod3.z.number().min(lemurQuestionAnswerResponseUsageInputTokensMin).describe("The number of input tokens used by the model"),
|
|
3715
|
-
output_tokens: import_zod3.z.number().min(lemurQuestionAnswerResponseUsageOutputTokensMin).describe("The number of output tokens generated by the model")
|
|
3716
|
-
}).describe("The usage numbers for the LeMUR request")
|
|
3717
|
-
}).and(
|
|
3718
|
-
import_zod3.z.object({
|
|
3719
|
-
response: import_zod3.z.array(
|
|
3720
|
-
import_zod3.z.object({
|
|
3721
|
-
question: import_zod3.z.string().describe("The question for LeMUR to answer"),
|
|
3722
|
-
answer: import_zod3.z.string().describe("The answer generated by LeMUR")
|
|
3723
|
-
}).describe("An answer generated by LeMUR and its question")
|
|
3724
|
-
).describe("The answers generated by LeMUR and their questions")
|
|
3725
|
-
})
|
|
3726
|
-
);
|
|
3727
|
-
var getLemurResponseParams = import_zod3.z.object({
|
|
3728
|
-
request_id: import_zod3.z.string().describe(
|
|
3729
|
-
"The ID of the LeMUR request you previously made.\nThis would be found in the response of the original request.\n"
|
|
3730
|
-
)
|
|
3731
|
-
});
|
|
3732
|
-
var getLemurResponseResponseUsageInputTokensMin = 0;
|
|
3733
|
-
var getLemurResponseResponseUsageOutputTokensMin = 0;
|
|
3734
|
-
var getLemurResponseResponseUsageInputTokensMinOne = 0;
|
|
3735
|
-
var getLemurResponseResponseUsageOutputTokensMinOne = 0;
|
|
3736
|
-
var getLemurResponseResponse = import_zod3.z.object({
|
|
3737
|
-
response: import_zod3.z.string().describe("The response generated by LeMUR.")
|
|
3738
|
-
}).and(
|
|
3739
|
-
import_zod3.z.object({
|
|
3740
|
-
request_id: import_zod3.z.string().uuid().describe("The ID of the LeMUR request"),
|
|
3741
|
-
usage: import_zod3.z.object({
|
|
3742
|
-
input_tokens: import_zod3.z.number().min(getLemurResponseResponseUsageInputTokensMin).describe("The number of input tokens used by the model"),
|
|
3743
|
-
output_tokens: import_zod3.z.number().min(getLemurResponseResponseUsageOutputTokensMin).describe("The number of output tokens generated by the model")
|
|
3744
|
-
}).describe("The usage numbers for the LeMUR request")
|
|
3745
|
-
})
|
|
3746
|
-
).or(
|
|
3747
|
-
import_zod3.z.object({
|
|
3748
|
-
request_id: import_zod3.z.string().uuid().describe("The ID of the LeMUR request"),
|
|
3749
|
-
usage: import_zod3.z.object({
|
|
3750
|
-
input_tokens: import_zod3.z.number().min(getLemurResponseResponseUsageInputTokensMinOne).describe("The number of input tokens used by the model"),
|
|
3751
|
-
output_tokens: import_zod3.z.number().min(getLemurResponseResponseUsageOutputTokensMinOne).describe("The number of output tokens generated by the model")
|
|
3752
|
-
}).describe("The usage numbers for the LeMUR request")
|
|
3753
|
-
}).and(
|
|
3754
|
-
import_zod3.z.object({
|
|
3755
|
-
response: import_zod3.z.array(
|
|
3756
|
-
import_zod3.z.object({
|
|
3757
|
-
question: import_zod3.z.string().describe("The question for LeMUR to answer"),
|
|
3758
|
-
answer: import_zod3.z.string().describe("The answer generated by LeMUR")
|
|
3759
|
-
}).describe("An answer generated by LeMUR and its question")
|
|
3760
|
-
).describe("The answers generated by LeMUR and their questions")
|
|
3761
|
-
})
|
|
3762
|
-
)
|
|
3763
|
-
);
|
|
3764
|
-
var purgeLemurRequestDataParams = import_zod3.z.object({
|
|
3765
|
-
request_id: import_zod3.z.string().describe(
|
|
3766
|
-
"The ID of the LeMUR request whose data you want to delete. This would be found in the response of the original request."
|
|
3767
|
-
)
|
|
3768
|
-
});
|
|
3769
|
-
var purgeLemurRequestDataResponse = import_zod3.z.object({
|
|
3770
|
-
request_id: import_zod3.z.string().uuid().describe("The ID of the deletion request of the LeMUR request"),
|
|
3771
|
-
request_id_to_purge: import_zod3.z.string().uuid().describe("The ID of the LeMUR request to purge the data for"),
|
|
3772
|
-
deleted: import_zod3.z.boolean().describe("Whether the request data was deleted")
|
|
3773
|
-
});
|
|
3774
4448
|
|
|
3775
4449
|
// src/generated/assemblyai/streaming-types.zod.ts
|
|
3776
4450
|
var import_zod4 = require("zod");
|
|
@@ -3785,25 +4459,37 @@ var streamingTranscriberParams = import_zod4.z.object({
|
|
|
3785
4459
|
enableExtraSessionInformation: import_zod4.z.boolean().optional().describe(
|
|
3786
4460
|
"Set to true to receive the SessionInformation message before the session ends. Defaults to false."
|
|
3787
4461
|
),
|
|
4462
|
+
domain: import_zod4.z.string().optional().describe(
|
|
4463
|
+
'Enable domain-specific transcription models to improve accuracy for specialized terminology. Set to `"medical-v1"` to enable [Medical Mode](https://www.assemblyai.com/docs/streaming/medical-mode) for improved accuracy of medical terms such as medications, procedures, conditions, and dosages. Supported languages: English (`en`), Spanish (`es`), German (`de`), French (`fr`). If used with an unsupported language, the parameter is ignored and a warning is returned.'
|
|
4464
|
+
),
|
|
3788
4465
|
endOfTurnConfidenceThreshold: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3789
4466
|
minEndOfTurnSilenceWhenConfident: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
4467
|
+
minTurnSilence: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3790
4468
|
maxTurnSilence: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3791
4469
|
vadThreshold: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3792
4470
|
formatTurns: import_zod4.z.boolean().optional().describe("From SDK v3"),
|
|
3793
4471
|
filterProfanity: import_zod4.z.boolean().optional().describe("From SDK v3"),
|
|
3794
4472
|
keyterms: import_zod4.z.array(import_zod4.z.string()).optional().describe("From SDK v3"),
|
|
3795
4473
|
keytermsPrompt: import_zod4.z.array(import_zod4.z.string()).optional().describe("From SDK v3"),
|
|
3796
|
-
|
|
4474
|
+
prompt: import_zod4.z.string().optional().describe("From SDK v3"),
|
|
4475
|
+
speechModel: import_zod4.z.enum(["universal-streaming-english", "universal-streaming-multilingual"]).describe("From SDK v3"),
|
|
3797
4476
|
languageDetection: import_zod4.z.boolean().optional().describe("From SDK v3"),
|
|
3798
|
-
inactivityTimeout: import_zod4.z.number().optional().describe("From SDK v3")
|
|
4477
|
+
inactivityTimeout: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
4478
|
+
speakerLabels: import_zod4.z.boolean().optional().describe("From SDK v3"),
|
|
4479
|
+
maxSpeakers: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
4480
|
+
llmGateway: import_zod4.z.unknown().optional().describe("From SDK v3")
|
|
3799
4481
|
});
|
|
3800
4482
|
var streamingUpdateConfigParams = import_zod4.z.object({
|
|
3801
4483
|
end_utterance_silence_threshold: import_zod4.z.number().min(0).max(2e4).optional().describe("The duration threshold in milliseconds"),
|
|
3802
4484
|
end_of_turn_confidence_threshold: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3803
4485
|
min_end_of_turn_silence_when_confident: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
4486
|
+
min_turn_silence: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3804
4487
|
max_turn_silence: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3805
4488
|
vad_threshold: import_zod4.z.number().optional().describe("From SDK v3"),
|
|
3806
|
-
format_turns: import_zod4.z.boolean().optional().describe("From SDK v3")
|
|
4489
|
+
format_turns: import_zod4.z.boolean().optional().describe("From SDK v3"),
|
|
4490
|
+
keyterms_prompt: import_zod4.z.array(import_zod4.z.string()).optional().describe("From SDK v3"),
|
|
4491
|
+
prompt: import_zod4.z.string().optional().describe("From SDK v3"),
|
|
4492
|
+
filter_profanity: import_zod4.z.boolean().optional().describe("From SDK v3")
|
|
3807
4493
|
});
|
|
3808
4494
|
|
|
3809
4495
|
// src/generated/gladia/api/gladiaControlAPI.zod.ts
|