Skip to content

Transcribe Streaming  >  Structures  >  MedicalEntity

MedicalEntity

Structure Class

MedicalEntity dataclass

Contains entities identified as personal health information (PHI) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

Attributes

category class-attribute instance-attribute
category: str | None = None

The category of information identified. The only category is PHI.

confidence class-attribute instance-attribute
confidence: float | None = None

The confidence score associated with the identified PHI entity in your audio.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

content class-attribute instance-attribute
content: str | None = None

The word or words identified as PHI.

end_time class-attribute instance-attribute
end_time: float = 0

The end time, in seconds, of the utterance that was identified as PHI.

start_time class-attribute instance-attribute
start_time: float = 0

The start time, in seconds, of the utterance that was identified as PHI.