pub struct StartMedicalScribeStreamFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartMedicalScribeStream
.
Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web Services HealthScribe and the transcription results are streamed to your application.
When you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent
. This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent
.
After you send a MedicalScribeConfigurationEvent
, you start AudioEvents
and Amazon Web Services HealthScribe responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent
with a Type
of END_OF_SESSION
and Amazon Web Services HealthScribe starts the analytics.
You can pause or resume streaming. To pause streaming, complete the input stream without sending the MedicalScribeSessionControlEvent
. To resume streaming, call the StartMedicalScribeStream
and specify the same SessionId you used to start the stream.
The following parameters are required:
-
language-code
-
media-encoding
-
media-sample-rate-hertz
For more information on streaming with Amazon Web Services HealthScribe, see Amazon Web Services HealthScribe.
Implementations§
Source§impl StartMedicalScribeStreamFluentBuilder
impl StartMedicalScribeStreamFluentBuilder
Sourcepub fn as_input(&self) -> &StartMedicalScribeStreamInputBuilder
pub fn as_input(&self) -> &StartMedicalScribeStreamInputBuilder
Access the StartMedicalScribeStream as a reference.
Sourcepub async fn send(
self,
) -> Result<StartMedicalScribeStreamOutput, SdkError<StartMedicalScribeStreamError, HttpResponse>>
pub async fn send( self, ) -> Result<StartMedicalScribeStreamOutput, SdkError<StartMedicalScribeStreamError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartMedicalScribeStreamOutput, StartMedicalScribeStreamError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartMedicalScribeStreamOutput, StartMedicalScribeStreamError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
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.
Sourcepub fn language_code(self, input: MedicalScribeLanguageCode) -> Self
pub fn language_code(self, input: MedicalScribeLanguageCode) -> Self
Specify the language code for your HealthScribe streaming session.
Sourcepub fn set_language_code(self, input: Option<MedicalScribeLanguageCode>) -> Self
pub fn set_language_code(self, input: Option<MedicalScribeLanguageCode>) -> Self
Specify the language code for your HealthScribe streaming session.
Sourcepub fn get_language_code(&self) -> &Option<MedicalScribeLanguageCode>
pub fn get_language_code(&self) -> &Option<MedicalScribeLanguageCode>
Specify the language code for your HealthScribe streaming session.
Sourcepub fn media_sample_rate_hertz(self, input: i32) -> Self
pub fn media_sample_rate_hertz(self, input: i32) -> Self
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.
Sourcepub fn set_media_sample_rate_hertz(self, input: Option<i32>) -> Self
pub fn set_media_sample_rate_hertz(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_media_sample_rate_hertz(&self) -> &Option<i32>
pub fn get_media_sample_rate_hertz(&self) -> &Option<i32>
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.
Sourcepub fn media_encoding(self, input: MedicalScribeMediaEncoding) -> Self
pub fn media_encoding(self, input: MedicalScribeMediaEncoding) -> Self
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.
Sourcepub fn set_media_encoding(
self,
input: Option<MedicalScribeMediaEncoding>,
) -> Self
pub fn set_media_encoding( self, input: Option<MedicalScribeMediaEncoding>, ) -> Self
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.
Sourcepub fn get_media_encoding(&self) -> &Option<MedicalScribeMediaEncoding>
pub fn get_media_encoding(&self) -> &Option<MedicalScribeMediaEncoding>
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.
Sourcepub fn input_stream(
self,
input: EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>,
) -> Self
pub fn input_stream( self, input: EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>, ) -> Self
Specify the input stream where you will send events in real time.
The first element of the input stream must be a MedicalScribeConfigurationEvent
.
Sourcepub fn set_input_stream(
self,
input: Option<EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>>,
) -> Self
pub fn set_input_stream( self, input: Option<EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>>, ) -> Self
Specify the input stream where you will send events in real time.
The first element of the input stream must be a MedicalScribeConfigurationEvent
.
Sourcepub fn get_input_stream(
&self,
) -> &Option<EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>>
pub fn get_input_stream( &self, ) -> &Option<EventStreamSender<MedicalScribeInputStream, MedicalScribeInputStreamError>>
Specify the input stream where you will send events in real time.
The first element of the input stream must be a MedicalScribeConfigurationEvent
.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for StartMedicalScribeStreamFluentBuilder
impl !RefUnwindSafe for StartMedicalScribeStreamFluentBuilder
impl Send for StartMedicalScribeStreamFluentBuilder
impl Sync for StartMedicalScribeStreamFluentBuilder
impl Unpin for StartMedicalScribeStreamFluentBuilder
impl !UnwindSafe for StartMedicalScribeStreamFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);