@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CallAnalyticsJob extends Object implements Serializable, Cloneable, StructuredPojo
Describes an asynchronous analytics job that was created with the StartAnalyticsJob
operation.
Constructor and Description |
---|
CallAnalyticsJob() |
Modifier and Type | Method and Description |
---|---|
CallAnalyticsJob |
clone() |
boolean |
equals(Object obj) |
String |
getCallAnalyticsJobName()
The name of the call analytics job.
|
String |
getCallAnalyticsJobStatus()
The status of the analytics job.
|
List<ChannelDefinition> |
getChannelDefinitions()
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.
|
Date |
getCompletionTime()
A timestamp that shows when the analytics job was completed.
|
Date |
getCreationTime()
A timestamp that shows when the analytics job was created.
|
String |
getDataAccessRoleArn()
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
|
String |
getFailureReason()
If the
AnalyticsJobStatus is FAILED , this field contains information about why the job
failed. |
Float |
getIdentifiedLanguageScore()
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source
audio.
|
String |
getLanguageCode()
If you know the language spoken between the customer and the agent, specify a language code for this field.
|
Media |
getMedia() |
String |
getMediaFormat()
The format of the input audio file.
|
Integer |
getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio.
|
CallAnalyticsJobSettings |
getSettings()
Provides information about the settings used to run a transcription job.
|
Date |
getStartTime()
A timestamp that shows when the analytics job started processing.
|
Transcript |
getTranscript() |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCallAnalyticsJobName(String callAnalyticsJobName)
The name of the call analytics job.
|
void |
setCallAnalyticsJobStatus(String callAnalyticsJobStatus)
The status of the analytics job.
|
void |
setChannelDefinitions(Collection<ChannelDefinition> channelDefinitions)
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.
|
void |
setCompletionTime(Date completionTime)
A timestamp that shows when the analytics job was completed.
|
void |
setCreationTime(Date creationTime)
A timestamp that shows when the analytics job was created.
|
void |
setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
|
void |
setFailureReason(String failureReason)
If the
AnalyticsJobStatus is FAILED , this field contains information about why the job
failed. |
void |
setIdentifiedLanguageScore(Float identifiedLanguageScore)
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source
audio.
|
void |
setLanguageCode(String languageCode)
If you know the language spoken between the customer and the agent, specify a language code for this field.
|
void |
setMedia(Media media) |
void |
setMediaFormat(String mediaFormat)
The format of the input audio file.
|
void |
setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio.
|
void |
setSettings(CallAnalyticsJobSettings settings)
Provides information about the settings used to run a transcription job.
|
void |
setStartTime(Date startTime)
A timestamp that shows when the analytics job started processing.
|
void |
setTranscript(Transcript transcript) |
String |
toString()
Returns a string representation of this object.
|
CallAnalyticsJob |
withCallAnalyticsJobName(String callAnalyticsJobName)
The name of the call analytics job.
|
CallAnalyticsJob |
withCallAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus)
The status of the analytics job.
|
CallAnalyticsJob |
withCallAnalyticsJobStatus(String callAnalyticsJobStatus)
The status of the analytics job.
|
CallAnalyticsJob |
withChannelDefinitions(ChannelDefinition... channelDefinitions)
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.
|
CallAnalyticsJob |
withChannelDefinitions(Collection<ChannelDefinition> channelDefinitions)
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.
|
CallAnalyticsJob |
withCompletionTime(Date completionTime)
A timestamp that shows when the analytics job was completed.
|
CallAnalyticsJob |
withCreationTime(Date creationTime)
A timestamp that shows when the analytics job was created.
|
CallAnalyticsJob |
withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
|
CallAnalyticsJob |
withFailureReason(String failureReason)
If the
AnalyticsJobStatus is FAILED , this field contains information about why the job
failed. |
CallAnalyticsJob |
withIdentifiedLanguageScore(Float identifiedLanguageScore)
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source
audio.
|
CallAnalyticsJob |
withLanguageCode(LanguageCode languageCode)
If you know the language spoken between the customer and the agent, specify a language code for this field.
|
CallAnalyticsJob |
withLanguageCode(String languageCode)
If you know the language spoken between the customer and the agent, specify a language code for this field.
|
CallAnalyticsJob |
withMedia(Media media) |
CallAnalyticsJob |
withMediaFormat(MediaFormat mediaFormat)
The format of the input audio file.
|
CallAnalyticsJob |
withMediaFormat(String mediaFormat)
The format of the input audio file.
|
CallAnalyticsJob |
withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio.
|
CallAnalyticsJob |
withSettings(CallAnalyticsJobSettings settings)
Provides information about the settings used to run a transcription job.
|
CallAnalyticsJob |
withStartTime(Date startTime)
A timestamp that shows when the analytics job started processing.
|
CallAnalyticsJob |
withTranscript(Transcript transcript) |
public void setCallAnalyticsJobName(String callAnalyticsJobName)
The name of the call analytics job.
callAnalyticsJobName
- The name of the call analytics job.public String getCallAnalyticsJobName()
The name of the call analytics job.
public CallAnalyticsJob withCallAnalyticsJobName(String callAnalyticsJobName)
The name of the call analytics job.
callAnalyticsJobName
- The name of the call analytics job.public void setCallAnalyticsJobStatus(String callAnalyticsJobStatus)
The status of the analytics job.
callAnalyticsJobStatus
- The status of the analytics job.CallAnalyticsJobStatus
public String getCallAnalyticsJobStatus()
The status of the analytics job.
CallAnalyticsJobStatus
public CallAnalyticsJob withCallAnalyticsJobStatus(String callAnalyticsJobStatus)
The status of the analytics job.
callAnalyticsJobStatus
- The status of the analytics job.CallAnalyticsJobStatus
public CallAnalyticsJob withCallAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus)
The status of the analytics job.
callAnalyticsJobStatus
- The status of the analytics job.CallAnalyticsJobStatus
public void setLanguageCode(String languageCode)
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 and language-specific features for additional information.
languageCode
- 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 and language-specific features for additional information.
LanguageCode
public String getLanguageCode()
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 and language-specific features for additional information.
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 and language-specific features for additional information.
LanguageCode
public CallAnalyticsJob withLanguageCode(String languageCode)
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 and language-specific features for additional information.
languageCode
- 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 and language-specific features for additional information.
LanguageCode
public CallAnalyticsJob withLanguageCode(LanguageCode languageCode)
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 and language-specific features for additional information.
languageCode
- 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 and language-specific features for additional information.
LanguageCode
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio.
mediaSampleRateHertz
- The sample rate, in Hertz, of the audio.public Integer getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio.
public CallAnalyticsJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio.
mediaSampleRateHertz
- The sample rate, in Hertz, of the audio.public void setMediaFormat(String mediaFormat)
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.
mediaFormat
- 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.MediaFormat
public String getMediaFormat()
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.
MediaFormat
public CallAnalyticsJob withMediaFormat(String mediaFormat)
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.
mediaFormat
- 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.MediaFormat
public CallAnalyticsJob withMediaFormat(MediaFormat mediaFormat)
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.
mediaFormat
- 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.MediaFormat
public void setMedia(Media media)
media
- public Media getMedia()
public CallAnalyticsJob withMedia(Media media)
media
- public void setTranscript(Transcript transcript)
transcript
- public Transcript getTranscript()
public CallAnalyticsJob withTranscript(Transcript transcript)
transcript
- public void setStartTime(Date startTime)
A timestamp that shows when the analytics job started processing.
startTime
- A timestamp that shows when the analytics job started processing.public Date getStartTime()
A timestamp that shows when the analytics job started processing.
public CallAnalyticsJob withStartTime(Date startTime)
A timestamp that shows when the analytics job started processing.
startTime
- A timestamp that shows when the analytics job started processing.public void setCreationTime(Date creationTime)
A timestamp that shows when the analytics job was created.
creationTime
- A timestamp that shows when the analytics job was created.public Date getCreationTime()
A timestamp that shows when the analytics job was created.
public CallAnalyticsJob withCreationTime(Date creationTime)
A timestamp that shows when the analytics job was created.
creationTime
- A timestamp that shows when the analytics job was created.public void setCompletionTime(Date completionTime)
A timestamp that shows when the analytics job was completed.
completionTime
- A timestamp that shows when the analytics job was completed.public Date getCompletionTime()
A timestamp that shows when the analytics job was completed.
public CallAnalyticsJob withCompletionTime(Date completionTime)
A timestamp that shows when the analytics job was completed.
completionTime
- A timestamp that shows when the analytics job was completed.public void setFailureReason(String failureReason)
If the AnalyticsJobStatus
is FAILED
, this field contains information about why the job
failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
: The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
: The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000
Hertz.
The sample rate provided does not match the detected sample rate
: The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
: The size of your audio file is larger than what Amazon
Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe
Medical Guide.
Invalid number of channels: number of channels too large
: Your audio contains more channels than
Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical
Endpoints and Quotas in the Amazon Web
Services General Reference.
failureReason
- If the AnalyticsJobStatus
is FAILED
, this field contains information about why
the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in the MediaFormat
field of
the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
: The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure the two values match.
Invalid sample rate for audio file
: The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and
48,000 Hertz.
The sample rate provided does not match the detected sample rate
: The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
: The size of your audio file is larger than what
Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the
Amazon Transcribe Medical Guide.
Invalid number of channels: number of channels too large
: Your audio contains more channels
than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon
Transcribe Medical Endpoints and Quotas in the Amazon Web Services General
Reference.
public String getFailureReason()
If the AnalyticsJobStatus
is FAILED
, this field contains information about why the job
failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
: The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
: The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000
Hertz.
The sample rate provided does not match the detected sample rate
: The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
: The size of your audio file is larger than what Amazon
Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe
Medical Guide.
Invalid number of channels: number of channels too large
: Your audio contains more channels than
Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical
Endpoints and Quotas in the Amazon Web
Services General Reference.
AnalyticsJobStatus
is FAILED
, this field contains information about why
the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in the MediaFormat
field
of the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
: The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure the two values match.
Invalid sample rate for audio file
: The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and
48,000 Hertz.
The sample rate provided does not match the detected sample rate
: The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
: The size of your audio file is larger than what
Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the
Amazon Transcribe Medical Guide.
Invalid number of channels: number of channels too large
: Your audio contains more channels
than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon
Transcribe Medical Endpoints and Quotas in the Amazon Web Services General
Reference.
public CallAnalyticsJob withFailureReason(String failureReason)
If the AnalyticsJobStatus
is FAILED
, this field contains information about why the job
failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
: The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
: The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000
Hertz.
The sample rate provided does not match the detected sample rate
: The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
: The size of your audio file is larger than what Amazon
Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe
Medical Guide.
Invalid number of channels: number of channels too large
: Your audio contains more channels than
Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical
Endpoints and Quotas in the Amazon Web
Services General Reference.
failureReason
- If the AnalyticsJobStatus
is FAILED
, this field contains information about why
the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in the MediaFormat
field of
the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
: The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure the two values match.
Invalid sample rate for audio file
: The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and
48,000 Hertz.
The sample rate provided does not match the detected sample rate
: The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
: The size of your audio file is larger than what
Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the
Amazon Transcribe Medical Guide.
Invalid number of channels: number of channels too large
: Your audio contains more channels
than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon
Transcribe Medical Endpoints and Quotas in the Amazon Web Services General
Reference.
public void setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
dataAccessRoleArn
- The Amazon Resource Number (ARN) that you use to get access to the analytics job.public String getDataAccessRoleArn()
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
public CallAnalyticsJob withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
dataAccessRoleArn
- The Amazon Resource Number (ARN) that you use to get access to the analytics job.public void setIdentifiedLanguageScore(Float identifiedLanguageScore)
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
identifiedLanguageScore
- 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 identifiedpublic Float getIdentifiedLanguageScore()
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
public CallAnalyticsJob withIdentifiedLanguageScore(Float identifiedLanguageScore)
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
identifiedLanguageScore
- 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 identifiedpublic void setSettings(CallAnalyticsJobSettings settings)
Provides information about the settings used to run a transcription job.
settings
- Provides information about the settings used to run a transcription job.public CallAnalyticsJobSettings getSettings()
Provides information about the settings used to run a transcription job.
public CallAnalyticsJob withSettings(CallAnalyticsJobSettings settings)
Provides information about the settings used to run a transcription job.
settings
- Provides information about the settings used to run a transcription job.public List<ChannelDefinition> getChannelDefinitions()
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
public void setChannelDefinitions(Collection<ChannelDefinition> channelDefinitions)
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
channelDefinitions
- Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.public CallAnalyticsJob withChannelDefinitions(ChannelDefinition... channelDefinitions)
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
NOTE: This method appends the values to the existing list (if any). Use
setChannelDefinitions(java.util.Collection)
or withChannelDefinitions(java.util.Collection)
if
you want to override the existing values.
channelDefinitions
- Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.public CallAnalyticsJob withChannelDefinitions(Collection<ChannelDefinition> channelDefinitions)
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
channelDefinitions
- Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.public String toString()
toString
in class Object
Object.toString()
public CallAnalyticsJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.