Table of Contents

Class OpenAITranscriptionEvent

public class OpenAITranscriptionEvent : ITranscriptionEvent, IGenerativeEvent<string, Transcript>, ITextStreamEvent
Inheritance
object
OpenAITranscriptionEvent
Implements
ITextStreamEvent

Properties

Count

public int Count { get; }

Property Value

int

Delta

Required. The text delta that was additionally transcribed.

public string Delta { get; set; }

Property Value

string

Logprobs

Optional. The log probabilities of the individual tokens in the transcription. Only included if you create a transcription with the include[] parameter set to logprobs.

public LogProb[] Logprobs { get; set; }

Property Value

LogProb[]

Text

Required. The text that was transcribed.

public string Text { get; set; }

Property Value

string

Type

Required. The type of the event.transcript.text.delta or transcript.text.done

public string Type { get; set; }

Property Value

string

Usage

Required. Usage statistics for models billed by token usage.

public UsageMetadata Usage { get; set; }

Property Value

UsageMetadata

Methods

GetChunk()

public string GetChunk()

Returns

string

GetOutput()

public Transcript GetOutput()

Returns

Transcript

GetUsage()

public UsageMetadata GetUsage()

Returns

UsageMetadata

IsFinal()

public bool IsFinal()

Returns

bool