Hoppa till navigering

Skapa transkript

Transkribera en ljud- eller videofil. Om webhook är satt till true behandlas begäran asynkront och resultaten skickas till konfigurerade webhooks. När use_multi_channel är true och det angivna ljudet har flera kanaler returneras ett ‘transcripts’-objekt med separata transkriptioner för varje kanal. Sätt multichannel_output_style=‘combined’ för att i stället få en enda transkription där alla kanaler har slagits samman och sorterats efter tid. Annars returneras en enda transkription. Den valfria parametern webhook_metadata låter dig bifoga anpassade data som inkluderas i webhook-svar för att koppla och spåra begäranden.

Headers

xi-api-keystringValfri

Frågeparametrar

tokenstring or nullValfri

En autentiseringstoken för engångsbruk som skapas via POST /v1/single-use-token/batch_scribe. Den här tokenen kan bara användas en gång och upphör att gälla efter 15 minuter. Ett alternativ till API-nyckel eller autentisering med bearer-token för frontendklienter.

enable_loggingbooleanValfriStandard är true

När enable_logging är satt till false används nollkvarhållningsläge för begäran. Det innebär att lagringsfunktioner för loggar och transkript inte är tillgängliga för denna begäran. Nollkvarhållningsläge får endast användas av företagskunder.

Förfrågan

This endpoint expects a multipart form containing an optional file.
model_idstringObligatorisk

ID:t för modellen som ska användas för transkribering.

filefileValfri

Filen som ska transkriberas (minsta ljudlängd är 100 ms). Alla vanliga ljud- och videoformat stöds. Exakt en av parametrarna file eller cloud_storage_url måste anges. Filstorleken måste vara mindre än 5,0 GB.

language_codestring or nullValfri

En ISO-639-1- eller ISO-639-3-language_code som motsvarar ljudfilens språk. Kan ibland förbättra transkriberingsprestandan om språket är känt i förväg. Standardvärdet är null, och då förutsägs språket automatiskt.

transcript_editstring or nullValfri

Instruktion på naturligt språk som tillämpas på den slutliga transkriptionen (max 2 000 tecken). Den redigerade texten returneras i ‘edited_transcript’ tillsammans med originaltranskriptionen. Kan inte kombineras med entity_detection, entity_redaction eller use_multi_channel. Användning av den här parametern medför ett tillägg på 30 % av grundkostnaden för transkribering, debiterat för minst 10 sekunders ljud.

tag_audio_eventsbooleanValfriStandard är true

Om ljudhändelser som (skratt), (fotsteg) osv. ska taggas i transkriberingen.

num_speakersinteger or nullValfri1-32

Det högsta antalet talare i den uppladdade filen. Kan hjälpa till att förutsäga vem som talar när. Högst 32 talare kan förutsägas. Standardvärdet är null; då sätts antalet talare till det högsta värde som modellen har stöd för.

timestamps_granularityenumValfriStandard är word

Detaljnivån för tidsstämplarna i transkriberingen. ‘word’ ger tidsstämplar på ordnivå och ‘character’ ger tidsstämplar på teckennivå för varje ord.

Tillåtna värden:
diarizebooleanValfriStandard är false

Om det ska markeras vilken talare som för närvarande talar i den uppladdade filen.

diarization_thresholddouble or nullValfri0.1-0.4

Diariseringströskel som används vid talardiarisering. Ett högre värde innebär lägre risk att en talare diariseras som två olika talare, men högre risk att två olika talare diariseras som en talare (färre talare förutsägs totalt). Ett lågt värde innebär högre risk att en talare diariseras som två olika talare, men lägre risk att två olika talare diariseras som en talare (fler talare förutsägs totalt). Kan endast anges när diarize=True och num_speakers=None. Standardvärdet är None, och då väljer vi en tröskel baserat på model_id (vanligtvis 0.22).

additional_formatslist of objectsValfri

En lista över ytterligare format att exportera transkriptionen till.

file_formatenumValfriStandard är 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.

Tillåtna värden:
cloud_storage_urlstring or nullValfriDeprecated

[Föråldrat] Den här parametern är föråldrad och kommer att tas bort i framtiden. Använd ‘source_url’ i stället. HTTPS-URL:en för filen som ska transkriberas. Exakt en av parametrarna file eller cloud_storage_url måste anges. Filen måste vara tillgänglig via HTTPS och vara mindre än 2 GB. Alla giltiga HTTPS-URL:er accepteras, inklusive URL:er från molnlagringsleverantörer (AWS S3, Google Cloud Storage, Cloudflare R2 osv.), CDN:er eller andra HTTPS-källor. URL:er kan vara försigneda eller innehålla autentiseringstoken i frågeparametrar.

source_urlstring or nullValfri

Webbadressen till en ljud- eller videofil som ska transkriberas. Stöder lagrade video- eller ljudfiler, YouTube-video-URL:er, TikTok-video-URL:er och andra videohostingtjänster.

webhookbooleanValfriStandard är false

Om transkriberingsresultatet ska skickas till konfigurerade speech-to-text-webhooks. Om detta anges returneras begäran tidigt utan transkriberingen, som levereras senare via webhook.

webhook_idstring or nullValfri

Valfritt specifikt webhook-ID att skicka transkriptionsresultatet till. Gäller endast när webhook är satt till true. Om det inte anges skickas transkriptionen till alla konfigurerade speech-to-text-webhooks.

