Interface MedicalScribeTranscriptSegment.Builder

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

  • Method Details

    • segmentId

      MedicalScribeTranscriptSegment.Builder segmentId(String segmentId)

      The identifier of the segment.

      Parameters:
      segmentId - The identifier of the segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • beginAudioTime

      MedicalScribeTranscriptSegment.Builder beginAudioTime(Double beginAudioTime)

      The start time, in milliseconds, of the segment.

      Parameters:
      beginAudioTime - The start time, in milliseconds, of the segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endAudioTime

      MedicalScribeTranscriptSegment.Builder endAudioTime(Double endAudioTime)

      The end time, in milliseconds, of the segment.

      Parameters:
      endAudioTime - The end time, in milliseconds, of the segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • content

      MedicalScribeTranscriptSegment.Builder content(String content)

      Contains transcribed text of the segment.

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

    • items

      MedicalScribeTranscriptSegment.Builder items(Collection<MedicalScribeTranscriptItem> items)

      Contains words, phrases, or punctuation marks in your segment.

      Parameters:
      items - Contains words, phrases, or punctuation marks in your segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      MedicalScribeTranscriptSegment.Builder items(MedicalScribeTranscriptItem... items)

      Contains words, phrases, or punctuation marks in your segment.

      Parameters:
      items - Contains words, phrases, or punctuation marks in your segment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • items

      MedicalScribeTranscriptSegment.Builder items(Consumer<MedicalScribeTranscriptItem.Builder>... items)

      Contains words, phrases, or punctuation marks in your segment.

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

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

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

    • isPartial

      MedicalScribeTranscriptSegment.Builder isPartial(Boolean isPartial)

      Indicates if the segment is complete.

      If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

      Parameters:
      isPartial - Indicates if the segment is complete.

      If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.

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

    • channelId

      MedicalScribeTranscriptSegment.Builder channelId(String channelId)

      Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.

      If MedicalScribeChannelDefinition is not provided in the MedicalScribeConfigurationEvent, then this field will not be included.

      Parameters:
      channelId - Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.

      If MedicalScribeChannelDefinition is not provided in the MedicalScribeConfigurationEvent, then this field will not be included.

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