Interface MedicalScribeSettings.Builder

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

  • Method Details

    • showSpeakerLabels

      MedicalScribeSettings.Builder showSpeakerLabels(Boolean showSpeakerLabels)

      Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.

      If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

      For more information, see Partitioning speakers (diarization).

      Parameters:
      showSpeakerLabels - Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.

      If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

      For more information, see Partitioning speakers (diarization).

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

    • maxSpeakerLabels

      MedicalScribeSettings.Builder maxSpeakerLabels(Integer maxSpeakerLabels)

      Specify the maximum number of speakers you want to partition in your media.

      Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

      If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

      Parameters:
      maxSpeakerLabels - Specify the maximum number of speakers you want to partition in your media.

      Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

      If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

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

    • channelIdentification

      MedicalScribeSettings.Builder channelIdentification(Boolean channelIdentification)

      Enables channel identification in multi-channel audio.

      Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

      For more information, see Transcribing multi-channel audio.

      Parameters:
      channelIdentification - Enables channel identification in multi-channel audio.

      Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

      For more information, see Transcribing multi-channel audio.

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

    • vocabularyName

      MedicalScribeSettings.Builder vocabularyName(String vocabularyName)

      The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

      Parameters:
      vocabularyName - The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vocabularyFilterName

      MedicalScribeSettings.Builder vocabularyFilterName(String vocabularyFilterName)

      The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.

      Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

      Parameters:
      vocabularyFilterName - The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.

      Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

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

    • vocabularyFilterMethod

      MedicalScribeSettings.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

      Specify how you want your custom vocabulary filter applied to your transcript.

      To replace words with ***, choose mask.

      To delete words, choose remove.

      To flag words without changing them, choose tag.

      Parameters:
      vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.

      To replace words with ***, choose mask.

      To delete words, choose remove.

      To flag words without changing them, choose tag.

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

    • vocabularyFilterMethod

      MedicalScribeSettings.Builder vocabularyFilterMethod(VocabularyFilterMethod vocabularyFilterMethod)

      Specify how you want your custom vocabulary filter applied to your transcript.

      To replace words with ***, choose mask.

      To delete words, choose remove.

      To flag words without changing them, choose tag.

      Parameters:
      vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your transcript.

      To replace words with ***, choose mask.

      To delete words, choose remove.

      To flag words without changing them, choose tag.

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

    • clinicalNoteGenerationSettings

      MedicalScribeSettings.Builder clinicalNoteGenerationSettings(ClinicalNoteGenerationSettings clinicalNoteGenerationSettings)

      Specify settings for the clinical note generation.

      Parameters:
      clinicalNoteGenerationSettings - Specify settings for the clinical note generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clinicalNoteGenerationSettings

      default MedicalScribeSettings.Builder clinicalNoteGenerationSettings(Consumer<ClinicalNoteGenerationSettings.Builder> clinicalNoteGenerationSettings)

      Specify settings for the clinical note generation.

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

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

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