temperaturedouble or nullValfri0-2

Styr slumpmässigheten i transkriberingsresultatet. Accepterar värden mellan 0.0 och 2.0, där högre värden ger mer varierade och mindre deterministiska resultat. Om värdet utelämnas använder vi en temperatur baserad på den modell du har valt, vilket vanligtvis är 0.

seedinteger or nullValfri0-2147483647

Om angivet försöker systemet sampla deterministiskt, så att upprepade förfrågningar med samma seed och parametrar bör ge samma resultat. Determinism garanteras inte. Måste vara ett heltal mellan 0 och 2147483647.

use_multi_channelbooleanValfriStandard är false

Om ljudfilen innehåller flera kanaler där varje kanal innehåller en enda talare. När funktionen är aktiverad transkriberas varje kanal separat. Som standard returneras en separat transkription per kanal; ange multichannel_output_style=‘combined’ för att i stället få en enda transkription där alla kanaler har slagits ihop och sorterats efter tid. Varje ord i svaret innehåller fältet ‘channel_index’, som anger i vilken kanal det sades. Högst 5 kanaler stöds. Varje kanal debiteras separat för hela ljudlängden, så kostnaden ökar linjärt med antalet kanaler.

multichannel_output_styleenumValfriStandard är separate

Styr svarsformatet när use_multi_channel är aktiverat. ‘separate’ (standard) returnerar en transkription per kanal under ‘transcripts’. ‘combined’ sammanfogar alla kanaler till en enda transkription där orden sorteras efter starttid och vart och ett har ett ‘channel_index’ – samma format som svaret för en kanal. ‘combined’ kräver tidsstämplar (timestamps_granularity får inte vara ‘none’) och stöder inte entitetsidentifiering eller maskering.

Tillåtna värden:
webhook_metadatastring or map from strings to any or nullValfri

Valfria metadata att inkludera i webhook-svaret. Detta ska vara en JSON-sträng som representerar ett objekt med högst 2 nivåers djup och en maximal storlek på 16 KB. Användbart för att spåra interna ID:n, jobbreferenser eller annan kontextuell information.

entity_detectionstring or list of strings or nullValfri

Identifiera entiteter i transkriptionen. Kan vara ‘all’ för att identifiera alla entiteter, en enskild entitetstyp eller kategoristräng eller en lista med entitetstyper/kategorier. Kategorierna omfattar ‘pii’, ‘phi’, ‘pci’, ‘other’, ‘offensive_language’. När funktionen är aktiverad returneras identifierade entiteter i fältet ‘entities’ med text, typ och teckenpositioner.

no_verbatimbooleanValfriStandard är false

Om värdet är true innehåller transkriptionen inga utfyllnadsord, felstarter eller icke-talljud. Stöds endast med modellen scribe_v2.

use_speaker_librarybooleanValfriStandard är false

Om talarbiblioteket ska användas för att identifiera kända talare under diariseringsprocessen. När detta är aktiverat och diarize är true matchas identifierade talare mot registrerade talare i arbetsytans talarbibliotek.

detect_speaker_rolesbooleanValfriStandard är false

Om talarroller ska identifieras (agent respektive kund). Kräver diarize=true. Kan inte användas med use_multi_channel=true. När funktionen är aktiverad blir speaker_id-värdena ‘agent’ och ‘customer’ i stället för ‘speaker_0’, ‘speaker_1’ osv. Användning medför ett ytterligare påslag på 10 % av grundkostnaden för transkribering.

entity_redactionstring or list of strings or nullValfri

Maskera entiteter i transkriptionstexten. Accepterar samma format som entity_detection: ‘all’, en kategori (‘pii’, ‘phi’) eller specifika entitetstyper. Måste vara en delmängd av entity_detection. När maskering är aktiverad returneras inte fältet entities.

entity_redaction_modestringValfriStandard är enumerated_entity_type

Hur maskerade entiteter ska formateras. ‘redacted’ ersätter med {REDACTED}, ‘entity_type’ ersätter med {ENTITY_TYPE} och ‘enumerated_entity_type’ ersätter med {ENTITY_TYPE_N}, där N numrerar varje förekomst. Används endast när entity_redaction har angetts.

keytermslist of stringsValfriStandard är []

En lista med nyckeltermer som styr transkriberingen mot dessa. Nyckeltermer är ord eller fraser som du vill att modellen ska känna igen mer exakt. Antalet nyckeltermer får inte överstiga 1 000. Varje nyckelterm måste vara kortare än 50 tecken. Nyckeltermer får innehålla högst 5 ord (efter normalisering). Till exempel [“hello”, “world”, “technical term”]. Följande tecken stöds inte: <, >, {, }, [, ], \. Användning av den här parametern medför en extra avgift på 20 % av baskostnaden för transkribering. När fler än 100 nyckeltermer anges tillämpas en lägsta fakturerbar längd på 20 sekunder per begäran.

Svar

Synkront transkriptionsresultat
SpeechToTextChunkResponseModelobject

Detaljer om transkriptionen på chunknivå med tidsinformation.

OR
MultichannelSpeechToTextResponseModelobject

Svarsmodell för flerkanalig tal-till-text-transkribering.

OR
SpeechToTextWebhookResponseModelobject

Fel

422
Unprocessable Entity Error