Interface UtteranceEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>, SdkBuilder<UtteranceEvent.Builder,UtteranceEvent>, SdkPojo
All Known Subinterfaces:
DefaultUtteranceEvent.Builder
Enclosing class:
UtteranceEvent
@Mutable @NotThreadSafe public static interface UtteranceEvent.Builder extends SdkPojo, CopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>

  • Method Details

    • utteranceId

      UtteranceEvent.Builder utteranceId(String utteranceId)

      The unique identifier that is associated with the specified UtteranceEvent.

      Parameters:
      utteranceId - The unique identifier that is associated with the specified UtteranceEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isPartial

      UtteranceEvent.Builder isPartial(Boolean isPartial)

      Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).

      Parameters:
      isPartial - Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantRole

      UtteranceEvent.Builder participantRole(String participantRole)

      Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

      Parameters:
      participantRole - Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • participantRole

      UtteranceEvent.Builder participantRole(ParticipantRole participantRole)

      Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

      Parameters:
      participantRole - Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • beginOffsetMillis

      UtteranceEvent.Builder beginOffsetMillis(Long beginOffsetMillis)

      The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

      Parameters:
      beginOffsetMillis - The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endOffsetMillis

      UtteranceEvent.Builder endOffsetMillis(Long endOffsetMillis)

      The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

      Parameters:
      endOffsetMillis - The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transcript

      UtteranceEvent.Builder transcript(String transcript)

      Contains transcribed text.

      Parameters:
      transcript - Contains transcribed text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      UtteranceEvent.Builder items(Collection<CallAnalyticsItem> items)

      Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

      Parameters:
      items - Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      UtteranceEvent.Builder items(CallAnalyticsItem... items)

      Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

      Parameters:
      items - Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      UtteranceEvent.Builder items(Consumer<CallAnalyticsItem.Builder>... items)

      Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

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

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

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

    • entities

      UtteranceEvent.Builder entities(Collection<CallAnalyticsEntity> entities)

      Contains entities identified as personally identifiable information (PII) in your transcription output.

      Parameters:
      entities - Contains entities identified as personally identifiable information (PII) in your transcription output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      UtteranceEvent.Builder entities(CallAnalyticsEntity... entities)

      Contains entities identified as personally identifiable information (PII) in your transcription output.

      Parameters:
      entities - Contains entities identified as personally identifiable information (PII) in your transcription output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      UtteranceEvent.Builder entities(Consumer<CallAnalyticsEntity.Builder>... entities)

      Contains entities identified as personally identifiable information (PII) in your transcription output.

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

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

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

    • sentiment

      UtteranceEvent.Builder sentiment(String sentiment)

      Provides the sentiment that was detected in the specified segment.

      Parameters:
      sentiment - Provides the sentiment that was detected in the specified segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sentiment

      UtteranceEvent.Builder sentiment(Sentiment sentiment)

      Provides the sentiment that was detected in the specified segment.

      Parameters:
      sentiment - Provides the sentiment that was detected in the specified segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • issuesDetected

      UtteranceEvent.Builder issuesDetected(Collection<IssueDetected> issuesDetected)

      Provides the issue that was detected in the specified segment.

      Parameters:
      issuesDetected - Provides the issue that was detected in the specified segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuesDetected

      UtteranceEvent.Builder issuesDetected(IssueDetected... issuesDetected)

      Provides the issue that was detected in the specified segment.

      Parameters:
      issuesDetected - Provides the issue that was detected in the specified segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuesDetected

      UtteranceEvent.Builder issuesDetected(Consumer<IssueDetected.Builder>... issuesDetected)

      Provides the issue that was detected in the specified segment.

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

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

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

    • languageCode

      UtteranceEvent.Builder languageCode(String languageCode)

      The language code that represents the language spoken in your audio stream.

      Parameters:
      languageCode - The language code that represents the language spoken in your audio stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      UtteranceEvent.Builder languageCode(CallAnalyticsLanguageCode languageCode)

      The language code that represents the language spoken in your audio stream.

      Parameters:
      languageCode - The language code that represents the language spoken in your audio stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageIdentification

      UtteranceEvent.Builder languageIdentification(Collection<CallAnalyticsLanguageWithScore> languageIdentification)

      The language code of the dominant language identified in your stream.

      Parameters:
      languageIdentification - The language code of the dominant language identified in your stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageIdentification

      UtteranceEvent.Builder languageIdentification(CallAnalyticsLanguageWithScore... languageIdentification)

      The language code of the dominant language identified in your stream.

      Parameters:
      languageIdentification - The language code of the dominant language identified in your stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageIdentification

      UtteranceEvent.Builder languageIdentification(Consumer<CallAnalyticsLanguageWithScore.Builder>... languageIdentification)

      The language code of the dominant language identified in your stream.

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

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

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