import type * as Corti from "../../../../index.mjs"; /** * @example * { * recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479", * primaryLanguage: "en" * } */ export interface TranscriptsCreateRequest { /** The unique identifier for the recording. */ recordingId: Corti.Uuid; /** The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more. */ primaryLanguage: string; /** When true, converts spoken punctuation such as 'period' or 'slash' into symbols (e.g., '.', '/'). When enabled, automatic punctuation is turned off. Takes precedence over `automaticPunctuation` when both are enabled. */ spokenPunctuation?: boolean; /** When true, automatically punctuates and capitalizes the transcript. Defaults to true. Overridden by `spokenPunctuation` when both are enabled. */ automaticPunctuation?: boolean; formatting?: Corti.TranscriptsFormatting; /** **Deprecated** — replaced by `spokenPunctuation` and `automaticPunctuation`. Ignored when either of those fields is provided. When `true` and neither new field is provided, it is treated as `spokenPunctuation: true` (automatic punctuation off). No removal date is currently planned. */ isDictation?: boolean; /** If true, each audio channel is transcribed separately. */ isMultichannel?: boolean; /** If true, separates speakers within an audio channel returning incrementing ids for transcript segments. */ diarize?: boolean; /** An array of participants, each specifying a free-form role and an assigned audio channel in the recording. For raw PCM, the channel count must be defined; otherwise, the number of audio channels is resolved from the audio itself, not from the declared participants. Leave empty when diarize: true. See [audio formatting](https://docs.corti.ai/stt/audio) for full details. */ participants?: Corti.TranscriptsParticipant[]; /** If true, the request will return immediately with a 202 status and the transcript will be processed asynchronously. Poll [Get Transcript Status](/api-reference/transcripts/get-transcript-status) to check transcript processing status - `processing`, `completed`, `failed`. */ async?: boolean; /** Define replacements to have terms (single words or multi-word phrases) replaced in final text output with your preferred style. For example, replace "BID" with "twice daily". Configuration is case insensitive and limited to 1,000 replacements per stream. A defined replacement can have a maximum length of 100 characters and 10-words for `find` and `replace` fields. */ replacements?: Corti.TranscriptsCreateRequestReplacementsItem[]; /** Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. */ keyterms?: Corti.TranscriptsCreateRequestKeyterms; /** When enabled, the transcript is stored and returned at word level instead of phrase/utterance level. Fixed for the lifetime of the transcript once created. */ wordLevel?: Corti.TranscriptsCreateRequestWordLevel; }