Skip to content

Entity

Structure Class

Entity dataclass

Bases: _SerdeShape

Contains entities identified as personally identifiable information (PII) 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 = ...

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

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

The confidence score associated with the identified PII 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 = ...

The word or words identified as PII.

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

The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)

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

The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)

type class-attribute instance-attribute
type: str | None = ...

The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.