Class: Aws::TranscribeStreamingService::Types::StartCallAnalyticsStreamTranscriptionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::TranscribeStreamingService::Types::StartCallAnalyticsStreamTranscriptionRequest
- Defined in:
- gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#audio_stream ⇒ Types::AudioStream
An encoded stream of audio blobs.
-
#content_identification_type ⇒ String
Labels all personally identifiable information (PII) identified in your transcript.
-
#content_redaction_type ⇒ String
Redacts all personally identifiable information (PII) identified in your transcript.
-
#enable_partial_results_stabilization ⇒ Boolean
Enables partial result stabilization for your transcription.
-
#identify_language ⇒ Boolean
Enables automatic language identification for your Call Analytics transcription.
-
#language_code ⇒ String
Specify the language code that represents the language spoken in your audio.
-
#language_model_name ⇒ String
Specify the name of the custom language model that you want to use when processing your transcription.
-
#language_options ⇒ String
Specify two or more language codes that represent the languages you think may be present in your media.
-
#media_encoding ⇒ String
Specify the encoding of your input audio.
-
#media_sample_rate_hertz ⇒ Integer
The sample rate of the input audio (in hertz).
-
#partial_results_stability ⇒ String
Specify the level of stability to use when you enable partial results stabilization (
EnablePartialResultsStabilization
). -
#pii_entity_types ⇒ String
Specify which types of personally identifiable information (PII) you want to redact in your transcript.
-
#preferred_language ⇒ String
Specify a preferred language from the subset of languages codes you specified in
LanguageOptions
. -
#session_id ⇒ String
Specify a name for your Call Analytics transcription session.
-
#vocabulary_filter_method ⇒ String
Specify how you want your vocabulary filter applied to your transcript.
-
#vocabulary_filter_name ⇒ String
Specify the name of the custom vocabulary filter that you want to use when processing your transcription.
-
#vocabulary_filter_names ⇒ String
Specify the names of the custom vocabulary filters that you want to use when processing your Call Analytics transcription.
-
#vocabulary_name ⇒ String
Specify the name of the custom vocabulary that you want to use when processing your transcription.
-
#vocabulary_names ⇒ String
Specify the names of the custom vocabularies that you want to use when processing your Call Analytics transcription.
Instance Attribute Details
#audio_stream ⇒ Types::AudioStream
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#content_identification_type ⇒ String
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. If you don't include PiiEntityTypes
in your
request, all PII is identified.
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#content_redaction_type ⇒ String
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. If you don't include PiiEntityTypes
in your
request, all PII is redacted.
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#enable_partial_results_stabilization ⇒ Boolean
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#identify_language ⇒ Boolean
Enables automatic language identification for your Call Analytics transcription.
If you include IdentifyLanguage
, you must include a list of
language codes, using LanguageOptions
, that you think may be
present in your audio stream. You must provide a minimum of two
language selections.
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.
Note that you must include either LanguageCode
or
IdentifyLanguage
in your request. If you include both parameters,
your transcription job fails.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
Specify the language code that represents the language spoken in your audio.
For a list of languages supported with real-time Call Analytics, refer to the Supported languages table.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#language_model_name ⇒ 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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#language_options ⇒ String
Specify two or more language codes that represent the languages you think may be present in your media.
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 Call Analytics 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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#media_encoding ⇒ String
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#media_sample_rate_hertz ⇒ Integer
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#partial_results_stability ⇒ String
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#pii_entity_types ⇒ String
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
.
Values must be comma-separated and can include: ADDRESS
,
BANK_ACCOUNT_NUMBER
, BANK_ROUTING
, CREDIT_DEBIT_CVV
,
CREDIT_DEBIT_EXPIRY
, CREDIT_DEBIT_NUMBER
, EMAIL
, NAME
,
PHONE
, PIN
, SSN
, or ALL
.
Note that if you include PiiEntityTypes
in your request, you must
also include ContentIdentificationType
or ContentRedactionType
.
If you include ContentRedactionType
or ContentIdentificationType
in your request, but do not include PiiEntityTypes
, all PII is
redacted or identified.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#preferred_language ⇒ 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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#session_id ⇒ 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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#vocabulary_filter_method ⇒ 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
.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#vocabulary_filter_name ⇒ String
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#vocabulary_filter_names ⇒ String
Specify the names of the custom vocabulary filters that you want to use when processing your Call Analytics transcription. Note that vocabulary filter names are case sensitive.
These filters serve to customize the transcript output.
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#vocabulary_name ⇒ String
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |
#vocabulary_names ⇒ String
Specify the names of the custom vocabularies that you want to use when processing your Call Analytics transcription. Note that vocabulary names are case sensitive.
If the custom vocabulary's language doesn't match the identified media language, it won't be applied to the transcription.
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.
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 1938 class StartCallAnalyticsStreamTranscriptionRequest < Struct.new( :language_code, :media_sample_rate_hertz, :media_encoding, :vocabulary_name, :session_id, :audio_stream, :vocabulary_filter_name, :vocabulary_filter_method, :language_model_name, :identify_language, :language_options, :preferred_language, :vocabulary_names, :vocabulary_filter_names, :enable_partial_results_stabilization, :partial_results_stability, :content_identification_type, :content_redaction_type, :pii_entity_types) SENSITIVE = [] include Aws::Structure end |