#[non_exhaustive]pub struct CallAnalyticsJobSettingsBuilder { /* private fields */ }
Expand description
A builder for CallAnalyticsJobSettings
.
Implementations§
Source§impl CallAnalyticsJobSettingsBuilder
impl CallAnalyticsJobSettingsBuilder
Sourcepub fn vocabulary_name(self, input: impl Into<String>) -> Self
pub fn vocabulary_name(self, input: impl Into<String>) -> Self
The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.
Sourcepub fn set_vocabulary_name(self, input: Option<String>) -> Self
pub fn set_vocabulary_name(self, input: Option<String>) -> Self
The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.
Sourcepub fn get_vocabulary_name(&self) -> &Option<String>
pub fn get_vocabulary_name(&self) -> &Option<String>
The name of the custom vocabulary you want to include in your Call Analytics transcription request. Custom vocabulary names are case sensitive.
Sourcepub fn vocabulary_filter_name(self, input: impl Into<String>) -> Self
pub fn vocabulary_filter_name(self, input: impl Into<String>) -> Self
The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.
Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Sourcepub fn set_vocabulary_filter_name(self, input: Option<String>) -> Self
pub fn set_vocabulary_filter_name(self, input: Option<String>) -> Self
The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.
Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Sourcepub fn get_vocabulary_filter_name(&self) -> &Option<String>
pub fn get_vocabulary_filter_name(&self) -> &Option<String>
The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Custom vocabulary filter names are case sensitive.
Note that if you include VocabularyFilterName
in your request, you must also include VocabularyFilterMethod
.
Sourcepub fn vocabulary_filter_method(self, input: VocabularyFilterMethod) -> Self
pub fn vocabulary_filter_method(self, input: VocabularyFilterMethod) -> Self
Specify how you want your custom 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
.
Sourcepub fn set_vocabulary_filter_method(
self,
input: Option<VocabularyFilterMethod>,
) -> Self
pub fn set_vocabulary_filter_method( self, input: Option<VocabularyFilterMethod>, ) -> Self
Specify how you want your custom 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
.
Sourcepub fn get_vocabulary_filter_method(&self) -> &Option<VocabularyFilterMethod>
pub fn get_vocabulary_filter_method(&self) -> &Option<VocabularyFilterMethod>
Specify how you want your custom 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
.
Sourcepub fn language_model_name(self, input: impl Into<String>) -> Self
pub fn language_model_name(self, input: impl Into<String>) -> Self
The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
Sourcepub fn set_language_model_name(self, input: Option<String>) -> Self
pub fn set_language_model_name(self, input: Option<String>) -> Self
The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
Sourcepub fn get_language_model_name(&self) -> &Option<String>
pub fn get_language_model_name(&self) -> &Option<String>
The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
Sourcepub fn content_redaction(self, input: ContentRedaction) -> Self
pub fn content_redaction(self, input: ContentRedaction) -> Self
Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction
, you must also include the sub-parameters: RedactionOutput
and RedactionType
. You can optionally include PiiEntityTypes
to choose which types of PII you want to redact.
Sourcepub fn set_content_redaction(self, input: Option<ContentRedaction>) -> Self
pub fn set_content_redaction(self, input: Option<ContentRedaction>) -> Self
Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction
, you must also include the sub-parameters: RedactionOutput
and RedactionType
. You can optionally include PiiEntityTypes
to choose which types of PII you want to redact.
Sourcepub fn get_content_redaction(&self) -> &Option<ContentRedaction>
pub fn get_content_redaction(&self) -> &Option<ContentRedaction>
Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction
, you must also include the sub-parameters: RedactionOutput
and RedactionType
. You can optionally include PiiEntityTypes
to choose which types of PII you want to redact.
Sourcepub fn language_options(self, input: LanguageCode) -> Self
pub fn language_options(self, input: LanguageCode) -> Self
Appends an item to language_options
.
To override the contents of this collection use set_language_options
.
You can 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.
For a list of languages supported with Call Analytics, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA
) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.
Sourcepub fn set_language_options(self, input: Option<Vec<LanguageCode>>) -> Self
pub fn set_language_options(self, input: Option<Vec<LanguageCode>>) -> Self
You can 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.
For a list of languages supported with Call Analytics, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA
) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.
Sourcepub fn get_language_options(&self) -> &Option<Vec<LanguageCode>>
pub fn get_language_options(&self) -> &Option<Vec<LanguageCode>>
You can 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.
For a list of languages supported with Call Analytics, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA
) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.
Sourcepub fn language_id_settings(
self,
k: LanguageCode,
v: LanguageIdSettings,
) -> Self
pub fn language_id_settings( self, k: LanguageCode, v: LanguageIdSettings, ) -> Self
Adds a key-value pair to language_id_settings
.
To override the contents of this collection use set_language_id_settings
.
If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings
with the relevant sub-parameters (VocabularyName
, LanguageModelName
, and VocabularyFilterName
).
LanguageIdSettings
supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions
when using LanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US
but Amazon Transcribe determines that the language spoken in your media is en-AU
, your custom vocabulary is not applied to your transcription. If you include LanguageOptions
and include en-US
as the only English language dialect, your custom vocabulary is applied to your transcription.
If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the
LanguageModelName
, VocabularyName
, or VocabularyFilterName
sub-parameters.
For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
Sourcepub fn set_language_id_settings(
self,
input: Option<HashMap<LanguageCode, LanguageIdSettings>>,
) -> Self
pub fn set_language_id_settings( self, input: Option<HashMap<LanguageCode, LanguageIdSettings>>, ) -> Self
If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings
with the relevant sub-parameters (VocabularyName
, LanguageModelName
, and VocabularyFilterName
).
LanguageIdSettings
supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions
when using LanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US
but Amazon Transcribe determines that the language spoken in your media is en-AU
, your custom vocabulary is not applied to your transcription. If you include LanguageOptions
and include en-US
as the only English language dialect, your custom vocabulary is applied to your transcription.
If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the
LanguageModelName
, VocabularyName
, or VocabularyFilterName
sub-parameters.
For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
Sourcepub fn get_language_id_settings(
&self,
) -> &Option<HashMap<LanguageCode, LanguageIdSettings>>
pub fn get_language_id_settings( &self, ) -> &Option<HashMap<LanguageCode, LanguageIdSettings>>
If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings
with the relevant sub-parameters (VocabularyName
, LanguageModelName
, and VocabularyFilterName
).
LanguageIdSettings
supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions
when using LanguageIdSettings
to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US
but Amazon Transcribe determines that the language spoken in your media is en-AU
, your custom vocabulary is not applied to your transcription. If you include LanguageOptions
and include en-US
as the only English language dialect, your custom vocabulary is applied to your transcription.
If you want to include a custom language model, custom vocabulary, or custom vocabulary filter with your request but do not want to use automatic language identification, use instead the parameter with the
LanguageModelName
, VocabularyName
, or VocabularyFilterName
sub-parameters.
For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
Sourcepub fn summarization(self, input: Summarization) -> Self
pub fn summarization(self, input: Summarization) -> Self
Contains GenerateAbstractiveSummary
, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.
Sourcepub fn set_summarization(self, input: Option<Summarization>) -> Self
pub fn set_summarization(self, input: Option<Summarization>) -> Self
Contains GenerateAbstractiveSummary
, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.
Sourcepub fn get_summarization(&self) -> &Option<Summarization>
pub fn get_summarization(&self) -> &Option<Summarization>
Contains GenerateAbstractiveSummary
, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.
Sourcepub fn build(self) -> CallAnalyticsJobSettings
pub fn build(self) -> CallAnalyticsJobSettings
Consumes the builder and constructs a CallAnalyticsJobSettings
.
Trait Implementations§
Source§impl Clone for CallAnalyticsJobSettingsBuilder
impl Clone for CallAnalyticsJobSettingsBuilder
Source§fn clone(&self) -> CallAnalyticsJobSettingsBuilder
fn clone(&self) -> CallAnalyticsJobSettingsBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CallAnalyticsJobSettingsBuilder
impl Default for CallAnalyticsJobSettingsBuilder
Source§fn default() -> CallAnalyticsJobSettingsBuilder
fn default() -> CallAnalyticsJobSettingsBuilder
Source§impl PartialEq for CallAnalyticsJobSettingsBuilder
impl PartialEq for CallAnalyticsJobSettingsBuilder
Source§fn eq(&self, other: &CallAnalyticsJobSettingsBuilder) -> bool
fn eq(&self, other: &CallAnalyticsJobSettingsBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CallAnalyticsJobSettingsBuilder
Auto Trait Implementations§
impl Freeze for CallAnalyticsJobSettingsBuilder
impl RefUnwindSafe for CallAnalyticsJobSettingsBuilder
impl Send for CallAnalyticsJobSettingsBuilder
impl Sync for CallAnalyticsJobSettingsBuilder
impl Unpin for CallAnalyticsJobSettingsBuilder
impl UnwindSafe for CallAnalyticsJobSettingsBuilder
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();
Source§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.Source§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);