import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { TranscribeStreamingServiceException as __BaseException } from "./TranscribeStreamingServiceException"; /** *

Contains entities identified as personally identifiable information (PII) in your * transcription output, along with various associated attributes. Examples include category, * confidence score, type, stability score, and start and end times.

* @public */ export interface Entity { /** *

The start time, in milliseconds, of the utterance that was identified as PII.

* @public */ StartTime?: number; /** *

The end time, in milliseconds, of the utterance that was identified as PII.

* @public */ EndTime?: number; /** *

The category of information identified. The only category is PII.

* @public */ Category?: string; /** *

The type of PII identified. For example, NAME or * CREDIT_DEBIT_NUMBER.

* @public */ Type?: string; /** *

The word or words identified as PII.

* @public */ Content?: string; /** *

The confidence score associated with the identified PII entity in your audio.

*

Confidence scores are values between 0 and 1. A larger value indicates a higher * probability that the identified entity correctly matches the entity spoken in your * media.

* @public */ Confidence?: number; } /** * @public * @enum */ export declare const ItemType: { readonly PRONUNCIATION: "pronunciation"; readonly PUNCTUATION: "punctuation"; }; /** * @public */ export type ItemType = (typeof ItemType)[keyof typeof ItemType]; /** *

A word, phrase, or punctuation mark in your transcription output, along with various associated * attributes, such as confidence score, type, and start and end times.

* @public */ export interface Item { /** *

The start time, in milliseconds, of the transcribed item.

* @public */ StartTime?: number; /** *

The end time, in milliseconds, of the transcribed item.

* @public */ EndTime?: number; /** *

The type of item identified. Options are: PRONUNCIATION (spoken words) and * PUNCTUATION.

* @public */ Type?: ItemType; /** *

The word or punctuation that was transcribed.

* @public */ Content?: string; /** *

Indicates whether the specified item matches a word in the vocabulary filter included in * your request. If true, there is a vocabulary filter match.

* @public */ VocabularyFilterMatch?: boolean; /** *

If speaker partitioning is enabled, Speaker labels the speaker of the * specified item.

* @public */ Speaker?: string; /** *

The confidence score associated with a word or phrase in your transcript.

*

Confidence scores are values between 0 and 1. A larger value indicates a higher * probability that the identified item correctly matches the item spoken in your media.

* @public */ Confidence?: number; /** *

If partial result stabilization is enabled, Stable indicates whether the specified * item is stable (true) or if it may change when the segment is complete * (false).

* @public */ Stable?: boolean; } /** *

A list of possible alternative transcriptions for the input audio. Each alternative may contain * one or more of Items, Entities, or Transcript.

* @public */ export interface Alternative { /** *

Contains transcribed text.

* @public */ Transcript?: string; /** *

Contains words, phrases, or punctuation marks in your transcription output.

* @public */ Items?: Item[]; /** *

Contains entities identified as personally identifiable information (PII) in your transcription * output.

* @public */ Entities?: Entity[]; } /** *

A wrapper for your audio chunks. Your audio stream consists of one or more audio * events, which consist of one or more audio chunks.

*

For more information, see Event stream encoding.

* @public */ export interface AudioEvent { /** *

An audio blob that contains the next part of the audio that you want to transcribe. The * maximum audio chunk size is 32 KB.

* @public */ AudioChunk?: Uint8Array; } /** * @public * @enum */ export declare const ParticipantRole: { readonly AGENT: "AGENT"; readonly CUSTOMER: "CUSTOMER"; }; /** * @public */ export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantRole]; /** *

Makes it possible to specify which speaker is on which audio channel. For example, if your * agent is the first participant to speak, you would set ChannelId to * 0 (to indicate the first channel) and ParticipantRole to * AGENT (to indicate that it's the agent speaking).

* @public */ export interface ChannelDefinition { /** *

Specify the audio channel you want to define.

* @public */ ChannelId: number | undefined; /** *

Specify the speaker you want to define. Omitting this parameter is equivalent to * specifying both participants.

* @public */ ParticipantRole: ParticipantRole | undefined; } /** * @public * @enum */ export declare const ContentRedactionOutput: { readonly REDACTED: "redacted"; readonly REDACTED_AND_UNREDACTED: "redacted_and_unredacted"; }; /** * @public */ export type ContentRedactionOutput = (typeof ContentRedactionOutput)[keyof typeof ContentRedactionOutput]; /** *

Allows you to specify additional settings for your streaming Call Analytics * post-call request, including output locations for your redacted and unredacted * transcript, which IAM role to use, and, optionally, which encryption key to * use.

*

* ContentRedactionOutput, DataAccessRoleArn, and * OutputLocation are required fields.

* @public */ export interface PostCallAnalyticsSettings { /** *

The Amazon S3 location where you want your Call Analytics post-call * transcription output stored. You can use any of the following formats to specify the output * location:

*
    *
  1. *

    s3://DOC-EXAMPLE-BUCKET

    *
    2. *
  2. *

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/

    *
    3. *
  3. *

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

    *
    4. *
* @public */ OutputLocation: string | undefined; /** *

The Amazon Resource Name (ARN) of an IAM role that has permissions to * access the Amazon S3 bucket that contains your input files. If the role that you * specify doesn’t have the appropriate permissions to access the specified Amazon S3 * location, your request fails.

*

IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path. For example: * arn:aws:iam::111122223333:role/Admin. For more information, see IAM * ARNs.

* @public */ DataAccessRoleArn: string | undefined; /** *

Specify whether you want only a redacted transcript or both a redacted and an unredacted * transcript. If you choose redacted and unredacted, two JSON files are generated and stored in the * Amazon S3 output location you specify.

*

Note that to include ContentRedactionOutput in your request, you must * enable content redaction (ContentRedactionType).

* @public */ ContentRedactionOutput?: ContentRedactionOutput; /** *

The KMS key you want to use to encrypt your Call Analytics post-call * output.

*

If using a key located in the current * Amazon Web Services account, you can specify your KMS key in one of four * ways:

*
    *
  1. *

    Use the KMS key ID itself. For example, * 1234abcd-12ab-34cd-56ef-1234567890ab.

    *
    2. *
  2. *

    Use an alias for the KMS key ID. For example, * alias/ExampleAlias.

    *
    3. *
  3. *

    Use the Amazon Resource Name (ARN) for the KMS key ID. For * example, * arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    *
    4. *
  4. *

    Use the ARN for the KMS key alias. For example, * arn:aws:kms:region:account-ID:alias/ExampleAlias.

    *
    5. *
*

If using a key located in a different * Amazon Web Services account than the current Amazon Web Services account, you can specify * your KMS key in one of two ways:

*
    *
  1. *

    Use the ARN for the KMS key ID. For example, * arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    *
    2. *
  2. *

    Use the ARN for the KMS key alias. For example, * arn:aws:kms:region:account-ID:alias/ExampleAlias.

    *
    3. *
*

Note that the user making the request must * have permission to use the specified KMS key.

* @public */ OutputEncryptionKMSKeyId?: string; } /** *

Allows you to set audio channel definitions and post-call analytics settings.

* @public */ export interface ConfigurationEvent { /** *

Indicates which speaker is on which audio channel.

* @public */ ChannelDefinitions?: ChannelDefinition[]; /** *

Provides additional optional settings for your Call Analytics post-call request, including * encryption and output locations for your redacted and unredacted transcript.

* @public */ PostCallAnalyticsSettings?: PostCallAnalyticsSettings; } /** *

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket * data frames.

*

For more information, see Transcribing streaming audio.

* @public */ export type AudioStream = AudioStream.AudioEventMember | AudioStream.ConfigurationEventMember | AudioStream.$UnknownMember; /** * @public */ export declare namespace AudioStream { /** *

A blob of audio from your application. Your audio stream consists of one or more audio * events.

*

For more information, see Event stream encoding.

* @public */ interface AudioEventMember { AudioEvent: AudioEvent; ConfigurationEvent?: never; $unknown?: never; } /** *

Contains audio channel definitions and post-call analytics settings.

* @public */ interface ConfigurationEventMember { AudioEvent?: never; ConfigurationEvent: ConfigurationEvent; $unknown?: never; } /** * @public */ interface $UnknownMember { AudioEvent?: never; ConfigurationEvent?: never; $unknown: [string, any]; } interface Visitor { AudioEvent: (value: AudioEvent) => T; ConfigurationEvent: (value: ConfigurationEvent) => T; _: (name: string, value: any) => T; } const visit: (value: AudioStream, visitor: Visitor) => T; } /** *

One or more arguments to the StartStreamTranscription, * StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription * operation was not valid. For example, MediaEncoding or LanguageCode * used not valid values. Check the specified parameters and try your request again.

* @public */ export declare class BadRequestException extends __BaseException { readonly name: "BadRequestException"; readonly $fault: "client"; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType); } /** *

Contains entities identified as personally identifiable information (PII) in your * transcription output, along with various associated attributes. Examples include category, * confidence score, content, type, and start and end times.

* @public */ export interface CallAnalyticsEntity { /** *

The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.

* @public */ BeginOffsetMillis?: number; /** *

The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.

* @public */ EndOffsetMillis?: number; /** *

The category of information identified. For example, PII.

* @public */ Category?: string; /** *

The type of PII identified. For example, NAME or * CREDIT_DEBIT_NUMBER.

* @public */ Type?: string; /** *

The word or words that represent the identified entity.

* @public */ Content?: string; /** *

The confidence score associated with the identification of an entity in your transcript.

*

Confidence scores are values between 0 and 1. A larger value indicates a higher * probability that the identified entity correctly matches the entity spoken in your * media.

* @public */ Confidence?: number; } /** *

A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various * associated attributes, such as confidence score, type, and start and end times.

* @public */ export interface CallAnalyticsItem { /** *

The time, in milliseconds, from the beginning of the audio stream to the start of the identified item.

* @public */ BeginOffsetMillis?: number; /** *

The time, in milliseconds, from the beginning of the audio stream to the end of the identified item.

* @public */ EndOffsetMillis?: number; /** *

The type of item identified. Options are: PRONUNCIATION (spoken words) and * PUNCTUATION.

* @public */ Type?: ItemType; /** *

The word or punctuation that was transcribed.

* @public */ Content?: string; /** *

The confidence score associated with a word or phrase in your transcript.

*

Confidence scores are values between 0 and 1. A larger value indicates a higher * probability that the identified item correctly matches the item spoken in your media.

* @public */ Confidence?: number; /** *

Indicates whether the specified item matches a word in the vocabulary filter included in * your Call Analytics request. If true, there is a vocabulary filter match.

* @public */ VocabularyFilterMatch?: boolean; /** *

If partial result stabilization is enabled, Stable indicates whether the specified * item is stable (true) or if it may change when the segment is complete * (false).

* @public */ Stable?: boolean; } /** * @public * @enum */ export declare const CallAnalyticsLanguageCode: { readonly DE_DE: "de-DE"; readonly EN_AU: "en-AU"; readonly EN_GB: "en-GB"; readonly EN_US: "en-US"; readonly ES_US: "es-US"; readonly FR_CA: "fr-CA"; readonly FR_FR: "fr-FR"; readonly IT_IT: "it-IT"; readonly PT_BR: "pt-BR"; }; /** * @public */ export type CallAnalyticsLanguageCode = (typeof CallAnalyticsLanguageCode)[keyof typeof CallAnalyticsLanguageCode]; /** *

Contains the timestamp range (start time through end time) of a matched category.

* @public */ export interface TimestampRange { /** *

The time, in milliseconds, from the beginning of the audio stream to the start of the category * match.

* @public */ BeginOffsetMillis?: number; /** *

The time, in milliseconds, from the beginning of the audio stream to the end of the category * match.

* @public */ EndOffsetMillis?: number; } /** *

Contains the timestamps of matched categories.

* @public */ export interface PointsOfInterest { /** *

Contains the timestamp ranges (start time through end time) of matched categories and rules.

* @public */ TimestampRanges?: TimestampRange[]; } /** *

Provides information on any TranscriptFilterType categories that matched your * transcription output. Matches are identified for each segment upon completion of that segment.

* @public */ export interface CategoryEvent { /** *

Lists the categories that were matched in your audio segment.

* @public */ MatchedCategories?: string[]; /** *

Contains information about the matched categories, including category names and timestamps.

* @public */ MatchedDetails?: Record; } /** *

A new stream started with the same session ID. The current stream has been terminated.

* @public */ export declare class ConflictException extends __BaseException { readonly name: "ConflictException"; readonly $fault: "client"; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType); } /** *

A problem occurred while processing the audio. Amazon Transcribe terminated * processing.

* @public */ export declare class InternalFailureException extends __BaseException { readonly name: "InternalFailureException"; readonly $fault: "server"; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType); } /** *

Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length * limit. Break your audio stream into smaller chunks and try your request again.

* @public */ export declare class LimitExceededException extends __BaseException { readonly name: "LimitExceededException"; readonly $fault: "client"; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType); } /** *

The service is currently unavailable. Try your request later.

* @public */ export declare class ServiceUnavailableException extends __BaseException { readonly name: "ServiceUnavailableException"; readonly $fault: "server"; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType); } /** *

Provides the location, using character count, in your transcript where a match is identified. For example, * the location of an issue or a category match within a segment.

* @public */ export interface CharacterOffsets { /** *

Provides the character count of the first character where a match is identified. For example, the first * character associated with an issue or a category match in a segment transcript.

* @public */ Begin?: number; /** *

Provides the character count of the last character where a match is identified. For example, the last * character associated with an issue or a category match in a segment transcript.

* @public */ End?: number; } /** *

Lists the issues that were identified in your audio segment.

* @public */ export interface IssueDetected { /** *

Provides the timestamps that identify when in an audio segment the specified issue occurs.

* @public */ CharacterOffsets?: CharacterOffsets; } /** * @public * @enum */ export declare const Sentiment: { readonly MIXED: "MIXED"; readonly NEGATIVE: "NEGATIVE"; readonly NEUTRAL: "NEUTRAL"; readonly POSITIVE: "POSITIVE"; }; /** * @public */ export type Sentiment = (typeof Sentiment)[keyof typeof Sentiment]; /** *

Contains set of transcription results from one or more audio segments, along with additional * information about the parameters included in your request. For example, channel definitions, partial result * stabilization, sentiment, and issue detection.

* @public */ export interface UtteranceEvent { /** *

The unique identifier that is associated with the specified UtteranceEvent.

* @public */ UtteranceId?: string; /** *

Indicates whether the segment in the UtteranceEvent is complete * (FALSE) or partial (TRUE).

* @public */ IsPartial?: boolean; /** *

Provides the role of the speaker for each audio channel, either CUSTOMER or * AGENT.

* @public */ ParticipantRole?: ParticipantRole; /** *

The time, in milliseconds, from the beginning of the audio stream to the start of the * UtteranceEvent.

* @public */ BeginOffsetMillis?: number; /** *

The time, in milliseconds, from the beginning of the audio stream to the start of the * UtteranceEvent.

* @public */ EndOffsetMillis?: number; /** *

Contains transcribed text.

* @public */ Transcript?: string; /** *

Contains words, phrases, or punctuation marks that are associated with the specified * UtteranceEvent.

* @public */ Items?: CallAnalyticsItem[]; /** *

Contains entities identified as personally identifiable information (PII) in your transcription * output.

* @public */ Entities?: CallAnalyticsEntity[]; /** *

Provides the sentiment that was detected in the specified segment.

* @public */ Sentiment?: Sentiment; /** *

Provides the issue that was detected in the specified segment.

* @public */ IssuesDetected?: IssueDetected[]; } /** *

Contains detailed information about your Call Analytics streaming session. These details are * provided in the UtteranceEvent and CategoryEvent objects.

* @public */ export type CallAnalyticsTranscriptResultStream = CallAnalyticsTranscriptResultStream.BadRequestExceptionMember | CallAnalyticsTranscriptResultStream.CategoryEventMember | CallAnalyticsTranscriptResultStream.ConflictExceptionMember | CallAnalyticsTranscriptResultStream.InternalFailureExceptionMember | CallAnalyticsTranscriptResultStream.LimitExceededExceptionMember | CallAnalyticsTranscriptResultStream.ServiceUnavailableExceptionMember | CallAnalyticsTranscriptResultStream.UtteranceEventMember | CallAnalyticsTranscriptResultStream.$UnknownMember; /** * @public */ export declare namespace CallAnalyticsTranscriptResultStream { /** *

Contains set of transcription results from one or more audio segments, along with additional * information per your request parameters. This can include information relating to channel definitions, * partial result stabilization, sentiment, issue detection, and other transcription-related data.

* @public */ interface UtteranceEventMember { UtteranceEvent: UtteranceEvent; CategoryEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

Provides information on matched categories that were used to generate real-time supervisor * alerts.

* @public */ interface CategoryEventMember { UtteranceEvent?: never; CategoryEvent: CategoryEvent; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

One or more arguments to the StartStreamTranscription, * StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription * operation was not valid. For example, MediaEncoding or LanguageCode * used not valid values. Check the specified parameters and try your request again.

* @public */ interface BadRequestExceptionMember { UtteranceEvent?: never; CategoryEvent?: never; BadRequestException: BadRequestException; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length * limit. Break your audio stream into smaller chunks and try your request again.

* @public */ interface LimitExceededExceptionMember { UtteranceEvent?: never; CategoryEvent?: never; BadRequestException?: never; LimitExceededException: LimitExceededException; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A problem occurred while processing the audio. Amazon Transcribe terminated * processing.

* @public */ interface InternalFailureExceptionMember { UtteranceEvent?: never; CategoryEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException: InternalFailureException; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A new stream started with the same session ID. The current stream has been terminated.

* @public */ interface ConflictExceptionMember { UtteranceEvent?: never; CategoryEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException: ConflictException; ServiceUnavailableException?: never; $unknown?: never; } /** *

The service is currently unavailable. Try your request later.

* @public */ interface ServiceUnavailableExceptionMember { UtteranceEvent?: never; CategoryEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException: ServiceUnavailableException; $unknown?: never; } /** * @public */ interface $UnknownMember { UtteranceEvent?: never; CategoryEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown: [string, any]; } interface Visitor { UtteranceEvent: (value: UtteranceEvent) => T; CategoryEvent: (value: CategoryEvent) => T; BadRequestException: (value: BadRequestException) => T; LimitExceededException: (value: LimitExceededException) => T; InternalFailureException: (value: InternalFailureException) => T; ConflictException: (value: ConflictException) => T; ServiceUnavailableException: (value: ServiceUnavailableException) => T; _: (name: string, value: any) => T; } const visit: (value: CallAnalyticsTranscriptResultStream, visitor: Visitor) => T; } /** * @public * @enum */ export declare const ContentIdentificationType: { readonly PII: "PII"; }; /** * @public */ export type ContentIdentificationType = (typeof ContentIdentificationType)[keyof typeof ContentIdentificationType]; /** * @public * @enum */ export declare const ContentRedactionType: { readonly PII: "PII"; }; /** * @public */ export type ContentRedactionType = (typeof ContentRedactionType)[keyof typeof ContentRedactionType]; /** * @public * @enum */ export declare const LanguageCode: { readonly DE_DE: "de-DE"; readonly EN_AU: "en-AU"; readonly EN_GB: "en-GB"; readonly EN_US: "en-US"; readonly ES_US: "es-US"; readonly FR_CA: "fr-CA"; readonly FR_FR: "fr-FR"; readonly HI_IN: "hi-IN"; readonly IT_IT: "it-IT"; readonly JA_JP: "ja-JP"; readonly KO_KR: "ko-KR"; readonly PT_BR: "pt-BR"; readonly TH_TH: "th-TH"; readonly ZH_CN: "zh-CN"; }; /** * @public */ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode]; /** *

The language code that represents the language identified in your audio, including the associated * confidence score. If you enabled channel identification in your request and each channel contained a * different language, you will have more than one LanguageWithScore result.

* @public */ export interface LanguageWithScore { /** *

The language code of the identified language.

* @public */ LanguageCode?: LanguageCode; /** *

The confidence score associated with the identified language code. Confidence scores are values * between zero and one; larger values indicate a higher confidence in the identified language.

* @public */ Score?: number; } /** * @public * @enum */ export declare const MediaEncoding: { readonly FLAC: "flac"; readonly OGG_OPUS: "ogg-opus"; readonly PCM: "pcm"; }; /** * @public */ export type MediaEncoding = (typeof MediaEncoding)[keyof typeof MediaEncoding]; /** *

Contains entities identified as personal health information (PHI) in your * transcription output, along with various associated attributes. Examples include * category, confidence score, type, stability score, and start and end times.

* @public */ export interface MedicalEntity { /** *

The start time, in milliseconds, of the utterance that was identified as PHI.

* @public */ StartTime?: number; /** *

The end time, in milliseconds, of the utterance that was identified as PHI.

* @public */ EndTime?: number; /** *

The category of information identified. The only category is PHI.

* @public */ Category?: string; /** *

The word or words identified as PHI.

* @public */ Content?: string; /** *

The confidence score associated with the identified PHI entity in your audio.

*

Confidence scores are values between 0 and 1. A larger value indicates a higher * probability that the identified entity correctly matches the entity spoken in your * media.

* @public */ Confidence?: number; } /** *

A word, phrase, or punctuation mark in your transcription output, along with various * associated attributes, such as confidence score, type, and start and end times.

* @public */ export interface MedicalItem { /** *

The start time, in milliseconds, of the transcribed item.

* @public */ StartTime?: number; /** *

The end time, in milliseconds, of the transcribed item.

* @public */ EndTime?: number; /** *

The type of item identified. Options are: PRONUNCIATION (spoken * words) and PUNCTUATION.

* @public */ Type?: ItemType; /** *

The word or punctuation that was transcribed.

* @public */ Content?: string; /** *

The confidence score associated with a word or phrase in your transcript.

*

Confidence scores are values between 0 and 1. A larger value indicates a higher * probability that the identified item correctly matches the item spoken in your * media.

* @public */ Confidence?: number; /** *

If speaker partitioning is enabled, Speaker labels the speaker of the * specified item.

* @public */ Speaker?: string; } /** *

A list of possible alternative transcriptions for the input audio. Each alternative may * contain one or more of Items, Entities, or * Transcript.

* @public */ export interface MedicalAlternative { /** *

Contains transcribed text.

* @public */ Transcript?: string; /** *

Contains words, phrases, or punctuation marks in your transcription output.

* @public */ Items?: MedicalItem[]; /** *

Contains entities identified as personal health information (PHI) in your transcription * output.

* @public */ Entities?: MedicalEntity[]; } /** * @public * @enum */ export declare const MedicalContentIdentificationType: { readonly PHI: "PHI"; }; /** * @public */ export type MedicalContentIdentificationType = (typeof MedicalContentIdentificationType)[keyof typeof MedicalContentIdentificationType]; /** *

The Result associated with a * .

*

Contains a set of transcription results from one or more audio segments, along with * additional information per your request parameters. This can include information relating to * alternative transcriptions, channel identification, partial result stabilization, language * identification, and other transcription-related data.

* @public */ export interface MedicalResult { /** *

Provides a unique identifier for the Result.

* @public */ ResultId?: string; /** *

The start time, in milliseconds, of the Result.

* @public */ StartTime?: number; /** *

The end time, in milliseconds, of the Result.

* @public */ EndTime?: number; /** *

Indicates if the segment is complete.

*

If IsPartial is true, the segment is not complete. If * IsPartial is false, the segment is complete.

* @public */ IsPartial?: boolean; /** *

A list of possible alternative transcriptions for the input audio. Each alternative may * contain one or more of Items, Entities, or * Transcript.

* @public */ Alternatives?: MedicalAlternative[]; /** *

Indicates the channel identified for the Result.

* @public */ ChannelId?: string; } /** *

The MedicalTranscript associated with a * .

*

* MedicalTranscript contains Results, which contains a set of * transcription results from one or more audio segments, along with additional information per your * request parameters.

* @public */ export interface MedicalTranscript { /** *

Contains a set of transcription results from one or more audio segments, along with * additional information per your request parameters. This can include information relating to * alternative transcriptions, channel identification, partial result stabilization, language * identification, and other transcription-related data.

* @public */ Results?: MedicalResult[]; } /** *

The MedicalTranscriptEvent associated with a * MedicalTranscriptResultStream.

*

Contains a set of transcription results from one or more audio segments, along with additional * information per your request parameters.

* @public */ export interface MedicalTranscriptEvent { /** *

Contains Results, which contains a set of transcription results from one or * more audio segments, along with additional information per your request parameters. This can * include information relating to alternative transcriptions, channel identification, partial result * stabilization, language identification, and other transcription-related data.

* @public */ Transcript?: MedicalTranscript; } /** *

Contains detailed information about your streaming session.

* @public */ export type MedicalTranscriptResultStream = MedicalTranscriptResultStream.BadRequestExceptionMember | MedicalTranscriptResultStream.ConflictExceptionMember | MedicalTranscriptResultStream.InternalFailureExceptionMember | MedicalTranscriptResultStream.LimitExceededExceptionMember | MedicalTranscriptResultStream.ServiceUnavailableExceptionMember | MedicalTranscriptResultStream.TranscriptEventMember | MedicalTranscriptResultStream.$UnknownMember; /** * @public */ export declare namespace MedicalTranscriptResultStream { /** *

The MedicalTranscriptEvent associated with a * MedicalTranscriptResultStream.

*

Contains a set of transcription results from one or more audio segments, along with * additional information per your request parameters. This can include information relating to * alternative transcriptions, channel identification, partial result stabilization, language * identification, and other transcription-related data.

* @public */ interface TranscriptEventMember { TranscriptEvent: MedicalTranscriptEvent; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

One or more arguments to the StartStreamTranscription, * StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription * operation was not valid. For example, MediaEncoding or LanguageCode * used not valid values. Check the specified parameters and try your request again.

* @public */ interface BadRequestExceptionMember { TranscriptEvent?: never; BadRequestException: BadRequestException; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length * limit. Break your audio stream into smaller chunks and try your request again.

* @public */ interface LimitExceededExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException: LimitExceededException; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A problem occurred while processing the audio. Amazon Transcribe terminated * processing.

* @public */ interface InternalFailureExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException: InternalFailureException; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A new stream started with the same session ID. The current stream has been terminated.

* @public */ interface ConflictExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException: ConflictException; ServiceUnavailableException?: never; $unknown?: never; } /** *

The service is currently unavailable. Try your request later.

* @public */ interface ServiceUnavailableExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException: ServiceUnavailableException; $unknown?: never; } /** * @public */ interface $UnknownMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown: [string, any]; } interface Visitor { TranscriptEvent: (value: MedicalTranscriptEvent) => T; BadRequestException: (value: BadRequestException) => T; LimitExceededException: (value: LimitExceededException) => T; InternalFailureException: (value: InternalFailureException) => T; ConflictException: (value: ConflictException) => T; ServiceUnavailableException: (value: ServiceUnavailableException) => T; _: (name: string, value: any) => T; } const visit: (value: MedicalTranscriptResultStream, visitor: Visitor) => T; } /** * @public * @enum */ export declare const PartialResultsStability: { readonly HIGH: "high"; readonly LOW: "low"; readonly MEDIUM: "medium"; }; /** * @public */ export type PartialResultsStability = (typeof PartialResultsStability)[keyof typeof PartialResultsStability]; /** *

The Result associated with a * .

*

Contains a set of transcription results from one or more audio segments, along with additional * information per your request parameters. This can include information relating to alternative * transcriptions, channel identification, partial result stabilization, language identification, and other * transcription-related data.

* @public */ export interface Result { /** *

Provides a unique identifier for the Result.

* @public */ ResultId?: string; /** *

The start time, in milliseconds, of the Result.

* @public */ StartTime?: number; /** *

The end time, in milliseconds, of the Result.

* @public */ EndTime?: number; /** *

Indicates if the segment is complete.

*

If IsPartial is true, the segment is not complete. If * IsPartial is false, the segment is complete.

* @public */ IsPartial?: boolean; /** *

A list of possible alternative transcriptions for the input audio. Each alternative may contain * one or more of Items, Entities, or Transcript.

* @public */ Alternatives?: Alternative[]; /** *

Indicates which audio channel is associated with the Result.

* @public */ ChannelId?: string; /** *

The language code that represents the language spoken in your audio stream.

* @public */ LanguageCode?: LanguageCode; /** *

The language code of the dominant language identified in your stream.

*

If you enabled channel identification and each channel of your audio contains a different language, * you may have more than one result.

* @public */ LanguageIdentification?: LanguageWithScore[]; } /** * @public * @enum */ export declare const Specialty: { readonly CARDIOLOGY: "CARDIOLOGY"; readonly NEUROLOGY: "NEUROLOGY"; readonly ONCOLOGY: "ONCOLOGY"; readonly PRIMARYCARE: "PRIMARYCARE"; readonly RADIOLOGY: "RADIOLOGY"; readonly UROLOGY: "UROLOGY"; }; /** * @public */ export type Specialty = (typeof Specialty)[keyof typeof Specialty]; /** * @public * @enum */ export declare const VocabularyFilterMethod: { readonly MASK: "mask"; readonly REMOVE: "remove"; readonly TAG: "tag"; }; /** * @public */ export type VocabularyFilterMethod = (typeof VocabularyFilterMethod)[keyof typeof VocabularyFilterMethod]; /** * @public */ export interface StartCallAnalyticsStreamTranscriptionRequest { /** *

Specify the language code that represents the language spoken in your audio.

*

If you're unsure of the language spoken in your audio, consider using * IdentifyLanguage to enable automatic language identification.

*

For a list of languages supported with streaming Call Analytics, refer to the * Supported * languages table.

* @public */ LanguageCode: CallAnalyticsLanguageCode | undefined; /** *

The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, * is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. * Note that the sample rate you specify must match that of your audio.

* @public */ MediaSampleRateHertz: number | undefined; /** *

Specify the encoding of your input audio. Supported formats are:

*
    *
  • *

    FLAC

    *
    • *
  • *

    OPUS-encoded audio in an Ogg container

    *
    • *
  • *

    PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

    *
    • *
*

For more information, see Media formats.

* @public */ MediaEncoding: MediaEncoding | undefined; /** *

Specify the name of the custom vocabulary that you want to use when processing your * transcription. Note that vocabulary names are case sensitive.

*

If the language of the specified custom vocabulary doesn't match the language identified in * your media, the custom vocabulary is not applied to your transcription.

*

For more information, see Custom vocabularies.

* @public */ VocabularyName?: string; /** *

Specify a name for your Call Analytics transcription session. If you don't include this parameter * in your request, Amazon Transcribe generates an ID and returns it in the response.

*

You can use a session ID to retry a streaming session.

* @public */ SessionId?: string; /** *

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket * data frames.

*

For more information, see Transcribing streaming audio.

* @public */ AudioStream: AsyncIterable | undefined; /** *

Specify the name of the custom vocabulary filter that you want to use when processing your * transcription. Note that vocabulary filter names are case sensitive.

*

If the language of the specified custom vocabulary filter doesn't match the language identified in * your media, the vocabulary filter is not applied to your transcription.

*

For more information, see Using vocabulary filtering with unwanted * words.

* @public */ VocabularyFilterName?: string; /** *

Specify how you want your vocabulary filter applied to your transcript.

*

To replace words with ***, choose mask.

*

To delete words, choose remove.

*

To flag words without changing them, choose tag.

* @public */ VocabularyFilterMethod?: VocabularyFilterMethod; /** *

Specify the name of the custom language model that you want to use when processing your * transcription. Note that language model names are case sensitive.

*

The language of the specified language model must match the language code you specify * in your transcription request. If the languages don't match, the custom language model isn't applied. * There are no errors or warnings associated with a language mismatch.

*

For more information, see Custom language models.

* @public */ LanguageModelName?: string; /** *

Enables partial result stabilization for your transcription. Partial result stabilization can reduce * latency in your output, but may impact accuracy. For more information, see * Partial-result * stabilization.

* @public */ EnablePartialResultsStabilization?: boolean; /** *

Specify the level of stability to use when you enable partial results stabilization * (EnablePartialResultsStabilization).

*

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly * lower accuracy.

*

For more information, see Partial-result * stabilization.

* @public */ PartialResultsStability?: PartialResultsStability; /** *

Labels all personally identifiable information (PII) identified in your transcript.

*

Content identification is performed at the segment level; PII specified in * PiiEntityTypes is flagged upon complete transcription of an audio segment.

*

You can’t set ContentIdentificationType and ContentRedactionType * in the same request. If you set both, your request returns a * BadRequestException.

*

For more information, see Redacting or identifying personally identifiable * information.

* @public */ ContentIdentificationType?: ContentIdentificationType; /** *

Redacts all personally identifiable information (PII) identified in your transcript.

*

Content redaction is performed at the segment level; PII specified in * PiiEntityTypes is redacted upon complete transcription of an audio segment.

*

You can’t set ContentRedactionType and ContentIdentificationType * in the same request. If you set both, your request returns a * BadRequestException.

*

For more information, see Redacting or identifying personally identifiable * information.

* @public */ ContentRedactionType?: ContentRedactionType; /** *

Specify which types of personally identifiable information (PII) you want to redact in your * transcript. You can include as many types as you'd like, or you can select * ALL.

*

To include PiiEntityTypes in your Call Analytics request, you must also include * either ContentIdentificationType or ContentRedactionType.

*

Values must be comma-separated and can include: * BANK_ACCOUNT_NUMBER, BANK_ROUTING, * CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, * CREDIT_DEBIT_EXPIRY, PIN, EMAIL, * ADDRESS, NAME, PHONE, * SSN, or ALL.

* @public */ PiiEntityTypes?: string; } /** * @public */ export interface StartCallAnalyticsStreamTranscriptionResponse { /** *

Provides the identifier for your Call Analytics streaming request.

* @public */ RequestId?: string; /** *

Provides the language code that you specified in your Call Analytics request.

* @public */ LanguageCode?: CallAnalyticsLanguageCode; /** *

Provides the sample rate that you specified in your Call Analytics request.

* @public */ MediaSampleRateHertz?: number; /** *

Provides the media encoding you specified in your Call Analytics request.

* @public */ MediaEncoding?: MediaEncoding; /** *

Provides the name of the custom vocabulary that you specified in your Call Analytics request.

* @public */ VocabularyName?: string; /** *

Provides the identifier for your Call Analytics transcription session.

* @public */ SessionId?: string; /** *

Provides detailed information about your Call Analytics streaming session.

* @public */ CallAnalyticsTranscriptResultStream?: AsyncIterable; /** *

Provides the name of the custom vocabulary filter that you specified in your Call Analytics * request.

* @public */ VocabularyFilterName?: string; /** *

Provides the vocabulary filtering method used in your Call Analytics transcription.

* @public */ VocabularyFilterMethod?: VocabularyFilterMethod; /** *

Provides the name of the custom language model that you specified in your Call Analytics * request.

* @public */ LanguageModelName?: string; /** *

Shows whether partial results stabilization was enabled for your Call Analytics transcription.

* @public */ EnablePartialResultsStabilization?: boolean; /** *

Provides the stabilization level used for your transcription.

* @public */ PartialResultsStability?: PartialResultsStability; /** *

Shows whether content identification was enabled for your Call Analytics transcription.

* @public */ ContentIdentificationType?: ContentIdentificationType; /** *

Shows whether content redaction was enabled for your Call Analytics transcription.

* @public */ ContentRedactionType?: ContentRedactionType; /** *

Lists the PII entity types you specified in your Call Analytics request.

* @public */ PiiEntityTypes?: string; } /** * @public * @enum */ export declare const Type: { readonly CONVERSATION: "CONVERSATION"; readonly DICTATION: "DICTATION"; }; /** * @public */ export type Type = (typeof Type)[keyof typeof Type]; /** * @public */ export interface StartMedicalStreamTranscriptionRequest { /** *

Specify the language code that represents the language spoken in your audio.

* *

Amazon Transcribe Medical only supports US English (en-US).

* * @public */ LanguageCode: LanguageCode | undefined; /** *

The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a * range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that * of your audio.

* @public */ MediaSampleRateHertz: number | undefined; /** *

Specify the encoding used for the input audio. Supported formats are:

*
    *
  • *

    FLAC

    *
    • *
  • *

    OPUS-encoded audio in an Ogg container

    *
    • *
  • *

    PCM (only signed 16-bit little-endian audio formats, which does not include * WAV)

    *
    • *
*

For more information, see Media formats.

* @public */ MediaEncoding: MediaEncoding | undefined; /** *

Specify the name of the custom vocabulary that you want to use when processing your * transcription. Note that vocabulary names are case sensitive.

* @public */ VocabularyName?: string; /** *

Specify the medical specialty contained in your audio.

* @public */ Specialty: Specialty | undefined; /** *

Specify the type of input audio. For example, choose DICTATION for a * provider dictating patient notes and CONVERSATION for a dialogue between a * patient and a medical professional.

* @public */ Type: Type | undefined; /** *

Enables speaker partitioning (diarization) in your transcription output. Speaker * partitioning labels the speech from individual speakers in your media file.

*

For more information, see Partitioning speakers (diarization).

* @public */ ShowSpeakerLabel?: boolean; /** *

Specify a name for your transcription session. If you don't include this parameter in * your request, Amazon Transcribe Medical generates an ID and returns it in the * response.

*

You can use a session ID to retry a streaming session.

* @public */ SessionId?: string; /** *

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket * data frames.

*

For more information, see Transcribing streaming audio.

* @public */ AudioStream: AsyncIterable | undefined; /** *

Enables channel identification in multi-channel audio.

*

Channel identification transcribes the audio on each channel independently, then appends * the output for each channel into one transcript.

*

If you have multi-channel audio and do not enable channel identification, your audio is * transcribed in a continuous manner and your transcript is not separated by channel.

*

For more information, see Transcribing multi-channel audio.

* @public */ EnableChannelIdentification?: boolean; /** *

Specify the number of channels in your audio stream. Up to two channels are * supported.

* @public */ NumberOfChannels?: number; /** *

Labels all personal health information (PHI) identified in your transcript.

*

Content identification is performed at the segment level; PHI is flagged upon complete * transcription of an audio segment.

*

For more information, see Identifying personal health information (PHI) in a * transcription.

* @public */ ContentIdentificationType?: MedicalContentIdentificationType; } /** * @public */ export interface StartMedicalStreamTranscriptionResponse { /** *

Provides the identifier for your streaming request.

* @public */ RequestId?: string; /** *

Provides the language code that you specified in your request. This must be * en-US.

* @public */ LanguageCode?: LanguageCode; /** *

Provides the sample rate that you specified in your request.

* @public */ MediaSampleRateHertz?: number; /** *

Provides the media encoding you specified in your request.

* @public */ MediaEncoding?: MediaEncoding; /** *

Provides the name of the custom vocabulary that you specified in your request.

* @public */ VocabularyName?: string; /** *

Provides the medical specialty that you specified in your request.

* @public */ Specialty?: Specialty; /** *

Provides the type of audio you specified in your request.

* @public */ Type?: Type; /** *

Shows whether speaker partitioning was enabled for your transcription.

* @public */ ShowSpeakerLabel?: boolean; /** *

Provides the identifier for your transcription session.

* @public */ SessionId?: string; /** *

Provides detailed information about your streaming session.

* @public */ TranscriptResultStream?: AsyncIterable; /** *

Shows whether channel identification was enabled for your transcription.

* @public */ EnableChannelIdentification?: boolean; /** *

Provides the number of channels that you specified in your request.

* @public */ NumberOfChannels?: number; /** *

Shows whether content identification was enabled for your transcription.

* @public */ ContentIdentificationType?: MedicalContentIdentificationType; } /** * @public */ export interface StartStreamTranscriptionRequest { /** *

Specify the language code that represents the language spoken in your audio.

*

If you're unsure of the language spoken in your audio, consider using * IdentifyLanguage to enable automatic language identification.

*

For a list of languages supported with Amazon Transcribe streaming, refer to the * Supported * languages table.

* @public */ LanguageCode?: LanguageCode; /** *

The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, * is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. * Note that the sample rate you specify must match that of your audio.

* @public */ MediaSampleRateHertz: number | undefined; /** *

Specify the encoding of your input audio. Supported formats are:

*
    *
  • *

    FLAC

    *
    • *
  • *

    OPUS-encoded audio in an Ogg container

    *
    • *
  • *

    PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

    *
    • *
*

For more information, see Media formats.

* @public */ MediaEncoding: MediaEncoding | undefined; /** *

Specify the name of the custom vocabulary that you want to use when processing your * transcription. Note that vocabulary names are case sensitive.

*

If the language of the specified custom vocabulary doesn't match the language identified in * your media, the custom vocabulary is not applied to your transcription.

* *

This parameter is not intended for use with the * IdentifyLanguage parameter. If you're including IdentifyLanguage * in your request and want to use one or more custom vocabularies with your transcription, use * the VocabularyNames parameter instead.

* *

For more information, see Custom vocabularies.

* @public */ VocabularyName?: string; /** *

Specify a name for your transcription session. If you don't include this parameter in your request, * Amazon Transcribe generates an ID and returns it in the response.

*

You can use a session ID to retry a streaming session.

* @public */ SessionId?: string; /** *

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket * data frames.

*

For more information, see Transcribing streaming audio.

* @public */ AudioStream: AsyncIterable | undefined; /** *

Specify the name of the custom vocabulary filter that you want to use when processing your * transcription. Note that vocabulary filter names are case sensitive.

*

If the language of the specified custom vocabulary filter doesn't match the language identified in * your media, the vocabulary filter is not applied to your transcription.

* *

This parameter is not intended for use with the * IdentifyLanguage parameter. If you're including IdentifyLanguage * in your request and want to use one or more vocabulary filters with your transcription, use * the VocabularyFilterNames parameter instead.

* *

For more information, see Using vocabulary filtering with unwanted * words.

* @public */ VocabularyFilterName?: string; /** *

Specify how you want your vocabulary filter applied to your transcript.

*

To replace words with ***, choose mask.

*

To delete words, choose remove.

*

To flag words without changing them, choose tag.

* @public */ VocabularyFilterMethod?: VocabularyFilterMethod; /** *

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning * labels the speech from individual speakers in your media file.

*

For more information, see Partitioning speakers (diarization).

* @public */ ShowSpeakerLabel?: boolean; /** *

Enables channel identification in multi-channel audio.

*

Channel identification transcribes the audio on each channel independently, then appends the * output for each channel into one transcript.

*

If you have multi-channel audio and do not enable channel identification, your audio is * transcribed in a continuous manner and your transcript is not separated by channel.

*

For more information, see Transcribing multi-channel audio.

* @public */ EnableChannelIdentification?: boolean; /** *

Specify the number of channels in your audio stream. Up to two channels are * supported.

* @public */ NumberOfChannels?: number; /** *

Enables partial result stabilization for your transcription. Partial result stabilization can reduce * latency in your output, but may impact accuracy. For more information, see * Partial-result * stabilization.

* @public */ EnablePartialResultsStabilization?: boolean; /** *

Specify the level of stability to use when you enable partial results stabilization * (EnablePartialResultsStabilization).

*

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly * lower accuracy.

*

For more information, see Partial-result * stabilization.

* @public */ PartialResultsStability?: PartialResultsStability; /** *

Labels all personally identifiable information (PII) identified in your transcript.

*

Content identification is performed at the segment level; PII specified in * PiiEntityTypes is flagged upon complete transcription of an audio segment.

*

You can’t set ContentIdentificationType and ContentRedactionType * in the same request. If you set both, your request returns a * BadRequestException.

*

For more information, see Redacting or identifying personally identifiable * information.

* @public */ ContentIdentificationType?: ContentIdentificationType; /** *

Redacts all personally identifiable information (PII) identified in your transcript.

*

Content redaction is performed at the segment level; PII specified in * PiiEntityTypes is redacted upon complete transcription of an audio segment.

*

You can’t set ContentRedactionType and ContentIdentificationType * in the same request. If you set both, your request returns a * BadRequestException.

*

For more information, see Redacting or identifying personally identifiable * information.

* @public */ ContentRedactionType?: ContentRedactionType; /** *

Specify which types of personally identifiable information (PII) you want to redact in your * transcript. You can include as many types as you'd like, or you can select * ALL.

*

To include PiiEntityTypes in your request, you must also include either * ContentIdentificationType or ContentRedactionType.

*

Values must be comma-separated and can include: * BANK_ACCOUNT_NUMBER, BANK_ROUTING, * CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, * CREDIT_DEBIT_EXPIRY, PIN, EMAIL, * ADDRESS, NAME, PHONE, * SSN, or ALL.

* @public */ PiiEntityTypes?: string; /** *

Specify the name of the custom language model that you want to use when processing your * transcription. Note that language model names are case sensitive.

*

The language of the specified language model must match the language code you specify * in your transcription request. If the languages don't match, the custom language model isn't applied. * There are no errors or warnings associated with a language mismatch.

*

For more information, see Custom language models.

* @public */ LanguageModelName?: string; /** *

Enables automatic language identification for your transcription.

*

If you include IdentifyLanguage, you can optionally include a list of * language codes, using LanguageOptions, that you think may be present in * your audio stream. Including language options can improve transcription accuracy.

*

You can also include a preferred language using PreferredLanguage. Adding a * preferred language can help Amazon Transcribe identify the language faster than if you omit this * parameter.

*

If you have multi-channel audio that contains different languages on each channel, and you've * enabled channel identification, automatic language identification identifies the dominant language on * each audio channel.

*

Note that you must include either LanguageCode or * IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job * fails.

*

Streaming language identification can't be combined with custom language models or * redaction.

* @public */ IdentifyLanguage?: boolean; /** *

Specify two or more language codes that represent the languages you think may be present * in your media; including more than five is not recommended. If you're unsure what languages are present, do * not include this parameter.

*

Including language options can improve the accuracy of language identification.

*

If you include LanguageOptions in your request, you must also include * IdentifyLanguage.

*

For a list of languages supported with Amazon Transcribe streaming, refer to the * Supported * languages table.

* *

You can only include one language dialect per language per stream. For example, you * cannot include en-US and en-AU in the same request.

* * @public */ LanguageOptions?: string; /** *

Specify a preferred language from the subset of languages codes you specified in * LanguageOptions.

*

You can only use this parameter if you've included IdentifyLanguage and * LanguageOptions in your request.

* @public */ PreferredLanguage?: LanguageCode; /** *

Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

*

If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your stream. Including LanguageOptions restricts IdentifyMultipleLanguages to only the language options that you specify, which can improve transcription accuracy.

*

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

*

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

* @public */ IdentifyMultipleLanguages?: boolean; /** *

Specify the names of the custom vocabularies that you want to use when processing your * transcription. Note that vocabulary names are case sensitive.

*

If none of the languages of the specified custom vocabularies match the language identified in * your media, your job fails.

* *

This parameter is only intended for use with the * IdentifyLanguage parameter. If you're not * including IdentifyLanguage in your request and want to use a custom vocabulary * with your transcription, use the VocabularyName parameter instead.

* *

For more information, see Custom vocabularies.

* @public */ VocabularyNames?: string; /** *

Specify the names of the custom vocabulary filters that you want to use when processing * your transcription. Note that vocabulary filter names are case sensitive.

*

If none of the languages of the specified custom vocabulary filters match the language identified * in your media, your job fails.

* *

This parameter is only intended for use with * the IdentifyLanguage parameter. If you're not * including IdentifyLanguage in your request and want to use a custom vocabulary filter * with your transcription, use the VocabularyFilterName parameter instead.

* *

For more information, see Using vocabulary filtering with unwanted * words.

* @public */ VocabularyFilterNames?: string; } /** *

The Transcript associated with a * .

*

* Transcript contains Results, which contains a set of transcription * results from one or more audio segments, along with additional information per your request * parameters.

* @public */ export interface Transcript { /** *

Contains a set of transcription results from one or more audio segments, along with additional * information per your request parameters. This can include information relating to alternative * transcriptions, channel identification, partial result stabilization, language identification, and other * transcription-related data.

* @public */ Results?: Result[]; } /** *

The TranscriptEvent associated with a * TranscriptResultStream.

*

Contains a set of transcription results from one or more audio segments, along with additional * information per your request parameters.

* @public */ export interface TranscriptEvent { /** *

Contains Results, which contains a set of transcription results from one or * more audio segments, along with additional information per your request parameters. This can * include information relating to alternative transcriptions, channel identification, partial * result stabilization, language identification, and other transcription-related data.

* @public */ Transcript?: Transcript; } /** *

Contains detailed information about your streaming session.

* @public */ export type TranscriptResultStream = TranscriptResultStream.BadRequestExceptionMember | TranscriptResultStream.ConflictExceptionMember | TranscriptResultStream.InternalFailureExceptionMember | TranscriptResultStream.LimitExceededExceptionMember | TranscriptResultStream.ServiceUnavailableExceptionMember | TranscriptResultStream.TranscriptEventMember | TranscriptResultStream.$UnknownMember; /** * @public */ export declare namespace TranscriptResultStream { /** *

Contains Transcript, which contains Results. The * object contains a set of transcription * results from one or more audio segments, along with additional information per your request * parameters.

* @public */ interface TranscriptEventMember { TranscriptEvent: TranscriptEvent; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A client error occurred when the stream was created. Check the parameters of the request * and try your request again.

* @public */ interface BadRequestExceptionMember { TranscriptEvent?: never; BadRequestException: BadRequestException; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length * limit. Break your audio stream into smaller chunks and try your request again.

* @public */ interface LimitExceededExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException: LimitExceededException; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A problem occurred while processing the audio. Amazon Transcribe terminated * processing.

* @public */ interface InternalFailureExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException: InternalFailureException; ConflictException?: never; ServiceUnavailableException?: never; $unknown?: never; } /** *

A new stream started with the same session ID. The current stream has been * terminated.

* @public */ interface ConflictExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException: ConflictException; ServiceUnavailableException?: never; $unknown?: never; } /** *

The service is currently unavailable. Try your request later.

* @public */ interface ServiceUnavailableExceptionMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException: ServiceUnavailableException; $unknown?: never; } /** * @public */ interface $UnknownMember { TranscriptEvent?: never; BadRequestException?: never; LimitExceededException?: never; InternalFailureException?: never; ConflictException?: never; ServiceUnavailableException?: never; $unknown: [string, any]; } interface Visitor { TranscriptEvent: (value: TranscriptEvent) => T; BadRequestException: (value: BadRequestException) => T; LimitExceededException: (value: LimitExceededException) => T; InternalFailureException: (value: InternalFailureException) => T; ConflictException: (value: ConflictException) => T; ServiceUnavailableException: (value: ServiceUnavailableException) => T; _: (name: string, value: any) => T; } const visit: (value: TranscriptResultStream, visitor: Visitor) => T; } /** * @public */ export interface StartStreamTranscriptionResponse { /** *

Provides the identifier for your streaming request.

* @public */ RequestId?: string; /** *

Provides the language code that you specified in your request.

* @public */ LanguageCode?: LanguageCode; /** *

Provides the sample rate that you specified in your request.

* @public */ MediaSampleRateHertz?: number; /** *

Provides the media encoding you specified in your request.

* @public */ MediaEncoding?: MediaEncoding; /** *

Provides the name of the custom vocabulary that you specified in your request.

* @public */ VocabularyName?: string; /** *

Provides the identifier for your transcription session.

* @public */ SessionId?: string; /** *

Provides detailed information about your streaming session.

* @public */ TranscriptResultStream?: AsyncIterable; /** *

Provides the name of the custom vocabulary filter that you specified in your * request.

* @public */ VocabularyFilterName?: string; /** *

Provides the vocabulary filtering method used in your transcription.

* @public */ VocabularyFilterMethod?: VocabularyFilterMethod; /** *

Shows whether speaker partitioning was enabled for your transcription.

* @public */ ShowSpeakerLabel?: boolean; /** *

Shows whether channel identification was enabled for your transcription.

* @public */ EnableChannelIdentification?: boolean; /** *

Provides the number of channels that you specified in your request.

* @public */ NumberOfChannels?: number; /** *

Shows whether partial results stabilization was enabled for your transcription.

* @public */ EnablePartialResultsStabilization?: boolean; /** *

Provides the stabilization level used for your transcription.

* @public */ PartialResultsStability?: PartialResultsStability; /** *

Shows whether content identification was enabled for your transcription.

* @public */ ContentIdentificationType?: ContentIdentificationType; /** *

Shows whether content redaction was enabled for your transcription.

* @public */ ContentRedactionType?: ContentRedactionType; /** *

Lists the PII entity types you specified in your request.

* @public */ PiiEntityTypes?: string; /** *

Provides the name of the custom language model that you specified in your request.

* @public */ LanguageModelName?: string; /** *

Shows whether automatic language identification was enabled for your * transcription.

* @public */ IdentifyLanguage?: boolean; /** *

Provides the language codes that you specified in your request.

* @public */ LanguageOptions?: string; /** *

Provides the preferred language that you specified in your request.

* @public */ PreferredLanguage?: LanguageCode; /** *

Shows whether automatic multi-language identification was enabled for your transcription.

* @public */ IdentifyMultipleLanguages?: boolean; /** *

Provides the names of the custom vocabularies that you specified in your request.

* @public */ VocabularyNames?: string; /** *

Provides the names of the custom vocabulary filters that you specified in your * request.

* @public */ VocabularyFilterNames?: string; } /** * @internal */ export declare const AudioStreamFilterSensitiveLog: (obj: AudioStream) => any; /** * @internal */ export declare const CallAnalyticsTranscriptResultStreamFilterSensitiveLog: (obj: CallAnalyticsTranscriptResultStream) => any; /** * @internal */ export declare const MedicalTranscriptResultStreamFilterSensitiveLog: (obj: MedicalTranscriptResultStream) => any; /** * @internal */ export declare const StartCallAnalyticsStreamTranscriptionRequestFilterSensitiveLog: (obj: StartCallAnalyticsStreamTranscriptionRequest) => any; /** * @internal */ export declare const StartCallAnalyticsStreamTranscriptionResponseFilterSensitiveLog: (obj: StartCallAnalyticsStreamTranscriptionResponse) => any; /** * @internal */ export declare const StartMedicalStreamTranscriptionRequestFilterSensitiveLog: (obj: StartMedicalStreamTranscriptionRequest) => any; /** * @internal */ export declare const StartMedicalStreamTranscriptionResponseFilterSensitiveLog: (obj: StartMedicalStreamTranscriptionResponse) => any; /** * @internal */ export declare const StartStreamTranscriptionRequestFilterSensitiveLog: (obj: StartStreamTranscriptionRequest) => any; /** * @internal */ export declare const TranscriptResultStreamFilterSensitiveLog: (obj: TranscriptResultStream) => any; /** * @internal */ export declare const StartStreamTranscriptionResponseFilterSensitiveLog: (obj: StartStreamTranscriptionResponse) => any;