Skip to content

MedicalScribeTranscriptSegment

Source code in docs_src/capo_transcribe_streaming/types/medical_scribe_transcript_segment.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class MedicalScribeTranscriptSegment(TypedDict, closed=True):
    segment_id: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>The identifier of the segment.</p>"""
    begin_audio_time: "capo_transcribe_streaming.types.double.Double"
    """<p>The start time, in milliseconds, of the segment.</p>"""
    end_audio_time: "capo_transcribe_streaming.types.double.Double"
    """<p>The end time, in milliseconds, of the segment.</p>"""
    content: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>Contains transcribed text of the segment.</p>"""
    items: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_transcript_item_list.MedicalScribeTranscriptItemList"
    ]
    """<p>Contains words, phrases, or punctuation marks in your segment.</p>"""
    is_partial: "capo_transcribe_streaming.types.boolean.Boolean"
    """<p>Indicates if the segment is complete.</p> <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If <code>IsPartial</code> is <code>false</code>, the segment is complete. </p>"""
    channel_id: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>Indicates which audio channel is associated with the <code>MedicalScribeTranscriptSegment</code>. </p> <p>If <code>MedicalScribeChannelDefinition</code> is not provided in the <code>MedicalScribeConfigurationEvent</code>, then this field will not be included. </p>"""

begin_audio_time instance-attribute 

begin_audio_time: Double

The start time, in milliseconds, of the segment.

channel_id instance-attribute 

channel_id: NotRequired[String]

Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.

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

content instance-attribute 

content: NotRequired[String]

Contains transcribed text of the segment.

end_audio_time instance-attribute 

end_audio_time: Double

The end time, in milliseconds, of the segment.

is_partial instance-attribute 

is_partial: Boolean

Indicates if the segment is complete.

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

items instance-attribute 

items: NotRequired[MedicalScribeTranscriptItemList]

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

segment_id instance-attribute 

segment_id: NotRequired[String]

The identifier of the segment.