Skip to navigation

Transcript maken

Transcribeer een audio- of videobestand. Als webhook is ingesteld op true, wordt de request asynchroon verwerkt en worden de resultaten naar geconfigureerde webhooks gestuurd. Wanneer use_multi_channel true is en de opgegeven audio meerdere kanalen heeft, wordt een ‘transcripts’-object met afzonderlijke transcripten voor elk kanaal geretourneerd; stel multichannel_output_style=‘combined’ in om in plaats daarvan één transcript te ontvangen waarin alle kanalen zijn samengevoegd en op tijd zijn gesorteerd. Anders wordt één transcript geretourneerd. Met de optionele parameter webhook_metadata kun je aangepaste gegevens toevoegen die worden opgenomen in webhook-reacties voor requestcorrelatie en tracking.

Headers

xi-api-keystringOptional

Query parameters

tokenstring or nullOptional

Een eenmalige authenticatietoken die is gemaakt via POST /v1/single-use-token/batch_scribe. Deze token kan slechts één keer worden gebruikt en verloopt na 15 minuten. Alternatief voor authenticatie met een API-sleutel of bearer token voor frontendclients.

enable_loggingbooleanOptionalDefaults to true

Wanneer enable_logging is ingesteld op false, wordt voor het request de modus zonder gegevensbewaring gebruikt. Hierdoor zijn functies voor het opslaan van logs en transcripts niet beschikbaar voor dit request. De modus zonder gegevensbewaring is alleen beschikbaar voor Enterprise-klanten.

Request

This endpoint expects a multipart form containing an optional file.
model_idstringRequired
De ID van het model dat voor transcriptie moet worden gebruikt.
filefileOptional

Het bestand dat moet worden getranscribeerd (minimale audiolengte van 100 ms). Alle gangbare audio- en videoformaten worden ondersteund. Er moet precies één van de parameters file of cloud_storage_url worden opgegeven. Het bestand moet kleiner zijn dan 5,0 GB.

language_codestring or nullOptional

Een ISO-639-1- of ISO-639-3-language_code die overeenkomt met de taal van het audiobestand. Kan de transcriptieprestaties soms verbeteren als deze vooraf bekend is. De standaardwaarde is null; in dat geval wordt de taal automatisch voorspeld.

transcript_editstring or nullOptional

Instructie in natuurlijke taal die wordt toegepast op het definitieve transcript (maximaal 2000 tekens). De bewerkte tekst wordt samen met het originele transcript geretourneerd in ‘edited_transcript’. Kan niet worden gecombineerd met entity_detection, entity_redaction of use_multi_channel. Gebruik van deze parameter brengt een extra toeslag van 30% boven op de basiskosten voor transcriptie met zich mee, berekend voor ten minste 10 seconden audio.

tag_audio_eventsbooleanOptionalDefaults to true

Of audiogebeurtenissen zoals (gelach), (voetstappen), enzovoort in de transcriptie moeten worden getagd.

num_speakersinteger or nullOptional1-32

Het maximumaantal sprekers dat in het geüploade bestand spreekt. Dit kan helpen voorspellen wie wanneer spreekt. Het maximumaantal voorspelbare sprekers is 32. De standaardwaarde is null; in dat geval wordt het aantal sprekers ingesteld op de maximale waarde die het model ondersteunt.

timestamps_granularityenumOptionalDefaults to word
De granulariteit van de tijdstempels in de transcriptie. 'word' geeft tijdstempels op woordniveau en 'character' geeft tijdstempels op tekenniveau per woord.
Allowed values:
diarizebooleanOptionalDefaults to false

Of moet worden aangegeven welke spreker momenteel spreekt in het geüploade bestand.

diarization_thresholddouble or nullOptional0.1-0.4

Diarisatiedrempel die wordt toegepast tijdens sprekerdiarisatie. Een hogere waarde betekent een kleinere kans dat één spreker als twee verschillende sprekers wordt gediariseerd, maar ook een grotere kans dat twee verschillende sprekers als één spreker worden gediariseerd (minder sprekers in totaal voorspeld). Een lage waarde betekent een grotere kans dat één spreker als twee verschillende sprekers wordt gediariseerd, maar ook een kleinere kans dat twee verschillende sprekers als één spreker worden gediariseerd (meer sprekers in totaal voorspeld). Kan alleen worden ingesteld wanneer diarize=True en num_speakers=None. De standaardwaarde is None; in dat geval kiezen we een drempel op basis van model_id (meestal 0.22).

