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

Interface CallAnalyticsJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>, SdkBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>, SdkPojo
Enclosing class:
CallAnalyticsJob
public static interface CallAnalyticsJob.Builder extends SdkPojo, CopyableBuilder<CallAnalyticsJob.Builder,CallAnalyticsJob>

  • Method Details

    • callAnalyticsJobName

      CallAnalyticsJob.Builder callAnalyticsJobName(String callAnalyticsJobName)

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

      Parameters:
      callAnalyticsJobName - The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • callAnalyticsJobStatus

      CallAnalyticsJob.Builder callAnalyticsJobStatus(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • callAnalyticsJobStatus

      CallAnalyticsJob.Builder callAnalyticsJobStatus(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • callAnalyticsJobDetails

      CallAnalyticsJob.Builder callAnalyticsJobDetails(CallAnalyticsJobDetails callAnalyticsJobDetails)

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

      Parameters:
      callAnalyticsJobDetails - Provides detailed information about a call analytics job, including information about skipped analytics features.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • callAnalyticsJobDetails

      default CallAnalyticsJob.Builder callAnalyticsJobDetails(Consumer<CallAnalyticsJobDetails.Builder> callAnalyticsJobDetails)

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

      This is a convenience method that creates an instance of the CallAnalyticsJobDetails.Builder avoiding the need to create one manually via CallAnalyticsJobDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to callAnalyticsJobDetails(CallAnalyticsJobDetails).

      Parameters:
      callAnalyticsJobDetails - a consumer that will call methods on CallAnalyticsJobDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      CallAnalyticsJob.Builder languageCode(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      CallAnalyticsJob.Builder languageCode(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaSampleRateHertz

      CallAnalyticsJob.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

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

      Parameters:
      mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mediaFormat

      CallAnalyticsJob.Builder mediaFormat(String mediaFormat)

      The format of the input media file.

      Parameters:
      mediaFormat - The format of the input media file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaFormat

      CallAnalyticsJob.Builder mediaFormat(MediaFormat mediaFormat)

      The format of the input media file.

      Parameters:
      mediaFormat - The format of the input media file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • media

      CallAnalyticsJob.Builder media(Media media)

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

      Parameters:
      media - Provides the Amazon S3 location of the media file you used in your Call Analytics request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • media

      default CallAnalyticsJob.Builder media(Consumer<Media.Builder> media)

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

      This is a convenience method that creates an instance of the Media.Builder avoiding the need to create one manually via Media.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to media(Media).

      Parameters:
      media - a consumer that will call methods on Media.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • transcript

      CallAnalyticsJob.Builder transcript(Transcript transcript)
      Sets the value of the Transcript property for this object.
      Parameters:
      transcript - The new value for the Transcript property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transcript

      default CallAnalyticsJob.Builder transcript(Consumer<Transcript.Builder> transcript)
      Sets the value of the Transcript property for this object. This is a convenience method that creates an instance of the Transcript.Builder avoiding the need to create one manually via Transcript.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transcript(Transcript).

      Parameters:
      transcript - a consumer that will call methods on Transcript.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTime

      CallAnalyticsJob.Builder startTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      CallAnalyticsJob.Builder creationTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • completionTime

      CallAnalyticsJob.Builder completionTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • failureReason

      CallAnalyticsJob.Builder failureReason(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dataAccessRoleArn

      CallAnalyticsJob.Builder dataAccessRoleArn(String dataAccessRoleArn)

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

      Parameters:
      dataAccessRoleArn - The Amazon Resource Name (ARN) you included in your request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifiedLanguageScore

      CallAnalyticsJob.Builder identifiedLanguageScore(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • settings

      CallAnalyticsJob.Builder settings(CallAnalyticsJobSettings settings)

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

      Parameters:
      settings - Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • settings

      default CallAnalyticsJob.Builder settings(Consumer<CallAnalyticsJobSettings.Builder> settings)

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

      This is a convenience method that creates an instance of the CallAnalyticsJobSettings.Builder avoiding the need to create one manually via CallAnalyticsJobSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(CallAnalyticsJobSettings).

      Parameters:
      settings - a consumer that will call methods on CallAnalyticsJobSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channelDefinitions

      CallAnalyticsJob.Builder channelDefinitions(Collection<ChannelDefinition> channelDefinitions)

      Indicates which speaker is on which channel.

      Parameters:
      channelDefinitions - Indicates which speaker is on which channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelDefinitions

      CallAnalyticsJob.Builder channelDefinitions(ChannelDefinition... channelDefinitions)

      Indicates which speaker is on which channel.

      Parameters:
      channelDefinitions - Indicates which speaker is on which channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelDefinitions

      CallAnalyticsJob.Builder channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions)

      Indicates which speaker is on which channel.

      This is a convenience method that creates an instance of the ChannelDefinition.Builder avoiding the need to create one manually via ChannelDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to channelDefinitions(List<ChannelDefinition>).

      Parameters:
      channelDefinitions - a consumer that will call methods on ChannelDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: