ServerEventResponseAudioTranscriptAnnotationAdded interface

Package:

@azure/ai-voicelive

Returned when an audio transcript annotation is added to a response.

Extends

ServerEvent

Properties

annotation	The annotation object.
annotationIndex	The index of the annotation.
contentIndex	The index of the content part in the item's content array.
itemId	The ID of the item.
outputIndex	The index of the output item in the response.
responseId	The ID of the response.
type	The event type, must be response.audio_transcript.annotation.added.

Inherited Properties

eventId

Property Details

annotation

The annotation object.

annotation: any

Property Value

any

annotationIndex

The index of the annotation.

annotationIndex: number

Property Value

number

contentIndex

The index of the content part in the item's content array.

contentIndex: number

Property Value

number

itemId

The ID of the item.

itemId: string

Property Value

string

outputIndex

The index of the output item in the response.

outputIndex: number

Property Value

number

responseId

The ID of the response.

responseId: string

Property Value

string

type

The event type, must be response.audio_transcript.annotation.added.

type: "response.audio_transcript.annotation.added"

Property Value

"response.audio_transcript.annotation.added"

Inherited Property Details

eventId

eventId?: string

Property Value

string

Inherited From ServerEvent.eventId