Package software.amazon.awssdk.services.transcribe.model

Class CallAnalyticsJob

java.lang.Object
software.amazon.awssdk.services.transcribe.model.CallAnalyticsJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>
@Generated("software.amazon.awssdk:codegen") public final class CallAnalyticsJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>

Provides detailed information about a Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.

See Also:

  • Method Details

    • callAnalyticsJobName

      public final String callAnalyticsJobName()

      The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

      Returns:
      The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

    • callAnalyticsJobStatus

      public final CallAnalyticsJobStatus callAnalyticsJobStatus()

      Provides the status of the specified Call Analytics job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      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().

      Returns:
      Provides the status of the specified Call Analytics job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      See Also:

    • callAnalyticsJobStatusAsString

      public final String callAnalyticsJobStatusAsString()

      Provides the status of the specified Call Analytics job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      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().

      Returns:
      Provides the status of the specified Call Analytics job.

      If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

      See Also:

    • callAnalyticsJobDetails

      public final CallAnalyticsJobDetails callAnalyticsJobDetails()

      Provides detailed information about a call analytics job, including information about skipped analytics features.

      Returns:
      Provides detailed information about a call analytics job, including information about skipped analytics features.

    • languageCode

      public final LanguageCode languageCode()

      The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

      If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

      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().

      Returns:
      The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

      If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

      If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

      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().

      Returns:
      The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

      If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

      See Also:

    • mediaSampleRateHertz

      public final Integer mediaSampleRateHertz()

      The sample rate, in hertz, of the audio track in your input media file.

      Returns:
      The sample rate, in hertz, of the audio track in your input media file.

    • mediaFormat

      public final MediaFormat mediaFormat()

      The format of the input media file.

      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().

      Returns:
      The format of the input media file.
      See Also:

    • mediaFormatAsString

      public final String mediaFormatAsString()

      The format of the input media file.

      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().

      Returns:
      The format of the input media file.
      See Also:

    • media

      public final Media media()

      Provides the Amazon S3 location of the media file you used in your Call Analytics request.

      Returns:
      Provides the Amazon S3 location of the media file you used in your Call Analytics request.

    • transcript

      public final Transcript transcript()
      Returns the value of the Transcript property for this object.
      Returns:
      The value of the Transcript property for this object.

    • startTime

      public final Instant startTime()

      The date and time the specified Call Analytics job began processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified Call Analytics job began processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • creationTime

      public final Instant creationTime()

      The date and time the specified Call Analytics job request was made.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified Call Analytics job request was made.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

    • completionTime

      public final Instant completionTime()

      The date and time the specified Call Analytics job finished processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified Call Analytics job finished processing.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

    • failureReason

      public final String failureReason()

      If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

      The FailureReason field contains one of the following values:

      • Unsupported media format.

        The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

      • The media format provided does not match the detected media format.

        The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

      • Invalid sample rate for audio file.

        The sample rate specified in MediaSampleRateHertz 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

      • Invalid file size: file size too large.

        The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

      • Invalid number of channels: number of channels too large.

        Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

      Returns:
      If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

      The FailureReason field contains one of the following values:

      • Unsupported media format.

        The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

      • The media format provided does not match the detected media format.

        The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

      • Invalid sample rate for audio file.

        The sample rate specified in MediaSampleRateHertz 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

      • Invalid file size: file size too large.

        The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

      • Invalid number of channels: number of channels too large.

        Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The Amazon Resource Name (ARN) you included in your request.

      Returns:
      The Amazon Resource Name (ARN) you included in your request.

    • identifiedLanguageScore

      public final Float identifiedLanguageScore()

      The confidence score associated with the language identified in your media file.

      Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

      Returns:
      The confidence score associated with the language identified in your media file.

      Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

    • settings

      public final CallAnalyticsJobSettings settings()

      Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

      Returns:
      Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

    • hasChannelDefinitions

      public final boolean hasChannelDefinitions()
      For responses, this returns true if the service returned a value for the ChannelDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • channelDefinitions

      public final List<ChannelDefinition> channelDefinitions()

      Indicates which speaker is on which channel.

      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.

      Returns:
      Indicates which speaker is on which channel.

    • toBuilder

      public CallAnalyticsJob.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>
      Returns:
      a builder for type T

    • builder

      public static CallAnalyticsJob.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CallAnalyticsJob.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.