aws_sdk_transcribestreaming/client/
start_medical_scribe_stream.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StartMedicalScribeStream`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder) operation.
4                            ///
5                            /// - The fluent builder is configurable:
6    ///   - [`session_id(impl Into<String>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::set_session_id):<br>required: **false**<br><p>Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.</p><br>
7    ///   - [`language_code(MedicalScribeLanguageCode)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::language_code) / [`set_language_code(Option<MedicalScribeLanguageCode>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::set_language_code):<br>required: **true**<br><p>Specify the language code for your HealthScribe streaming session.</p><br>
8    ///   - [`media_sample_rate_hertz(i32)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::media_sample_rate_hertz) / [`set_media_sample_rate_hertz(Option<i32>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::set_media_sample_rate_hertz):<br>required: **true**<br><p>Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio.</p><br>
9    ///   - [`media_encoding(MedicalScribeMediaEncoding)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::media_encoding) / [`set_media_encoding(Option<MedicalScribeMediaEncoding>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::set_media_encoding):<br>required: **true**<br><p>Specify the encoding used for the input audio.</p> <p>Supported formats are:</p> <ul>  <li>   <p>FLAC</p></li>  <li>   <p>OPUS-encoded audio in an Ogg container</p></li>  <li>   <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p></li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p><br>
10    ///   - [`input_stream(EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::input_stream) / [`set_input_stream(EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>)`](crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::set_input_stream):<br>required: **true**<br><p>Specify the input stream where you will send events in real time.</p> <p>The first element of the input stream must be a <code>MedicalScribeConfigurationEvent</code>.</p><br>
11                            /// - On success, responds with [`StartMedicalScribeStreamOutput`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput) with field(s):
12    ///   - [`session_id(Option<String>)`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput::session_id): <p>The identifier (in UUID format) for your streaming session.</p> <p>If you already started streaming, this is same ID as the one you specified in your initial <code>StartMedicalScribeStreamRequest</code>.</p>
13    ///   - [`request_id(Option<String>)`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput::request_id): <p>The unique identifier for your streaming request.</p>
14    ///   - [`language_code(Option<MedicalScribeLanguageCode>)`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput::language_code): <p>The Language Code that you specified in your request. Same as provided in the <code>StartMedicalScribeStreamRequest</code>.</p>
15    ///   - [`media_sample_rate_hertz(Option<i32>)`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput::media_sample_rate_hertz): <p>The sample rate (in hertz) that you specified in your request. Same as provided in the <code>StartMedicalScribeStreamRequest</code></p>
16    ///   - [`media_encoding(Option<MedicalScribeMediaEncoding>)`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput::media_encoding): <p>The Media Encoding you specified in your request. Same as provided in the <code>StartMedicalScribeStreamRequest</code></p>
17    ///   - [`result_stream(EventReceiver<MedicalScribeResultStream, MedicalScribeResultStreamError>)`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamOutput::result_stream): <p>The result stream where you will receive the output events.</p>
18                            /// - On failure, responds with [`SdkError<StartMedicalScribeStreamError>`](crate::operation::start_medical_scribe_stream::StartMedicalScribeStreamError)
19    pub fn start_medical_scribe_stream(&self) -> crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder {
20                                crate::operation::start_medical_scribe_stream::builders::StartMedicalScribeStreamFluentBuilder::new(self.handle.clone())
21                            }
22}
23
aws_sdk_transcribestreaming/client/start_medical_scribe_stream.rs

aws_sdk_transcribestreaming/client/
start_medical_scribe_stream.rs