additional_formatslist of objectsOptional

Een lijst met extra formaten waarnaar het transcript moet worden geëxporteerd.

file_formatenumOptionalDefaults to other

The format of input audio. Options are ‘pcm_s16le_16’ or ‘other’ For pcm_s16le_16, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order. Latency will be lower than with passing an encoded waveform.

Allowed values:
cloud_storage_urlstring or nullOptionalDeprecated

[Verouderd] Deze parameter is verouderd en wordt in de toekomst verwijderd. Gebruik in plaats daarvan ‘source_url’. De HTTPS-URL van het te transcriberen bestand. Er moet precies één van de parameters file of cloud_storage_url worden opgegeven. Het bestand moet toegankelijk zijn via HTTPS en kleiner zijn dan 2 GB. Elke geldige HTTPS-URL wordt geaccepteerd, inclusief URL’s van cloudstorageproviders (AWS S3, Google Cloud Storage, Cloudflare R2 enzovoort), CDN’s of andere HTTPS-bronnen. URL’s kunnen vooraf ondertekend zijn of authenticatietokens in queryparameters bevatten.

source_urlstring or nullOptional

De URL van een audio- of videobestand om te transcriberen. Ondersteunt gehoste video- of audiobestanden, YouTube-video-URL’s, TikTok-video-URL’s en andere videohostingservices.

webhookbooleanOptionalDefaults to false

Of het transcriptieresultaat naar geconfigureerde Speech to Text-webhooks moet worden gestuurd. Als dit is ingesteld, keert de request vroegtijdig terug zonder transcriptie, die later via webhook wordt geleverd.

webhook_idstring or nullOptional

Optionele specifieke webhook-ID waarnaar het transcriptieresultaat wordt verzonden. Alleen geldig wanneer webhook is ingesteld op true. Als dit niet wordt opgegeven, wordt de transcriptie naar alle geconfigureerde Speech to Text-webhooks verzonden.

temperaturedouble or nullOptional0-2

Bepaalt de willekeur van de transcriptie-uitvoer. Accepteert waarden tussen 0.0 en 2.0, waarbij hogere waarden leiden tot meer diverse en minder deterministische resultaten. Als je dit weglaat, gebruiken we een temperatuur op basis van het model dat je hebt geselecteerd; deze is meestal 0.

seedinteger or nullOptional0-2147483647
Als dit wordt opgegeven, doet ons systeem zijn best om deterministisch te samplen, zodat herhaalde requests met dezelfde seed en parameters hetzelfde resultaat zouden moeten opleveren. Determinisme is niet gegarandeerd. Moet een geheel getal tussen 0 en 2147483647 zijn.
use_multi_channelbooleanOptionalDefaults to false

Of het audiobestand meerdere kanalen bevat, waarbij elk kanaal één spreker bevat. Wanneer ingeschakeld, wordt elk kanaal onafhankelijk getranscribeerd. Standaard wordt er per kanaal een afzonderlijk transcript geretourneerd; stel multichannel_output_style=‘combined’ in om in plaats daarvan één transcript te ontvangen waarin alle kanalen zijn samengevoegd en op tijd zijn gesorteerd. Elk woord in de response bevat een veld ‘channel_index’ dat aangeeft op welk kanaal het is uitgesproken. Er worden maximaal 5 kanalen ondersteund. Elk kanaal wordt onafhankelijk gefactureerd voor de volledige audioduur, dus de kosten schalen lineair met het aantal kanalen.

multichannel_output_styleenumOptionalDefaults to separate

Bepaalt de responsevorm wanneer use_multi_channel is ingeschakeld. ‘separate’ (standaard) retourneert één transcript per kanaal onder ‘transcripts’. ‘combined’ voegt alle kanalen samen tot één transcript waarvan de woorden op starttijd zijn gesorteerd en elk een ‘channel_index’ hebben, overeenkomstig de responsevorm voor één kanaal. ‘combined’ vereist timestamps (timestamps_granularity mag niet ‘none’ zijn) en ondersteunt geen entiteitsdetectie of redactie.

