codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of transcribestreaming Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-10-26",
"endpointPrefix":"transcribestreaming",
"protocol":"rest-json",
"protocolSettings":{"h2":"eventstream"},
"serviceFullName":"Amazon Transcribe Streaming Service",
"serviceId":"Transcribe Streaming",
"signatureVersion":"v4",
"signingName":"transcribe",
"uid":"transcribe-streaming-2017-10-26"
},
"operations":{
"StartMedicalStreamTranscription":{
"name":"StartMedicalStreamTranscription",
"http":{
"method":"POST",
"requestUri":"/medical-stream-transcription"
},
"input":{"shape":"StartMedicalStreamTranscriptionRequest"},
"output":{"shape":"StartMedicalStreamTranscriptionResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"ConflictException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
"
},
"StartStreamTranscription":{
"name":"StartStreamTranscription",
"http":{
"method":"POST",
"requestUri":"/stream-transcription"
},
"input":{"shape":"StartStreamTranscriptionRequest"},
"output":{"shape":"StartStreamTranscriptionResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"ConflictException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"Starts a bidirectional HTTP2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
The following are encoded as HTTP2 headers:
-
x-amzn-transcribe-language-code
-
x-amzn-transcribe-media-encoding
-
x-amzn-transcribe-sample-rate
-
x-amzn-transcribe-session-id
"
}
},
"shapes":{
"Alternative":{
"type":"structure",
"members":{
"Transcript":{
"shape":"String",
"documentation":"The text that was transcribed from the audio.
"
},
"Items":{
"shape":"ItemList",
"documentation":"One or more alternative interpretations of the input audio.
"
}
},
"documentation":"A list of possible transcriptions for the audio.
"
},
"AlternativeList":{
"type":"list",
"member":{"shape":"Alternative"}
},
"AudioChunk":{"type":"blob"},
"AudioEvent":{
"type":"structure",
"members":{
"AudioChunk":{
"shape":"AudioChunk",
"documentation":"An audio blob that contains the next part of the audio that you want to transcribe.
",
"eventpayload":true
}
},
"documentation":"Provides a wrapper for the audio chunks that you are sending.
",
"event":true
},
"AudioStream":{
"type":"structure",
"members":{
"AudioEvent":{
"shape":"AudioEvent",
"documentation":"A blob of audio from your application. You audio stream consists of one or more audio events.
"
}
},
"documentation":"Represents the audio stream from your application to Amazon Transcribe.
",
"eventstream":true
},
"BadRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription operation was invalid. For example, MediaEncoding was not set to a valid encoding, or LanguageCode was not set to a valid code. Check the parameters and try your request again.
",
"error":{"httpStatusCode":400},
"exception":true
},
"Boolean":{"type":"boolean"},
"Confidence":{"type":"double"},
"ConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"A new stream started with the same session ID. The current stream has been terminated.
",
"error":{"httpStatusCode":409},
"exception":true
},
"Double":{"type":"double"},
"InternalFailureException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try your request again.
",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"Item":{
"type":"structure",
"members":{
"StartTime":{
"shape":"Double",
"documentation":"The offset from the beginning of the audio stream to the beginning of the audio that resulted in the item.
"
},
"EndTime":{
"shape":"Double",
"documentation":"The offset from the beginning of the audio stream to the end of the audio that resulted in the item.
"
},
"Type":{
"shape":"ItemType",
"documentation":"The type of the item. PRONUNCIATION indicates that the item is a word that was recognized in the input audio. PUNCTUATION indicates that the item was interpreted as a pause in the input audio.
"
},
"Content":{
"shape":"String",
"documentation":"The word or punctuation that was recognized in the input audio.
"
},
"VocabularyFilterMatch":{
"shape":"Boolean",
"documentation":"Indicates whether a word in the item matches a word in the vocabulary filter you've chosen for your real-time stream. If true then a word in the item matches your vocabulary filter.
"
},
"Speaker":{
"shape":"String",
"documentation":"If speaker identification is enabled, shows the speakers identified in the real-time stream.
"
}
},
"documentation":"A word or phrase transcribed from the input audio.
"
},
"ItemList":{
"type":"list",
"member":{"shape":"Item"}
},
"ItemType":{
"type":"string",
"enum":[
"pronunciation",
"punctuation"
]
},
"LanguageCode":{
"type":"string",
"enum":[
"en-US",
"en-GB",
"es-US",
"fr-CA",
"fr-FR",
"en-AU",
"it-IT",
"de-DE",
"pt-BR",
"ja-JP",
"ko-KR"
]
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"You have exceeded the maximum number of concurrent transcription streams, are starting transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream has finished processing, or break your audio stream into smaller chunks and try your request again.
",
"error":{"httpStatusCode":429},
"exception":true
},
"MediaEncoding":{
"type":"string",
"enum":[
"pcm",
"ogg-opus",
"flac"
]
},
"MediaSampleRateHertz":{
"type":"integer",
"max":48000,
"min":8000
},
"MedicalAlternative":{
"type":"structure",
"members":{
"Transcript":{
"shape":"String",
"documentation":"The text that was transcribed from the audio.
"
},
"Items":{
"shape":"MedicalItemList",
"documentation":"A list of objects that contains words and punctuation marks that represents one or more interpretations of the input audio.
"
}
},
"documentation":"A list of possible transcriptions for the audio.
"
},
"MedicalAlternativeList":{
"type":"list",
"member":{"shape":"MedicalAlternative"}
},
"MedicalItem":{
"type":"structure",
"members":{
"StartTime":{
"shape":"Double",
"documentation":"The number of seconds into an audio stream that indicates the creation time of an item.
"
},
"EndTime":{
"shape":"Double",
"documentation":"The number of seconds into an audio stream that indicates the creation time of an item.
"
},
"Type":{
"shape":"ItemType",
"documentation":"The type of the item. PRONUNCIATION indicates that the item is a word that was recognized in the input audio. PUNCTUATION indicates that the item was interpreted as a pause in the input audio, such as a period to indicate the end of a sentence.
"
},
"Content":{
"shape":"String",
"documentation":"The word or punctuation mark that was recognized in the input audio.
"
},
"Confidence":{
"shape":"Confidence",
"documentation":"A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe Medical assigns to each word that it transcribes.
"
},
"Speaker":{
"shape":"String",
"documentation":"If speaker identification is enabled, shows the integer values that correspond to the different speakers identified in the stream. For example, if the value of Speaker in the stream is either a 0 or a 1, that indicates that Amazon Transcribe Medical has identified two speakers in the stream. The value of 0 corresponds to one speaker and the value of 1 corresponds to the other speaker.
"
}
},
"documentation":"A word or punctuation that is transcribed from the input audio.
"
},
"MedicalItemList":{
"type":"list",
"member":{"shape":"MedicalItem"}
},
"MedicalResult":{
"type":"structure",
"members":{
"ResultId":{
"shape":"String",
"documentation":"A unique identifier for the result.
"
},
"StartTime":{
"shape":"Double",
"documentation":"The time, in seconds, from the beginning of the audio stream to the beginning of the result.
"
},
"EndTime":{
"shape":"Double",
"documentation":"The time, in seconds, from the beginning of the audio stream to the end of the result.
"
},
"IsPartial":{
"shape":"Boolean",
"documentation":"Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.
The IsPartial field is true to indicate that Amazon Transcribe Medical has additional transcription data to send. The IsPartial field is false to indicate that this is the last transcription result for the segment.
"
},
"Alternatives":{
"shape":"MedicalAlternativeList",
"documentation":"A list of possible transcriptions of the audio. Each alternative typically contains one Item that contains the result of the transcription.
"
},
"ChannelId":{
"shape":"String",
"documentation":"When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio channel separately.
You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.
"
}
},
"documentation":"The results of transcribing a portion of the input audio stream.
"
},
"MedicalResultList":{
"type":"list",
"member":{"shape":"MedicalResult"}
},
"MedicalTranscript":{
"type":"structure",
"members":{
"Results":{
"shape":"MedicalResultList",
"documentation":" MedicalResult objects that contain the results of transcribing a portion of the input audio stream. The array can be empty.
"
}
},
"documentation":"The medical transcript in a MedicalTranscriptEvent.
"
},
"MedicalTranscriptEvent":{
"type":"structure",
"members":{
"Transcript":{
"shape":"MedicalTranscript",
"documentation":"The transcription of the audio stream. The transcription is composed of all of the items in the results list.
"
}
},
"documentation":"Represents a set of transcription results from the server to the client. It contains one or more segments of the transcription.
",
"event":true
},
"MedicalTranscriptResultStream":{
"type":"structure",
"members":{
"TranscriptEvent":{
"shape":"MedicalTranscriptEvent",
"documentation":"A portion of the transcription of the audio stream. Events are sent periodically from Amazon Transcribe Medical to your application. The event can be a partial transcription of a section of the audio stream, or it can be the entire transcription of that portion of the audio stream.
"
},
"BadRequestException":{"shape":"BadRequestException"},
"LimitExceededException":{"shape":"LimitExceededException"},
"InternalFailureException":{"shape":"InternalFailureException"},
"ConflictException":{"shape":"ConflictException"},
"ServiceUnavailableException":{"shape":"ServiceUnavailableException"}
},
"documentation":"Represents the transcription result stream from Amazon Transcribe Medical to your application.
",
"eventstream":true
},
"NumberOfChannels":{
"type":"integer",
"min":2
},
"RequestId":{"type":"string"},
"Result":{
"type":"structure",
"members":{
"ResultId":{
"shape":"String",
"documentation":"A unique identifier for the result.
"
},
"StartTime":{
"shape":"Double",
"documentation":"The offset in seconds from the beginning of the audio stream to the beginning of the result.
"
},
"EndTime":{
"shape":"Double",
"documentation":"The offset in seconds from the beginning of the audio stream to the end of the result.
"
},
"IsPartial":{
"shape":"Boolean",
"documentation":"Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.
The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.
"
},
"Alternatives":{
"shape":"AlternativeList",
"documentation":"A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.
"
},
"ChannelId":{
"shape":"String",
"documentation":"When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.
You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.
"
}
},
"documentation":"The result of transcribing a portion of the input audio stream.
"
},
"ResultList":{
"type":"list",
"member":{"shape":"Result"}
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"Service is currently unavailable. Try your request later.
",
"error":{"httpStatusCode":503},
"exception":true
},
"SessionId":{
"type":"string",
"max":36,
"min":36,
"pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
},
"Specialty":{
"type":"string",
"enum":[
"PRIMARYCARE",
"CARDIOLOGY",
"NEUROLOGY",
"ONCOLOGY",
"RADIOLOGY",
"UROLOGY"
]
},
"StartMedicalStreamTranscriptionRequest":{
"type":"structure",
"required":[
"LanguageCode",
"MediaSampleRateHertz",
"MediaEncoding",
"Specialty",
"Type",
"AudioStream"
],
"members":{
"LanguageCode":{
"shape":"LanguageCode",
"documentation":" Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).
",
"location":"header",
"locationName":"x-amzn-transcribe-language-code"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"The sample rate of the input audio in Hertz. Sample rates of 16000 Hz or higher are accepted.
",
"location":"header",
"locationName":"x-amzn-transcribe-sample-rate"
},
"MediaEncoding":{
"shape":"MediaEncoding",
"documentation":"The encoding used for the input audio.
",
"location":"header",
"locationName":"x-amzn-transcribe-media-encoding"
},
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"The name of the medical custom vocabulary to use when processing the real-time stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-name"
},
"Specialty":{
"shape":"Specialty",
"documentation":"The medical specialty of the clinician or provider.
",
"location":"header",
"locationName":"x-amzn-transcribe-specialty"
},
"Type":{
"shape":"Type",
"documentation":"The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.
",
"location":"header",
"locationName":"x-amzn-transcribe-type"
},
"ShowSpeakerLabel":{
"shape":"Boolean",
"documentation":"When true, enables speaker identification in your real-time stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-show-speaker-label"
},
"SessionId":{
"shape":"SessionId",
"documentation":" Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.
",
"location":"header",
"locationName":"x-amzn-transcribe-session-id"
},
"AudioStream":{"shape":"AudioStream"},
"EnableChannelIdentification":{
"shape":"Boolean",
"documentation":"When true, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.
You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
",
"location":"header",
"locationName":"x-amzn-transcribe-enable-channel-identification"
},
"NumberOfChannels":{
"shape":"NumberOfChannels",
"documentation":"The number of channels that are in your audio stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-number-of-channels"
}
},
"payload":"AudioStream"
},
"StartMedicalStreamTranscriptionResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"RequestId",
"documentation":"An identifier for the streaming transcription.
",
"location":"header",
"locationName":"x-amzn-request-id"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"The language code for the response transcript. For Amazon Transcribe Medical, this is US English (en-US).
",
"location":"header",
"locationName":"x-amzn-transcribe-language-code"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"The sample rate of the input audio in Hertz. Valid value: 16000 Hz.
",
"location":"header",
"locationName":"x-amzn-transcribe-sample-rate"
},
"MediaEncoding":{
"shape":"MediaEncoding",
"documentation":"The encoding used for the input audio stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-media-encoding"
},
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"The name of the vocabulary used when processing the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-name"
},
"Specialty":{
"shape":"Specialty",
"documentation":"The specialty in the medical domain.
",
"location":"header",
"locationName":"x-amzn-transcribe-specialty"
},
"Type":{
"shape":"Type",
"documentation":"The type of audio that was transcribed.
",
"location":"header",
"locationName":"x-amzn-transcribe-type"
},
"ShowSpeakerLabel":{
"shape":"Boolean",
"documentation":"Shows whether speaker identification was enabled in the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-show-speaker-label"
},
"SessionId":{
"shape":"SessionId",
"documentation":"Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.
",
"location":"header",
"locationName":"x-amzn-transcribe-session-id"
},
"TranscriptResultStream":{
"shape":"MedicalTranscriptResultStream",
"documentation":"Represents the stream of transcription events from Amazon Transcribe Medical to your application.
"
},
"EnableChannelIdentification":{
"shape":"Boolean",
"documentation":"Shows whether channel identification has been enabled in the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-enable-channel-identification"
},
"NumberOfChannels":{
"shape":"NumberOfChannels",
"documentation":"The number of channels identified in the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-number-of-channels"
}
},
"payload":"TranscriptResultStream"
},
"StartStreamTranscriptionRequest":{
"type":"structure",
"required":[
"LanguageCode",
"MediaSampleRateHertz",
"MediaEncoding",
"AudioStream"
],
"members":{
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"Indicates the source language used in the input audio stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-language-code"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low quality audio and 16000 Hz for high quality audio.
",
"location":"header",
"locationName":"x-amzn-transcribe-sample-rate"
},
"MediaEncoding":{
"shape":"MediaEncoding",
"documentation":"The encoding used for the input audio.
",
"location":"header",
"locationName":"x-amzn-transcribe-media-encoding"
},
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"The name of the vocabulary to use when processing the transcription job.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-name"
},
"SessionId":{
"shape":"SessionId",
"documentation":"A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.
",
"location":"header",
"locationName":"x-amzn-transcribe-session-id"
},
"AudioStream":{
"shape":"AudioStream",
"documentation":"PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data frame.
"
},
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-filter-name"
},
"VocabularyFilterMethod":{
"shape":"VocabularyFilterMethod",
"documentation":"The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-filter-method"
},
"ShowSpeakerLabel":{
"shape":"Boolean",
"documentation":"When true, enables speaker identification in your real-time stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-show-speaker-label"
},
"EnableChannelIdentification":{
"shape":"Boolean",
"documentation":"When true, instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.
You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
",
"location":"header",
"locationName":"x-amzn-transcribe-enable-channel-identification"
},
"NumberOfChannels":{
"shape":"NumberOfChannels",
"documentation":"The number of channels that are in your audio stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-number-of-channels"
}
},
"payload":"AudioStream"
},
"StartStreamTranscriptionResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"RequestId",
"documentation":"An identifier for the streaming transcription.
",
"location":"header",
"locationName":"x-amzn-request-id"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"The language code for the input audio stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-language-code"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz for high quality audio.
",
"location":"header",
"locationName":"x-amzn-transcribe-sample-rate"
},
"MediaEncoding":{
"shape":"MediaEncoding",
"documentation":"The encoding used for the input audio stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-media-encoding"
},
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"The name of the vocabulary used when processing the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-name"
},
"SessionId":{
"shape":"SessionId",
"documentation":"An identifier for a specific transcription session.
",
"location":"header",
"locationName":"x-amzn-transcribe-session-id"
},
"TranscriptResultStream":{
"shape":"TranscriptResultStream",
"documentation":"Represents the stream of transcription events from Amazon Transcribe to your application.
"
},
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"The name of the vocabulary filter used in your real-time stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-filter-name"
},
"VocabularyFilterMethod":{
"shape":"VocabularyFilterMethod",
"documentation":"The vocabulary filtering method used in the real-time stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-vocabulary-filter-method"
},
"ShowSpeakerLabel":{
"shape":"Boolean",
"documentation":"Shows whether speaker identification was enabled in the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-show-speaker-label"
},
"EnableChannelIdentification":{
"shape":"Boolean",
"documentation":"Shows whether channel identification has been enabled in the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-enable-channel-identification"
},
"NumberOfChannels":{
"shape":"NumberOfChannels",
"documentation":"The number of channels identified in the stream.
",
"location":"header",
"locationName":"x-amzn-transcribe-number-of-channels"
}
},
"payload":"TranscriptResultStream"
},
"String":{"type":"string"},
"Transcript":{
"type":"structure",
"members":{
"Results":{
"shape":"ResultList",
"documentation":" Result objects that contain the results of transcribing a portion of the input audio stream. The array can be empty.
"
}
},
"documentation":"The transcription in a TranscriptEvent.
"
},
"TranscriptEvent":{
"type":"structure",
"members":{
"Transcript":{
"shape":"Transcript",
"documentation":"The transcription of the audio stream. The transcription is composed of all of the items in the results list.
"
}
},
"documentation":"Represents a set of transcription results from the server to the client. It contains one or more segments of the transcription.
",
"event":true
},
"TranscriptResultStream":{
"type":"structure",
"members":{
"TranscriptEvent":{
"shape":"TranscriptEvent",
"documentation":"A portion of the transcription of the audio stream. Events are sent periodically from Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio stream, or it can be the entire transcription of that portion of the audio stream.
"
},
"BadRequestException":{
"shape":"BadRequestException",
"documentation":"A client error occurred when the stream was created. Check the parameters of the request and try your request again.
"
},
"LimitExceededException":{
"shape":"LimitExceededException",
"documentation":"Your client has exceeded one of the Amazon Transcribe limits, typically the limit on audio length. Break your audio stream into smaller chunks and try your request again.
"
},
"InternalFailureException":{
"shape":"InternalFailureException",
"documentation":"A problem occurred while processing the audio. Amazon Transcribe terminated processing.
"
},
"ConflictException":{
"shape":"ConflictException",
"documentation":"A new stream started with the same session ID. The current stream has been terminated.
"
},
"ServiceUnavailableException":{
"shape":"ServiceUnavailableException",
"documentation":"Service is currently unavailable. Try your request later.
"
}
},
"documentation":"Represents the transcription result stream from Amazon Transcribe to your application.
",
"eventstream":true
},
"Type":{
"type":"string",
"enum":[
"CONVERSATION",
"DICTATION"
]
},
"VocabularyFilterMethod":{
"type":"string",
"enum":[
"remove",
"mask",
"tag"
]
},
"VocabularyFilterName":{
"type":"string",
"max":200,
"min":1,
"pattern":"^[0-9a-zA-Z._-]+"
},
"VocabularyName":{
"type":"string",
"max":200,
"min":1,
"pattern":"^[0-9a-zA-Z._-]+"
}
},
"documentation":"Operations and objects for transcribing streaming speech to text.
"
}