Class ResponseTextResponse

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

public sealed class ResponseTextResponse : BaseRealtimeEvent, IServerEvent, IRealtimeEvent

Inheritance

object

BaseRealtimeEvent

ResponseTextResponse

Implements

IServerEvent

IRealtimeEvent

Inherited Members

BaseRealtimeEvent.ToJsonString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

ContentIndex

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

[JsonInclude]
[JsonPropertyName("content_index")]
public int ContentIndex { get; }

Property Value

int

Delta

The text delta.

[JsonInclude]
[JsonPropertyName("delta")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Delta { get; }

Property Value

string

EventId

The unique ID of the server event.

[JsonInclude]
[JsonPropertyName("event_id")]
public override string EventId { get; }

Property Value

string

IsDelta

[JsonIgnore]
public bool IsDelta { get; }

Property Value

bool

IsDone

[JsonIgnore]
public bool IsDone { get; }

Property Value

bool

ItemId

The ID of the item.

[JsonInclude]
[JsonPropertyName("item_id")]
public string ItemId { get; }

Property Value

string

OutputIndex

The index of the output item in the response.

[JsonInclude]
[JsonPropertyName("output_index")]
public int OutputIndex { get; }

Property Value

int

ResponseId

The ID of the response.

[JsonInclude]
[JsonPropertyName("response_id")]
public string ResponseId { get; }

Property Value

string

Text

The final text content.

[JsonInclude]
[JsonPropertyName("text")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Text { get; }

Property Value

string

Type

[JsonInclude]
[JsonPropertyName("type")]
public override string Type { get; protected set; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator string(ResponseTextResponse)

public static implicit operator string(ResponseTextResponse response)

Parameters

response ResponseTextResponse

Returns

string