@Generated(value="software.amazon.awssdk:codegen") public final class CallAnalyticsJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>
Describes an asynchronous analytics job that was created with the StartAnalyticsJob operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CallAnalyticsJob.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CallAnalyticsJob.Builder |
builder() |
String |
callAnalyticsJobName()
The name of the call analytics job.
|
CallAnalyticsJobStatus |
callAnalyticsJobStatus()
The status of the analytics job.
|
String |
callAnalyticsJobStatusAsString()
The status of the analytics job.
|
List<ChannelDefinition> |
channelDefinitions()
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the
customer's audio.
|
Instant |
completionTime()
A timestamp that shows when the analytics job was completed.
|
Instant |
creationTime()
A timestamp that shows when the analytics job was created.
|
String |
dataAccessRoleArn()
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
failureReason()
If the
AnalyticsJobStatus is FAILED, this field contains information about why the job
failed. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasChannelDefinitions()
For responses, this returns true if the service returned a value for the ChannelDefinitions property.
|
int |
hashCode() |
Float |
identifiedLanguageScore()
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source
audio.
|
LanguageCode |
languageCode()
If you know the language spoken between the customer and the agent, specify a language code for this field.
|
String |
languageCodeAsString()
If you know the language spoken between the customer and the agent, specify a language code for this field.
|
Media |
media()
Returns the value of the Media property for this object.
|
MediaFormat |
mediaFormat()
The format of the input audio file.
|
String |
mediaFormatAsString()
The format of the input audio file.
|
Integer |
mediaSampleRateHertz()
The sample rate, in Hertz, of the audio.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CallAnalyticsJob.Builder> |
serializableBuilderClass() |
CallAnalyticsJobSettings |
settings()
Provides information about the settings used to run a transcription job.
|
Instant |
startTime()
A timestamp that shows when the analytics job started processing.
|
CallAnalyticsJob.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Transcript |
transcript()
Returns the value of the Transcript property for this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String callAnalyticsJobName()
The name of the call analytics job.
public final CallAnalyticsJobStatus callAnalyticsJobStatus()
The status of the analytics job.
If the service returns an enum value that is not available in the current SDK version,
callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from callAnalyticsJobStatusAsString().
CallAnalyticsJobStatuspublic final String callAnalyticsJobStatusAsString()
The status of the analytics job.
If the service returns an enum value that is not available in the current SDK version,
callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from callAnalyticsJobStatusAsString().
CallAnalyticsJobStatuspublic final 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.
If the service returns an enum value that is not available in the current SDK version, languageCode will
return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
languageCodeAsString().
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.
LanguageCodepublic final String languageCodeAsString()
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 the service returns an enum value that is not available in the current SDK version, languageCode will
return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
languageCodeAsString().
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.
LanguageCodepublic final Integer mediaSampleRateHertz()
The sample rate, in Hertz, of the audio.
public final 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.
If the service returns an enum value that is not available in the current SDK version, mediaFormat will
return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
mediaFormatAsString().
MediaFormatpublic final String mediaFormatAsString()
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.
If the service returns an enum value that is not available in the current SDK version, mediaFormat will
return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
mediaFormatAsString().
MediaFormatpublic final Media media()
public final Transcript transcript()
public final Instant startTime()
A timestamp that shows when the analytics job started processing.
public final Instant creationTime()
A timestamp that shows when the analytics job was created.
public final Instant completionTime()
A timestamp that shows when the analytics job was completed.
public final 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.
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 final String dataAccessRoleArn()
The Amazon Resource Number (ARN) that you use to get access to the analytics job.
public final 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
public final CallAnalyticsJobSettings settings()
Provides information about the settings used to run a transcription job.
public final boolean hasChannelDefinitions()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<ChannelDefinition> channelDefinitions()
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasChannelDefinitions() method.
public CallAnalyticsJob.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>public static CallAnalyticsJob.Builder builder()
public static Class<? extends CallAnalyticsJob.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2021. All rights reserved.