Allowed values:
webhook_metadatastring or map from strings to any or nullOptional

Optionele metadata die in het webhookantwoord moet worden opgenomen. Dit moet een JSON-tekenreeks zijn die een object vertegenwoordigt met een maximale diepte van 2 niveaus en een maximale grootte van 16 KB. Handig voor het volgen van interne ID’s, jobreferenties of andere contextuele informatie.

entity_detectionstring or list of strings or nullOptional

Detecteer entiteiten in het transcript. Kan ‘all’ zijn om alle entiteiten te detecteren, een enkele tekenreeks voor een entiteitstype of categorie, of een lijst met entiteitstypen/-categorieën. Categorieën zijn onder andere ‘pii’, ‘phi’, ‘pci’, ‘other’ en ‘offensive_language’. Als dit is ingeschakeld, worden gedetecteerde entiteiten geretourneerd in het veld ‘entities’, met hun tekst, type en tekenposities.

no_verbatimbooleanOptionalDefaults to false

Als true, bevat de transcriptie geen stopwoorden, valse starts en niet-spraakgeluiden. Alleen ondersteund met het model scribe_v2.

use_speaker_librarybooleanOptionalDefaults to false
Of de sprekersbibliotheek moet worden gebruikt om bekende sprekers tijdens diarization te identificeren. Wanneer dit is ingeschakeld en diarize true is, worden gedetecteerde sprekers gekoppeld aan geregistreerde sprekers in de sprekersbibliotheek van de workspace.
detect_speaker_rolesbooleanOptionalDefaults to false

Of sprekersrollen moeten worden gedetecteerd (agent versus klant). Vereist diarize=true. Kan niet worden gebruikt met use_multi_channel=true. Wanneer ingeschakeld, zijn de waarden van speaker_id ‘agent’ en ‘customer’ in plaats van ‘speaker_0’, ‘speaker_1’, enzovoort. Gebruik brengt een toeslag van 10% boven op de basiskosten voor transcriptie met zich mee.

entity_redactionstring or list of strings or nullOptional

Redigeer entiteiten uit de transcripttekst. Accepteert dezelfde indeling als entity_detection: ‘all’, een categorie (‘pii’, ‘phi’) of specifieke entiteitstypen. Moet een subset van entity_detection zijn. Wanneer redactie is ingeschakeld, wordt het veld entities niet geretourneerd.

entity_redaction_modestringOptionalDefaults to enumerated_entity_type

Hoe geredigeerde entiteiten moeten worden opgemaakt. ‘redacted’ vervangt door {REDACTED}, ‘entity_type’ vervangt door {ENTITY_TYPE}, en ‘enumerated_entity_type’ vervangt door {ENTITY_TYPE_N}, waarbij N elk exemplaar nummert. Alleen gebruikt wanneer entity_redaction is ingesteld.

keytermslist of stringsOptionalDefaults to []

Een lijst met sleuteltermen om de transcriptie in die richting te sturen. De sleuteltermen zijn woorden of woordgroepen die je wilt dat het model nauwkeuriger herkent. Het aantal sleuteltermen mag niet meer dan 1000 zijn. Elke sleutelterm moet korter zijn dan 50 tekens. Sleuteltermen mogen maximaal 5 woorden bevatten (na normalisatie). Bijvoorbeeld [“hello”, “world”, “technical term”]. De volgende tekens worden niet ondersteund: <, >, {, }, [, ], \. Voor het gebruik van deze parameter geldt een toeslag van 20% op de basiskosten voor transcriptie. Als je meer dan 100 sleuteltermen opgeeft, geldt per request een minimale factureerbare duur van 20 seconden.

Response

Synchroon transcriptieresultaat
SpeechToTextChunkResponseModelobject
Details van de transcriptie op chunkniveau met tijdsinformatie.
OR
MultichannelSpeechToTextResponseModelobject

Responsemodel voor meerkanaals Speech to Text-transcriptie.

OR
SpeechToTextWebhookResponseModelobject

Errors

422
Unprocessable Entity Error