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 Summary

Modifier and Type	Method and Description
CallAnalyticsJob.Builder	callAnalyticsJobName(String callAnalyticsJobName) The name of the call analytics job.
CallAnalyticsJob.Builder	callAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus) The status of the analytics job.
CallAnalyticsJob.Builder	callAnalyticsJobStatus(String callAnalyticsJobStatus) The status of the analytics job.
CallAnalyticsJob.Builder	channelDefinitions(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.Builder	channelDefinitions(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.Builder	channelDefinitions(Consumer<ChannelDefinition.Builder>... channelDefinitions) Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
CallAnalyticsJob.Builder	completionTime(Instant completionTime) A timestamp that shows when the analytics job was completed.
CallAnalyticsJob.Builder	creationTime(Instant creationTime) A timestamp that shows when the analytics job was created.
CallAnalyticsJob.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Number (ARN) that you use to get access to the analytics job.
CallAnalyticsJob.Builder	failureReason(String failureReason) If the AnalyticsJobStatus is FAILED, this field contains information about why the job failed.
CallAnalyticsJob.Builder	identifiedLanguageScore(Float identifiedLanguageScore) A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio.
CallAnalyticsJob.Builder	languageCode(LanguageCode languageCode) If you know the language spoken between the customer and the agent, specify a language code for this field.
CallAnalyticsJob.Builder	languageCode(String languageCode) If you know the language spoken between the customer and the agent, specify a language code for this field.
default CallAnalyticsJob.Builder	media(Consumer<Media.Builder> media) Sets the value of the Media property for this object.
CallAnalyticsJob.Builder	media(Media media) Sets the value of the Media property for this object.
CallAnalyticsJob.Builder	mediaFormat(MediaFormat mediaFormat) The format of the input audio file.
CallAnalyticsJob.Builder	mediaFormat(String mediaFormat) The format of the input audio file.
CallAnalyticsJob.Builder	mediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio.
CallAnalyticsJob.Builder	settings(CallAnalyticsJobSettings settings) Provides information about the settings used to run a transcription job.
default CallAnalyticsJob.Builder	settings(Consumer<CallAnalyticsJobSettings.Builder> settings) Provides information about the settings used to run a transcription job.
CallAnalyticsJob.Builder	startTime(Instant startTime) A timestamp that shows when the analytics job started processing.
default CallAnalyticsJob.Builder	transcript(Consumer<Transcript.Builder> transcript) Sets the value of the Transcript property for this object.
CallAnalyticsJob.Builder	transcript(Transcript transcript) Sets the value of the Transcript property for this object.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

callAnalyticsJobName

CallAnalyticsJob.Builder callAnalyticsJobName(String callAnalyticsJobName)

The name of the call analytics job.

Parameters:

callAnalyticsJobName - The name of the call analytics job.

Returns:

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

callAnalyticsJobStatus

CallAnalyticsJob.Builder callAnalyticsJobStatus(String callAnalyticsJobStatus)

The status of the analytics job.

Parameters:

callAnalyticsJobStatus - The status of the analytics job.

Returns:

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

See Also:

CallAnalyticsJobStatus, CallAnalyticsJobStatus

callAnalyticsJobStatus

CallAnalyticsJob.Builder callAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus)

The status of the analytics job.

Parameters:

callAnalyticsJobStatus - The status of the analytics job.

Returns:

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

See Also:

CallAnalyticsJobStatus, CallAnalyticsJobStatus

languageCode

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

Parameters:

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.

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

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

Parameters:

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.

Returns:

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

See Also:

LanguageCode, LanguageCode

mediaSampleRateHertz

CallAnalyticsJob.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

The sample rate, in Hertz, of the audio.

Parameters:

mediaSampleRateHertz - The sample rate, in Hertz, of the audio.

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 audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.

Parameters:

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.

Returns:

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

See Also:

MediaFormat, MediaFormat

mediaFormat

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

Parameters:

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.

Returns:

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

See Also:

MediaFormat, MediaFormat

media

CallAnalyticsJob.Builder media(Media media)

Sets the value of the Media property for this object.

Parameters:

media - The new value for the Media property for this object.

Returns:

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

media

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

Sets the value of the Media property for this object. This is a convenience 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:

media(Media)

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

transcript(Transcript)

startTime

CallAnalyticsJob.Builder startTime(Instant startTime)

A timestamp that shows when the analytics job started processing.

Parameters:

startTime - A timestamp that shows when the analytics job started processing.

Returns:

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

creationTime

CallAnalyticsJob.Builder creationTime(Instant creationTime)

A timestamp that shows when the analytics job was created.

Parameters:

creationTime - A timestamp that shows when the analytics job was created.

Returns:

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

completionTime

CallAnalyticsJob.Builder completionTime(Instant completionTime)

A timestamp that shows when the analytics job was completed.

Parameters:

completionTime - A timestamp that shows when the analytics job was completed.

Returns:

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

failureReason

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

Parameters:

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.

Returns:

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

dataAccessRoleArn

CallAnalyticsJob.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Number (ARN) that you use to get access to the analytics job.

Parameters:

dataAccessRoleArn - The Amazon Resource Number (ARN) that you use to get access to the analytics job.

Returns:

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

identifiedLanguageScore

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

Parameters:

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

Returns:

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

settings

CallAnalyticsJob.Builder settings(CallAnalyticsJobSettings settings)

Provides information about the settings used to run a transcription job.

Parameters:

settings - Provides information about the settings used to run a transcription job.

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 about the settings used to run a transcription job.

This is a convenience 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:

settings(CallAnalyticsJobSettings)

channelDefinitions

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

Parameters:

channelDefinitions - Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Returns:

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

channelDefinitions

CallAnalyticsJob.Builder channelDefinitions(ChannelDefinition... channelDefinitions)

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Parameters:

channelDefinitions - Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

Returns:

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

channelDefinitions

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

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #channelDefinitions(List).

Parameters:

channelDefinitions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#channelDefinitions(List)