Table of Contents
A low-level client representing Amazon Transcribe Service
Operations and objects for transcribing speech to text.
import boto3
client = boto3.client('transcribe')
These are the available methods:
Check if an operation can be paginated.
Creates an analytics category. Amazon Transcribe applies the conditions specified by your analytics categories to your call analytics jobs. For each analytics category, you specify one or more rules. For example, you can specify a rule that the customer sentiment was neutral or negative within that category. If you start a call analytics job, Amazon Transcribe applies the category to the analytics job that you've specified.
See also: AWS API Documentation
Request Syntax
response = client.create_call_analytics_category(
CategoryName='string',
Rules=[
{
'NonTalkTimeFilter': {
'Threshold': 123,
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'InterruptionFilter': {
'Threshold': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'TranscriptFilter': {
'TranscriptFilterType': 'EXACT',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False,
'Targets': [
'string',
]
},
'SentimentFilter': {
'Sentiments': [
'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
],
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False
}
},
]
)
[REQUIRED]
The name that you choose for your category when you create it.
[REQUIRED]
To create a category, you must specify between 1 and 20 rules. For each rule, you specify a filter to be applied to the attributes of the call. For example, you can specify a sentiment filter to detect if the customer's sentiment was negative or neutral.
A condition in the call between the customer and the agent that you want to filter for.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: NonTalkTimeFilter, InterruptionFilter, TranscriptFilter, SentimentFilter.
A condition for a time period when neither the customer nor the agent was talking.
The duration of the period when neither the customer nor agent was talking.
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Set to TRUE to look for a time period when people were talking.
A condition for a time period when either the customer or agent was interrupting the other person.
The duration of the interruption.
Indicates whether the caller or customer was interrupting.
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Set to TRUE to look for a time period where there was no interruption.
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
A time range, set in seconds, between two points in the call.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Determines whether the customer or the agent is speaking the phrases that you've specified.
If TRUE , the rule that you specify is applied to everything except for the phrases that you specify.
The phrases that you're specifying for the transcript filter to match.
A condition that is applied to a particular customer sentiment.
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
The time range, measured in seconds, of the sentiment.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
The time range, set in percentages, that correspond to proportion of the call.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
A value that determines whether the sentiment belongs to the customer or the agent.
Set to TRUE to look for sentiments that weren't specified in the request.
dict
Response Syntax
{
'CategoryProperties': {
'CategoryName': 'string',
'Rules': [
{
'NonTalkTimeFilter': {
'Threshold': 123,
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'InterruptionFilter': {
'Threshold': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'TranscriptFilter': {
'TranscriptFilterType': 'EXACT',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False,
'Targets': [
'string',
]
},
'SentimentFilter': {
'Sentiments': [
'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
],
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False
}
},
],
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
CategoryProperties (dict) --
The rules and associated metadata used to create a category.
CategoryName (string) --
The name of the call analytics category.
Rules (list) --
The rules used to create a call analytics category.
(dict) --
A condition in the call between the customer and the agent that you want to filter for.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: NonTalkTimeFilter, InterruptionFilter, TranscriptFilter, SentimentFilter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
NonTalkTimeFilter (dict) --
A condition for a time period when neither the customer nor the agent was talking.
Threshold (integer) --
The duration of the period when neither the customer nor agent was talking.
AbsoluteTimeRange (dict) --
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Negate (boolean) --
Set to TRUE to look for a time period when people were talking.
InterruptionFilter (dict) --
A condition for a time period when either the customer or agent was interrupting the other person.
Threshold (integer) --
The duration of the interruption.
ParticipantRole (string) --
Indicates whether the caller or customer was interrupting.
AbsoluteTimeRange (dict) --
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Negate (boolean) --
Set to TRUE to look for a time period where there was no interruption.
TranscriptFilter (dict) --
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
TranscriptFilterType (string) --
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
AbsoluteTimeRange (dict) --
A time range, set in seconds, between two points in the call.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
ParticipantRole (string) --
Determines whether the customer or the agent is speaking the phrases that you've specified.
Negate (boolean) --
If TRUE , the rule that you specify is applied to everything except for the phrases that you specify.
Targets (list) --
The phrases that you're specifying for the transcript filter to match.
SentimentFilter (dict) --
A condition that is applied to a particular customer sentiment.
Sentiments (list) --
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
AbsoluteTimeRange (dict) --
The time range, measured in seconds, of the sentiment.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
The time range, set in percentages, that correspond to proportion of the call.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
ParticipantRole (string) --
A value that determines whether the sentiment belongs to the customer or the agent.
Negate (boolean) --
Set to TRUE to look for sentiments that weren't specified in the request.
CreateTime (datetime) --
A timestamp that shows when the call analytics category was created.
LastUpdateTime (datetime) --
A timestamp that shows when the call analytics category was most recently updated.
Exceptions
Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.
See also: AWS API Documentation
Request Syntax
response = client.create_language_model(
LanguageCode='en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU',
BaseModelName='NarrowBand'|'WideBand',
ModelName='string',
InputDataConfig={
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The language of the input text you're using to train your custom language model.
[REQUIRED]
The Amazon Transcribe standard language model, or base model used to create your custom language model.
If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, choose Wideband .
If you want to use your custom language model to transcribe audio with a sample rate that is less than 16,000 Hz, choose Narrowband .
[REQUIRED]
The name you choose for your custom language model when you create it.
[REQUIRED]
Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.
The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .
Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'LanguageCode': 'en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU',
'BaseModelName': 'NarrowBand'|'WideBand',
'ModelName': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
},
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED'
}
Response Structure
(dict) --
LanguageCode (string) --
The language code of the text you've used to create a custom language model.
BaseModelName (string) --
The Amazon Transcribe standard language model, or base model you've used to create a custom language model.
ModelName (string) --
The name you've chosen for your custom language model.
InputDataConfig (dict) --
The data access role and Amazon S3 prefixes you've chosen to create your custom language model.
S3Uri (string) --
The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
TuningDataS3Uri (string) --
The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .
ModelStatus (string) --
The status of the custom language model. When the status is COMPLETED the model is ready to use.
Exceptions
Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
See also: AWS API Documentation
Request Syntax
response = client.create_medical_vocabulary(
VocabularyName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
VocabularyFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the custom vocabulary. This case-sensitive name must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a ConflictException error.
[REQUIRED]
The language code for the language used for the entries in your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
[REQUIRED]
The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling. Enter information about your VocabularyFileUri in the following format:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
The following is an example URI for a vocabulary file that is stored in Amazon S3:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide .
For more information about custom vocabularies, see Medical Custom Vocabularies .
Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case sensitive.
LanguageCode (string) --
The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.
VocabularyState (string) --
The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY , you can use the vocabulary in a StartMedicalTranscriptionJob request.
LastModifiedTime (datetime) --
The date and time that you created the vocabulary.
FailureReason (string) --
If the VocabularyState field is FAILED , this field contains information about why the job failed.
Exceptions
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
See also: AWS API Documentation
Request Syntax
response = client.create_vocabulary(
VocabularyName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
Phrases=[
'string',
],
VocabularyFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
[REQUIRED]
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix .
An array of strings that contains the vocabulary entries.
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
For more information about custom vocabularies, see Custom vocabularies .
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries.
VocabularyState (string) --
The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
LastModifiedTime (datetime) --
The date and time that the vocabulary was created.
FailureReason (string) --
If the VocabularyState field is FAILED , this field contains information about why the job failed.
Exceptions
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
See also: AWS API Documentation
Request Syntax
response = client.create_vocabulary_filter(
VocabularyFilterName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
Words=[
'string',
],
VocabularyFilterFileUri='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.
[REQUIRED]
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .
If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you create this new vocabulary filter.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the vocabulary filter.
LanguageCode (string) --
The language code of the words in the collection.
LastModifiedTime (datetime) --
The date and time that the vocabulary filter was modified.
Exceptions
Deletes a call analytics category using its name.
See also: AWS API Documentation
Request Syntax
response = client.delete_call_analytics_category(
CategoryName='string'
)
[REQUIRED]
The name of the call analytics category that you're choosing to delete. The value is case sensitive.
{}
Response Structure
Exceptions
Deletes a call analytics job using its name.
See also: AWS API Documentation
Request Syntax
response = client.delete_call_analytics_job(
CallAnalyticsJobName='string'
)
[REQUIRED]
The name of the call analytics job you want to delete.
{}
Response Structure
Exceptions
Deletes a custom language model using its name.
See also: AWS API Documentation
Request Syntax
response = client.delete_language_model(
ModelName='string'
)
[REQUIRED]
The name of the model you're choosing to delete.
Exceptions
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
See also: AWS API Documentation
Request Syntax
response = client.delete_medical_transcription_job(
MedicalTranscriptionJobName='string'
)
[REQUIRED]
The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.
Exceptions
Deletes a vocabulary from Amazon Transcribe Medical.
See also: AWS API Documentation
Request Syntax
response = client.delete_medical_vocabulary(
VocabularyName='string'
)
[REQUIRED]
The name of the vocabulary that you want to delete.
Exceptions
Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
See also: AWS API Documentation
Request Syntax
response = client.delete_transcription_job(
TranscriptionJobName='string'
)
[REQUIRED]
The name of the transcription job to be deleted.
Exceptions
Deletes a vocabulary from Amazon Transcribe.
See also: AWS API Documentation
Request Syntax
response = client.delete_vocabulary(
VocabularyName='string'
)
[REQUIRED]
The name of the vocabulary to delete.
Exceptions
Removes a vocabulary filter.
See also: AWS API Documentation
Request Syntax
response = client.delete_vocabulary_filter(
VocabularyFilterName='string'
)
[REQUIRED]
The name of the vocabulary filter to remove.
Exceptions
Gets information about a single custom language model. Use this information to see details about the language model in your Amazon Web Services account. You can also see whether the base language model used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If the language model wasn't created, you can use this operation to understand why Amazon Transcribe couldn't create it.
See also: AWS API Documentation
Request Syntax
response = client.describe_language_model(
ModelName='string'
)
[REQUIRED]
The name of the custom language model you submit to get more information.
{
'LanguageModel': {
'ModelName': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LanguageCode': 'en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU',
'BaseModelName': 'NarrowBand'|'WideBand',
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
'UpgradeAvailability': True|False,
'FailureReason': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
}
}
}
Response Structure
The name of the custom language model you requested more information about.
The name of the custom language model.
The time the custom language model was created.
The most recent time the custom language model was modified.
The language code you used to create your custom language model.
The Amazon Transcribe standard language model, or base model used to create the custom language model.
The creation status of a custom language model. When the status is COMPLETED the model is ready for use.
Whether the base model used for the custom language model is up to date. If this field is true then you are running the most up-to-date version of the base model in your custom language model.
The reason why the custom language model couldn't be created.
The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .
Exceptions
Retrieves information about a call analytics category.
See also: AWS API Documentation
Request Syntax
response = client.get_call_analytics_category(
CategoryName='string'
)
[REQUIRED]
The name of the category you want information about. This value is case sensitive.
{
'CategoryProperties': {
'CategoryName': 'string',
'Rules': [
{
'NonTalkTimeFilter': {
'Threshold': 123,
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'InterruptionFilter': {
'Threshold': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'TranscriptFilter': {
'TranscriptFilterType': 'EXACT',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False,
'Targets': [
'string',
]
},
'SentimentFilter': {
'Sentiments': [
'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
],
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False
}
},
],
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
The rules you've defined for a category.
The name of the call analytics category.
The rules used to create a call analytics category.
A condition in the call between the customer and the agent that you want to filter for.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: NonTalkTimeFilter, InterruptionFilter, TranscriptFilter, SentimentFilter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
A condition for a time period when neither the customer nor the agent was talking.
The duration of the period when neither the customer nor agent was talking.
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Set to TRUE to look for a time period when people were talking.
A condition for a time period when either the customer or agent was interrupting the other person.
The duration of the interruption.
Indicates whether the caller or customer was interrupting.
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Set to TRUE to look for a time period where there was no interruption.
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
A time range, set in seconds, between two points in the call.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Determines whether the customer or the agent is speaking the phrases that you've specified.
If TRUE , the rule that you specify is applied to everything except for the phrases that you specify.
The phrases that you're specifying for the transcript filter to match.
A condition that is applied to a particular customer sentiment.
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
The time range, measured in seconds, of the sentiment.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
The time range, set in percentages, that correspond to proportion of the call.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
A value that determines whether the sentiment belongs to the customer or the agent.
Set to TRUE to look for sentiments that weren't specified in the request.
A timestamp that shows when the call analytics category was created.
A timestamp that shows when the call analytics category was most recently updated.
Exceptions
Returns information about a call analytics job. To see the status of the job, check the CallAnalyticsJobStatus field. If the status is COMPLETED , the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.
See also: AWS API Documentation
Request Syntax
response = client.get_call_analytics_job(
CallAnalyticsJobName='string'
)
[REQUIRED]
The name of the analytics job you want information about. This value is case sensitive.
{
'CallAnalyticsJob': {
'CallAnalyticsJobName': 'string',
'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DataAccessRoleArn': 'string',
'IdentifiedLanguageScore': ...,
'Settings': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'LanguageModelName': 'string',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'LanguageOptions': [
'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'LanguageIdSettings': {
'string': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'LanguageModelName': 'string'
}
}
},
'ChannelDefinitions': [
{
'ChannelId': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER'
},
]
}
}
Response Structure
An object that contains the results of your call analytics job.
The name of the call analytics job.
The status of the analytics job.
If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages for additional information.
The sample rate, in Hertz, of the audio.
The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
Describes the input media file in a transcription request.
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Identifies the location of a transcription.
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
A timestamp that shows when the analytics job started processing.
A timestamp that shows when the analytics job was created.
A timestamp that shows when the analytics job was completed.
If the AnalyticsJobStatus is FAILED , this field contains information about why the job failed.
The FailureReason field can contain one of the following values:
The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified.
Provides information about the settings used to run a transcription job.
The name of a vocabulary to use when processing the call analytics job.
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag , the words matching your vocabulary filter are not masked or removed.
The structure used to describe a custom language model.
Settings for content redaction within a transcription job.
Request parameter that defines the entities to be redacted. The only accepted value is PII .
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
The language identification settings associated with your call analytics job. These settings include VocabularyName , VocabularyFilterName , and LanguageModelName .
Language-specific settings that can be specified when language identification is enabled.
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
A value that indicates the audio channel.
Indicates whether the person speaking on the audio channel is the agent or customer.
Exceptions
Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED , the job is finished. You find the results of the completed job in the TranscriptFileUri field.
See also: AWS API Documentation
Request Syntax
response = client.get_medical_transcription_job(
MedicalTranscriptionJobName='string'
)
[REQUIRED]
The name of the medical transcription job.
{
'MedicalTranscriptionJob': {
'MedicalTranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyName': 'string'
},
'ContentIdentificationType': 'PHI',
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
An object that contains the results of the medical transcription job.
The name for a given medical transcription job.
The completion status of a medical transcription job.
The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.
The format of the input media file.
Describes the input media file in a transcription request.
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
An object that contains the MedicalTranscript . The MedicalTranscript contains the TranscriptFileUri .
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
A timestamp that shows when the job started processing.
A timestamp that shows when the job was created.
A timestamp that shows when the job was completed.
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Object that contains object.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to 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 detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
The name of the vocabulary to use when processing a medical transcription job.
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI , you've configured the job to identify personal health information (PHI) in the transcription output.
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversation for a list of supported specialties.
The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical? .
A key:value pair assigned to a given medical transcription job.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
Exceptions
Retrieves information about a medical vocabulary.
See also: AWS API Documentation
Request Syntax
response = client.get_medical_vocabulary(
VocabularyName='string'
)
[REQUIRED]
The name of the vocabulary that you want information about. The value is case sensitive.
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DownloadUri': 'string'
}
Response Structure
The name of the vocabulary returned by Amazon Transcribe Medical.
The valid language code for your vocabulary entries.
The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
If the VocabularyState is FAILED , this field contains information about why the job failed.
The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
Exceptions
Create a paginator for an operation.
Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED , the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri .
See also: AWS API Documentation
Request Syntax
response = client.get_transcription_job(
TranscriptionJobName='string'
)
[REQUIRED]
The name of the job.
{
'TranscriptionJob': {
'TranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'VocabularyName': 'string',
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag'
},
'ModelSettings': {
'LanguageModelName': 'string'
},
'JobExecutionSettings': {
'AllowDeferredExecution': True|False,
'DataAccessRoleArn': 'string'
},
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'IdentifyLanguage': True|False,
'LanguageOptions': [
'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'IdentifiedLanguageScore': ...,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Subtitles': {
'Formats': [
'vtt'|'srt',
],
'SubtitleFileUris': [
'string',
]
},
'LanguageIdSettings': {
'string': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'LanguageModelName': 'string'
}
}
}
}
Response Structure
An object that contains the results of the transcription job.
The name of the transcription job.
The status of the transcription job.
The language code for the input speech.
The sample rate, in Hertz (Hz), of the audio track in the input media file.
The format of the input media file.
An object that describes the input media for the transcription job.
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
An object that describes the output of the transcription job.
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
A timestamp that shows when the job started processing.
A timestamp that shows when the job was created.
A timestamp that shows when the job completed.
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
The FailureReason field can contain one of the following values:
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
The name of a vocabulary to use when processing the transcription job.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to 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 detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag , the words matching your vocabulary filter are not masked or removed.
An object containing the details of your custom language model.
The name of your custom language model.
Provides information about how a transcription job is executed.
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
Note that job queuing is enabled by default for call analytics jobs.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
The Amazon Resource Name (ARN), in the form arn:partition:service:region:account-id:resource-type/resource-id , of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
An object that describes content redaction settings for the transcription job.
Request parameter that defines the entities to be redacted. The only accepted value is PII .
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
A value that shows if automatic language identification was enabled for a transcription job.
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
A key:value pair assigned to a given transcription job.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
Generate subtitles for your batch transcription job.
Specify the output format for your subtitle file; if you select both SRT and VTT formats, two output files are generated.
Choose the output location for your subtitle file. This location must be an S3 bucket.
Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include VocabularyName , VocabularyFilterName , and LanguageModelName .
Language-specific settings that can be specified when language identification is enabled.
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
Exceptions
Gets information about a vocabulary.
See also: AWS API Documentation
Request Syntax
response = client.get_vocabulary(
VocabularyName='string'
)
[REQUIRED]
The name of the vocabulary to return information about. The name is case sensitive.
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'VocabularyState': 'PENDING'|'READY'|'FAILED',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DownloadUri': 'string'
}
Response Structure
The name of the vocabulary to return.
The language code of the vocabulary entries.
The processing state of the vocabulary.
The date and time that the vocabulary was last modified.
If the VocabularyState field is FAILED , this field contains information about why the job failed.
The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
Exceptions
Returns information about a vocabulary filter.
See also: AWS API Documentation
Request Syntax
response = client.get_vocabulary_filter(
VocabularyFilterName='string'
)
[REQUIRED]
The name of the vocabulary filter for which to return information.
{
'VocabularyFilterName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'DownloadUri': 'string'
}
Response Structure
The name of the vocabulary filter.
The language code of the words in the vocabulary filter.
The date and time that the contents of the vocabulary filter were updated.
The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
Exceptions
Returns an object that can wait for some condition.
Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
See also: AWS API Documentation
Request Syntax
response = client.list_call_analytics_categories(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'Categories': [
{
'CategoryName': 'string',
'Rules': [
{
'NonTalkTimeFilter': {
'Threshold': 123,
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'InterruptionFilter': {
'Threshold': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'TranscriptFilter': {
'TranscriptFilterType': 'EXACT',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False,
'Targets': [
'string',
]
},
'SentimentFilter': {
'Sentiments': [
'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
],
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False
}
},
],
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more categories in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the operation to return the next page of analytics categories.
Categories (list) --
A list of objects containing information about analytics categories.
(dict) --
An object that contains the rules and additional information about a call analytics category.
CategoryName (string) --
The name of the call analytics category.
Rules (list) --
The rules used to create a call analytics category.
(dict) --
A condition in the call between the customer and the agent that you want to filter for.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: NonTalkTimeFilter, InterruptionFilter, TranscriptFilter, SentimentFilter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
NonTalkTimeFilter (dict) --
A condition for a time period when neither the customer nor the agent was talking.
Threshold (integer) --
The duration of the period when neither the customer nor agent was talking.
AbsoluteTimeRange (dict) --
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Negate (boolean) --
Set to TRUE to look for a time period when people were talking.
InterruptionFilter (dict) --
A condition for a time period when either the customer or agent was interrupting the other person.
Threshold (integer) --
The duration of the interruption.
ParticipantRole (string) --
Indicates whether the caller or customer was interrupting.
AbsoluteTimeRange (dict) --
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Negate (boolean) --
Set to TRUE to look for a time period where there was no interruption.
TranscriptFilter (dict) --
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
TranscriptFilterType (string) --
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
AbsoluteTimeRange (dict) --
A time range, set in seconds, between two points in the call.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
ParticipantRole (string) --
Determines whether the customer or the agent is speaking the phrases that you've specified.
Negate (boolean) --
If TRUE , the rule that you specify is applied to everything except for the phrases that you specify.
Targets (list) --
The phrases that you're specifying for the transcript filter to match.
SentimentFilter (dict) --
A condition that is applied to a particular customer sentiment.
Sentiments (list) --
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
AbsoluteTimeRange (dict) --
The time range, measured in seconds, of the sentiment.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
The time range, set in percentages, that correspond to proportion of the call.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
ParticipantRole (string) --
A value that determines whether the sentiment belongs to the customer or the agent.
Negate (boolean) --
Set to TRUE to look for sentiments that weren't specified in the request.
CreateTime (datetime) --
A timestamp that shows when the call analytics category was created.
LastUpdateTime (datetime) --
A timestamp that shows when the call analytics category was most recently updated.
Exceptions
List call analytics jobs with a specified status or substring that matches their names.
See also: AWS API Documentation
Request Syntax
response = client.list_call_analytics_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'CallAnalyticsJobSummaries': [
{
'CallAnalyticsJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string'
},
]
}
Response Structure
(dict) --
Status (string) --
When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
NextToken (string) --
The operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in your next request to the operation to return next page of jobs.
CallAnalyticsJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides summary information about a call analytics job.
CallAnalyticsJobName (string) --
The name of the call analytics job.
CreationTime (datetime) --
A timestamp that shows when the call analytics job was created.
StartTime (datetime) --
A timestamp that shows when the job began processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language of the transcript in the source audio file.
CallAnalyticsJobStatus (string) --
The status of the call analytics job.
FailureReason (string) --
If the CallAnalyticsJobStatus is FAILED , a description of the error.
Exceptions
Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.
See also: AWS API Documentation
Request Syntax
response = client.list_language_models(
StatusEquals='IN_PROGRESS'|'FAILED'|'COMPLETED',
NameContains='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'Models': [
{
'ModelName': 'string',
'CreateTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LanguageCode': 'en-US'|'hi-IN'|'es-US'|'en-GB'|'en-AU',
'BaseModelName': 'NarrowBand'|'WideBand',
'ModelStatus': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
'UpgradeAvailability': True|False,
'FailureReason': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'TuningDataS3Uri': 'string',
'DataAccessRoleArn': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the operation to return the next page of language models.
Models (list) --
A list of objects containing information about custom language models.
(dict) --
The structure used to describe a custom language model.
ModelName (string) --
The name of the custom language model.
CreateTime (datetime) --
The time the custom language model was created.
LastModifiedTime (datetime) --
The most recent time the custom language model was modified.
LanguageCode (string) --
The language code you used to create your custom language model.
BaseModelName (string) --
The Amazon Transcribe standard language model, or base model used to create the custom language model.
ModelStatus (string) --
The creation status of a custom language model. When the status is COMPLETED the model is ready for use.
UpgradeAvailability (boolean) --
Whether the base model used for the custom language model is up to date. If this field is true then you are running the most up-to-date version of the base model in your custom language model.
FailureReason (string) --
The reason why the custom language model couldn't be created.
InputDataConfig (dict) --
The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
S3Uri (string) --
The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
TuningDataS3Uri (string) --
The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .
Exceptions
Lists medical transcription jobs with a specified status or substring that matches their names.
See also: AWS API Documentation
Request Syntax
response = client.list_medical_transcription_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'MedicalTranscriptionJobSummaries': [
{
'MedicalTranscriptionJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string',
'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET',
'Specialty': 'PRIMARYCARE',
'ContentIdentificationType': 'PHI',
'Type': 'CONVERSATION'|'DICTATION'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested status of the medical transcription jobs returned.
NextToken (string) --
The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
MedicalTranscriptionJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides summary information about a transcription job.
MedicalTranscriptionJobName (string) --
The name of a medical transcription job.
CreationTime (datetime) --
A timestamp that shows when the medical transcription job was created.
StartTime (datetime) --
A timestamp that shows when the job began processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language of the transcript in the source audio file.
TranscriptionJobStatus (string) --
The status of the medical transcription job.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , a description of the error.
OutputLocationType (string) --
Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.
Specialty (string) --
The medical specialty of the transcription job. Refer to Transcribing a medical conversation for a list of supported specialties.
ContentIdentificationType (string) --
Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI , you've configured the transcription job to identify personal health information (PHI).
Type (string) --
The speech of the clinician in the input audio.
Exceptions
Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.
See also: AWS API Documentation
Request Syntax
response = client.list_medical_vocabularies(
NextToken='string',
MaxResults=123,
StateEquals='PENDING'|'READY'|'FAILED',
NameContains='string'
)
dict
Response Syntax
{
'Status': 'PENDING'|'READY'|'FAILED',
'NextToken': 'string',
'Vocabularies': [
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested vocabulary state.
NextToken (string) --
The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, include the token in the next request to the ListMedicalVocabularies operation .
Vocabularies (list) --
A list of objects that describe the vocabularies that match your search criteria.
(dict) --
Provides information about a custom vocabulary.
VocabularyName (string) --
The name of the vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last modified.
VocabularyState (string) --
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
Exceptions
Lists all tags associated with a given transcription job, vocabulary, or resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name ). Valid values for resource-type are: transcription-job , medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter , and language-model .
{
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Lists all tags associated with the given Amazon Resource Name (ARN).
Lists all tags associated with the given transcription job, vocabulary, or resource.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
Exceptions
Lists transcription jobs with the specified status.
See also: AWS API Documentation
Request Syntax
response = client.list_transcription_jobs(
Status='QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
JobNameContains='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Status': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'NextToken': 'string',
'TranscriptionJobSummaries': [
{
'TranscriptionJobName': 'string',
'CreationTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'FailureReason': 'string',
'OutputLocationType': 'CUSTOMER_BUCKET'|'SERVICE_BUCKET',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'ModelSettings': {
'LanguageModelName': 'string'
},
'IdentifyLanguage': True|False,
'IdentifiedLanguageScore': ...
},
]
}
Response Structure
(dict) --
Status (string) --
The requested status of the jobs returned.
NextToken (string) --
The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
TranscriptionJobSummaries (list) --
A list of objects containing summary information for a transcription job.
(dict) --
Provides a summary of information about a transcription job.
TranscriptionJobName (string) --
The name of the transcription job.
CreationTime (datetime) --
A timestamp that shows when the job was created.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
LanguageCode (string) --
The language code for the input speech.
TranscriptionJobStatus (string) --
The status of the transcription job. When the status is COMPLETED , use the GetTranscriptionJob operation to get the results of the transcription.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , a description of the error.
OutputLocationType (string) --
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.
ContentRedaction (dict) --
The content redaction settings of the transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII .
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
ModelSettings (dict) --
The object used to call your custom language model to your transcription job.
LanguageModelName (string) --
The name of your custom language model.
IdentifyLanguage (boolean) --
Whether automatic language identification was enabled for a transcription job.
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
Exceptions
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
See also: AWS API Documentation
Request Syntax
response = client.list_vocabularies(
NextToken='string',
MaxResults=123,
StateEquals='PENDING'|'READY'|'FAILED',
NameContains='string'
)
dict
Response Syntax
{
'Status': 'PENDING'|'READY'|'FAILED',
'NextToken': 'string',
'Vocabularies': [
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
},
]
}
Response Structure
(dict) --
Status (string) --
The requested vocabulary state.
NextToken (string) --
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.
Vocabularies (list) --
A list of objects that describe the vocabularies that match the search criteria in the request.
(dict) --
Provides information about a custom vocabulary.
VocabularyName (string) --
The name of the vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last modified.
VocabularyState (string) --
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
Exceptions
Gets information about vocabulary filters.
See also: AWS API Documentation
Request Syntax
response = client.list_vocabulary_filters(
NextToken='string',
MaxResults=123,
NameContains='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'VocabularyFilters': [
{
'VocabularyFilterName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The ListVocabularyFilters operation returns a page of collections at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularyFilters operation to return in the next page of jobs.
VocabularyFilters (list) --
The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
(dict) --
Provides information about a vocabulary filter.
VocabularyFilterName (string) --
The name of the vocabulary filter. The name must be unique in the account that holds the filter.
LanguageCode (string) --
The language code of the words in the vocabulary filter.
LastModifiedTime (datetime) --
The date and time that the vocabulary was last updated.
Exceptions
Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
See also: AWS API Documentation
Request Syntax
response = client.start_call_analytics_job(
CallAnalyticsJobName='string',
Media={
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
OutputLocation='string',
OutputEncryptionKMSKeyId='string',
DataAccessRoleArn='string',
Settings={
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'LanguageModelName': 'string',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'LanguageOptions': [
'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'LanguageIdSettings': {
'string': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'LanguageModelName': 'string'
}
}
},
ChannelDefinitions=[
{
'ChannelId': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER'
},
]
)
[REQUIRED]
The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.
[REQUIRED]
Describes the input media file in a transcription request.
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.
You use either of the following to identify an Amazon Web Services KMS key in the current account:
You can use either of the following to identify a KMS key in the current account or another account:
If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputLocation parameter.
[REQUIRED]
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.
A Settings object that provides optional settings for a call analytics job.
The name of a vocabulary to use when processing the call analytics job.
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag , the words matching your vocabulary filter are not masked or removed.
The structure used to describe a custom language model.
Settings for content redaction within a transcription job.
Request parameter that defines the entities to be redacted. The only accepted value is PII .
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
The language identification settings associated with your call analytics job. These settings include VocabularyName , VocabularyFilterName , and LanguageModelName .
Language-specific settings that can be specified when language identification is enabled.
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
A value that indicates the audio channel.
Indicates whether the person speaking on the audio channel is the agent or customer.
dict
Response Syntax
{
'CallAnalyticsJob': {
'CallAnalyticsJobName': 'string',
'CallAnalyticsJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'DataAccessRoleArn': 'string',
'IdentifiedLanguageScore': ...,
'Settings': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'LanguageModelName': 'string',
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'LanguageOptions': [
'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'LanguageIdSettings': {
'string': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'LanguageModelName': 'string'
}
}
},
'ChannelDefinitions': [
{
'ChannelId': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER'
},
]
}
}
Response Structure
(dict) --
CallAnalyticsJob (dict) --
An object containing the details of the asynchronous call analytics job.
CallAnalyticsJobName (string) --
The name of the call analytics job.
CallAnalyticsJobStatus (string) --
The status of the analytics job.
LanguageCode (string) --
If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages for additional information.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the audio.
MediaFormat (string) --
The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4
s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
Identifies the location of a transcription.
TranscriptFileUri (string) --
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
RedactedTranscriptFileUri (string) --
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
StartTime (datetime) --
A timestamp that shows when the analytics job started processing.
CreationTime (datetime) --
A timestamp that shows when the analytics job was created.
CompletionTime (datetime) --
A timestamp that shows when the analytics job was completed.
FailureReason (string) --
If the AnalyticsJobStatus is FAILED , this field contains information about why the job failed.
The FailureReason field can contain one of the following values:
DataAccessRoleArn (string) --
The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified.
Settings (dict) --
Provides information about the settings used to run a transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the call analytics job.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag , the words matching your vocabulary filter are not masked or removed.
LanguageModelName (string) --
The structure used to describe a custom language model.
ContentRedaction (dict) --
Settings for content redaction within a transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII .
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
LanguageOptions (list) --
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
LanguageIdSettings (dict) --
The language identification settings associated with your call analytics job. These settings include VocabularyName , VocabularyFilterName , and LanguageModelName .
(string) --
(dict) --
Language-specific settings that can be specified when language identification is enabled.
VocabularyName (string) --
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
VocabularyFilterName (string) --
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
LanguageModelName (string) --
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
ChannelDefinitions (list) --
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
(dict) --
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
ChannelId (integer) --
A value that indicates the audio channel.
ParticipantRole (string) --
Indicates whether the person speaking on the audio channel is the agent or customer.
Exceptions
Starts a batch job to transcribe medical speech to text.
See also: AWS API Documentation
Request Syntax
response = client.start_medical_transcription_job(
MedicalTranscriptionJobName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
MediaSampleRateHertz=123,
MediaFormat='mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
Media={
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
OutputBucketName='string',
OutputKey='string',
OutputEncryptionKMSKeyId='string',
KMSEncryptionContext={
'string': 'string'
},
Settings={
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyName': 'string'
},
ContentIdentificationType='PHI',
Specialty='PRIMARYCARE',
Type='CONVERSATION'|'DICTATION',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the medical transcription job. You can't use the strings ". " or ".. " by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
[REQUIRED]
The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
[REQUIRED]
Describes the input media file in a transcription request.
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
[REQUIRED]
The Amazon S3 location where the transcription is stored.
You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob , the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles .
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
You can use either of the following to identify a KMS key in the current account or another account:
If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
Optional settings for the medical transcription job.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to 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 detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
The name of the vocabulary to use when processing a medical transcription job.
[REQUIRED]
The medical specialty of any clinician speaking in the input media.
[REQUIRED]
The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
Add tags to an Amazon Transcribe medical transcription job.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{
'MedicalTranscriptionJob': {
'MedicalTranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyName': 'string'
},
'ContentIdentificationType': 'PHI',
'Specialty': 'PRIMARYCARE',
'Type': 'CONVERSATION'|'DICTATION',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
MedicalTranscriptionJob (dict) --
A batch job submitted to transcribe medical speech to text.
MedicalTranscriptionJobName (string) --
The name for a given medical transcription job.
TranscriptionJobStatus (string) --
The completion status of a medical transcription job.
LanguageCode (string) --
The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
Describes the input media file in a transcription request.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4
s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
An object that contains the MedicalTranscript . The MedicalTranscript contains the TranscriptFileUri .
TranscriptFileUri (string) --
The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job was completed.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Settings (dict) --
Object that contains object.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
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 detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
ShowAlternatives (boolean) --
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyName (string) --
The name of the vocabulary to use when processing a medical transcription job.
ContentIdentificationType (string) --
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI , you've configured the job to identify personal health information (PHI) in the transcription output.
Specialty (string) --
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversation for a list of supported specialties.
Type (string) --
The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical? .
Tags (list) --
A key:value pair assigned to a given medical transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) --
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) --
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
Exceptions
Starts an asynchronous job to transcribe speech to text.
See also: AWS API Documentation
Request Syntax
response = client.start_transcription_job(
TranscriptionJobName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
MediaSampleRateHertz=123,
MediaFormat='mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
Media={
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
OutputBucketName='string',
OutputKey='string',
OutputEncryptionKMSKeyId='string',
KMSEncryptionContext={
'string': 'string'
},
Settings={
'VocabularyName': 'string',
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag'
},
ModelSettings={
'LanguageModelName': 'string'
},
JobExecutionSettings={
'AllowDeferredExecution': True|False,
'DataAccessRoleArn': 'string'
},
ContentRedaction={
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
IdentifyLanguage=True|False,
LanguageOptions=[
'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
Subtitles={
'Formats': [
'vtt'|'srt',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
LanguageIdSettings={
'string': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'LanguageModelName': 'string'
}
}
)
[REQUIRED]
The name of the job. You can't use the strings ". " or ".. " by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
[REQUIRED]
An object that describes the input media for a transcription job.
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
The location where the transcription is stored.
If you set the OutputBucketName , Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri . If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri . The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles .
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName , Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
You can use either of the following to identify a KMS key in the current account:
You can use either of the following to identify a KMS key in the current account or another account:
If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
A Settings object that provides optional settings for a transcription job.
The name of a vocabulary to use when processing the transcription job.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to 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 detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag , the words matching your vocabulary filter are not masked or removed.
Choose the custom language model you use for your transcription job in this parameter.
The name of your custom language model.
Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
Note that job queuing is enabled by default for call analytics jobs.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
The Amazon Resource Name (ARN), in the form arn:partition:service:region:account-id:resource-type/resource-id , of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
An object that contains the request parameters for content redaction.
Request parameter that defines the entities to be redacted. The only accepted value is PII .
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
Add subtitles to your batch transcription job.
Specify the output format for your subtitle file.
Add tags to an Amazon Transcribe transcription job.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
The language identification settings associated with your transcription job. These settings include VocabularyName , VocabularyFilterName , and LanguageModelName .
Language-specific settings that can be specified when language identification is enabled.
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
dict
Response Syntax
{
'TranscriptionJob': {
'TranscriptionJobName': 'string',
'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'MediaSampleRateHertz': 123,
'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm',
'Media': {
'MediaFileUri': 'string',
'RedactedMediaFileUri': 'string'
},
'Transcript': {
'TranscriptFileUri': 'string',
'RedactedTranscriptFileUri': 'string'
},
'StartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Settings': {
'VocabularyName': 'string',
'ShowSpeakerLabels': True|False,
'MaxSpeakerLabels': 123,
'ChannelIdentification': True|False,
'ShowAlternatives': True|False,
'MaxAlternatives': 123,
'VocabularyFilterName': 'string',
'VocabularyFilterMethod': 'remove'|'mask'|'tag'
},
'ModelSettings': {
'LanguageModelName': 'string'
},
'JobExecutionSettings': {
'AllowDeferredExecution': True|False,
'DataAccessRoleArn': 'string'
},
'ContentRedaction': {
'RedactionType': 'PII',
'RedactionOutput': 'redacted'|'redacted_and_unredacted'
},
'IdentifyLanguage': True|False,
'LanguageOptions': [
'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
],
'IdentifiedLanguageScore': ...,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Subtitles': {
'Formats': [
'vtt'|'srt',
],
'SubtitleFileUris': [
'string',
]
},
'LanguageIdSettings': {
'string': {
'VocabularyName': 'string',
'VocabularyFilterName': 'string',
'LanguageModelName': 'string'
}
}
}
}
Response Structure
(dict) --
TranscriptionJob (dict) --
An object containing details of the asynchronous transcription job.
TranscriptionJobName (string) --
The name of the transcription job.
TranscriptionJobStatus (string) --
The status of the transcription job.
LanguageCode (string) --
The language code for the input speech.
MediaSampleRateHertz (integer) --
The sample rate, in Hertz (Hz), of the audio track in the input media file.
MediaFormat (string) --
The format of the input media file.
Media (dict) --
An object that describes the input media for the transcription job.
MediaFileUri (string) --
The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
s3://AWSDOC-EXAMPLE-BUCKET/example.mp4
s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
RedactedMediaFileUri (string) --
The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
Transcript (dict) --
An object that describes the output of the transcription job.
TranscriptFileUri (string) --
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
RedactedTranscriptFileUri (string) --
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
StartTime (datetime) --
A timestamp that shows when the job started processing.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job completed.
FailureReason (string) --
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
The FailureReason field can contain one of the following values:
Settings (dict) --
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
VocabularyName (string) --
The name of a vocabulary to use when processing the transcription job.
ShowSpeakerLabels (boolean) --
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
MaxSpeakerLabels (integer) --
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
ChannelIdentification (boolean) --
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 detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException .
ShowAlternatives (boolean) --
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
MaxAlternatives (integer) --
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
VocabularyFilterName (string) --
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
VocabularyFilterMethod (string) --
Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag , the words matching your vocabulary filter are not masked or removed.
ModelSettings (dict) --
An object containing the details of your custom language model.
LanguageModelName (string) --
The name of your custom language model.
JobExecutionSettings (dict) --
Provides information about how a transcription job is executed.
AllowDeferredExecution (boolean) --
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
Note that job queuing is enabled by default for call analytics jobs.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN), in the form arn:partition:service:region:account-id:resource-type/resource-id , of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
ContentRedaction (dict) --
An object that describes content redaction settings for the transcription job.
RedactionType (string) --
Request parameter that defines the entities to be redacted. The only accepted value is PII .
RedactionOutput (string) --
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
IdentifyLanguage (boolean) --
A value that shows if automatic language identification was enabled for a transcription job.
LanguageOptions (list) --
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
IdentifiedLanguageScore (float) --
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
Tags (list) --
A key:value pair assigned to a given transcription job.
(dict) --
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
Key (string) --
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) --
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
Subtitles (dict) --
Generate subtitles for your batch transcription job.
Formats (list) --
Specify the output format for your subtitle file; if you select both SRT and VTT formats, two output files are generated.
SubtitleFileUris (list) --
Choose the output location for your subtitle file. This location must be an S3 bucket.
LanguageIdSettings (dict) --
Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include VocabularyName , VocabularyFilterName , and LanguageModelName .
(string) --
(dict) --
Language-specific settings that can be specified when language identification is enabled.
VocabularyName (string) --
The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
VocabularyFilterName (string) --
The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
LanguageModelName (string) --
The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
Exceptions
Tags an Amazon Transcribe resource with the given list of tags.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name ). Valid values for resource-type are: transcription-job , medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter , and language-model .
[REQUIRED]
The tags you are assigning to a given Amazon Transcribe resource.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes specified tags from a specified Amazon Transcribe resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name ). Valid values for resource-type are: transcription-job , medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter , and language-model .
[REQUIRED]
A list of tag keys you want to remove from a specified Amazon Transcribe resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates the call analytics category with new values. The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.
See also: AWS API Documentation
Request Syntax
response = client.update_call_analytics_category(
CategoryName='string',
Rules=[
{
'NonTalkTimeFilter': {
'Threshold': 123,
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'InterruptionFilter': {
'Threshold': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'TranscriptFilter': {
'TranscriptFilterType': 'EXACT',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False,
'Targets': [
'string',
]
},
'SentimentFilter': {
'Sentiments': [
'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
],
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False
}
},
]
)
[REQUIRED]
The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics category with the same name as a previous category you will receive a ConflictException error.
[REQUIRED]
The rules used for the updated analytics category. The rules that you provide in this field replace the ones that are currently being used.
A condition in the call between the customer and the agent that you want to filter for.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: NonTalkTimeFilter, InterruptionFilter, TranscriptFilter, SentimentFilter.
A condition for a time period when neither the customer nor the agent was talking.
The duration of the period when neither the customer nor agent was talking.
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Set to TRUE to look for a time period when people were talking.
A condition for a time period when either the customer or agent was interrupting the other person.
The duration of the interruption.
Indicates whether the caller or customer was interrupting.
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Set to TRUE to look for a time period where there was no interruption.
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
A time range, set in seconds, between two points in the call.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Determines whether the customer or the agent is speaking the phrases that you've specified.
If TRUE , the rule that you specify is applied to everything except for the phrases that you specify.
The phrases that you're specifying for the transcript filter to match.
A condition that is applied to a particular customer sentiment.
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
The time range, measured in seconds, of the sentiment.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
The time range, set in percentages, that correspond to proportion of the call.
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
A value that determines whether the sentiment belongs to the customer or the agent.
Set to TRUE to look for sentiments that weren't specified in the request.
dict
Response Syntax
{
'CategoryProperties': {
'CategoryName': 'string',
'Rules': [
{
'NonTalkTimeFilter': {
'Threshold': 123,
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'InterruptionFilter': {
'Threshold': 123,
'ParticipantRole': 'AGENT'|'CUSTOMER',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'Negate': True|False
},
'TranscriptFilter': {
'TranscriptFilterType': 'EXACT',
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False,
'Targets': [
'string',
]
},
'SentimentFilter': {
'Sentiments': [
'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
],
'AbsoluteTimeRange': {
'StartTime': 123,
'EndTime': 123,
'First': 123,
'Last': 123
},
'RelativeTimeRange': {
'StartPercentage': 123,
'EndPercentage': 123,
'First': 123,
'Last': 123
},
'ParticipantRole': 'AGENT'|'CUSTOMER',
'Negate': True|False
}
},
],
'CreateTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
CategoryProperties (dict) --
The attributes describing the analytics category. You can see information such as the rules that you've used to update the category and when the category was originally created.
CategoryName (string) --
The name of the call analytics category.
Rules (list) --
The rules used to create a call analytics category.
(dict) --
A condition in the call between the customer and the agent that you want to filter for.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: NonTalkTimeFilter, InterruptionFilter, TranscriptFilter, SentimentFilter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
NonTalkTimeFilter (dict) --
A condition for a time period when neither the customer nor the agent was talking.
Threshold (integer) --
The duration of the period when neither the customer nor agent was talking.
AbsoluteTimeRange (dict) --
An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Negate (boolean) --
Set to TRUE to look for a time period when people were talking.
InterruptionFilter (dict) --
A condition for a time period when either the customer or agent was interrupting the other person.
Threshold (integer) --
The duration of the interruption.
ParticipantRole (string) --
Indicates whether the caller or customer was interrupting.
AbsoluteTimeRange (dict) --
An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
Negate (boolean) --
Set to TRUE to look for a time period where there was no interruption.
TranscriptFilter (dict) --
A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase "I want to speak to the manager", only that exact phrase will be returned.
TranscriptFilterType (string) --
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
AbsoluteTimeRange (dict) --
A time range, set in seconds, between two points in the call.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
ParticipantRole (string) --
Determines whether the customer or the agent is speaking the phrases that you've specified.
Negate (boolean) --
If TRUE , the rule that you specify is applied to everything except for the phrases that you specify.
Targets (list) --
The phrases that you're specifying for the transcript filter to match.
SentimentFilter (dict) --
A condition that is applied to a particular customer sentiment.
Sentiments (list) --
An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
AbsoluteTimeRange (dict) --
The time range, measured in seconds, of the sentiment.
StartTime (integer) --
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
EndTime (integer) --
A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
First (integer) --
A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000 , the time range is set to the first 100,000 milliseconds of the call.
Last (integer) --
A time range from the value that you've specified to the end of the call. For example, if you specify 100000 , the time range is set to the last 100,000 milliseconds of the call.
RelativeTimeRange (dict) --
The time range, set in percentages, that correspond to proportion of the call.
StartPercentage (integer) --
A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
EndPercentage (integer) --
A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
First (integer) --
A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000 , the time range is set for the first 120,000 milliseconds of the call.
Last (integer) --
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000 , the time range is set for the last 120,000 milliseconds of the call.
ParticipantRole (string) --
A value that determines whether the sentiment belongs to the customer or the agent.
Negate (boolean) --
Set to TRUE to look for sentiments that weren't specified in the request.
CreateTime (datetime) --
A timestamp that shows when the call analytics category was created.
LastUpdateTime (datetime) --
A timestamp that shows when the call analytics category was most recently updated.
Exceptions
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.
See also: AWS API Documentation
Request Syntax
response = client.update_medical_vocabulary(
VocabularyName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
VocabularyFileUri='string'
)
[REQUIRED]
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a ConflictException error.
[REQUIRED]
The language code of the language used for the entries in the updated vocabulary. U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.
The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide .
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies .
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the updated vocabulary.
LanguageCode (string) --
The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
LastModifiedTime (datetime) --
The date and time that the vocabulary was updated.
VocabularyState (string) --
The processing state of the update to the vocabulary. When the VocabularyState field is READY , the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.
Exceptions
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
See also: AWS API Documentation
Request Syntax
response = client.update_vocabulary(
VocabularyName='string',
LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
Phrases=[
'string',
],
VocabularyFileUri='string'
)
[REQUIRED]
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
[REQUIRED]
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see Supported languages .
An array of strings containing the vocabulary entries.
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
For more information about custom vocabularies, see Custom Vocabularies .
dict
Response Syntax
{
'VocabularyName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1),
'VocabularyState': 'PENDING'|'READY'|'FAILED'
}
Response Structure
(dict) --
VocabularyName (string) --
The name of the vocabulary that was updated.
LanguageCode (string) --
The language code of the vocabulary entries.
LastModifiedTime (datetime) --
The date and time that the vocabulary was updated.
VocabularyState (string) --
The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
Exceptions
Updates a vocabulary filter with a new list of filtered words.
See also: AWS API Documentation
Request Syntax
response = client.update_vocabulary_filter(
VocabularyFilterName='string',
Words=[
'string',
],
VocabularyFilterFileUri='string'
)
[REQUIRED]
The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .
If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies .
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
dict
Response Syntax
{
'VocabularyFilterName': 'string',
'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'cy-GB'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'ga-IE'|'gd-GB'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ',
'LastModifiedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
VocabularyFilterName (string) --
The name of the updated vocabulary filter.
LanguageCode (string) --
The language code of the words in the vocabulary filter.
LastModifiedTime (datetime) --
The date and time that the vocabulary filter was updated.
Exceptions
The available paginators are: