Class RealtimeItem

A realtime Item is of three types: message, function_call, or function_call_output.

A message item can contain text or audio.

A function_call item indicates a model's desire to call a tool.

A function_call_output item indicates a function response.

The client may add and remove message and function_call_output Items using conversation.item.create and conversation.item.delete.

Inheritance

object

RealtimeItem

Namespace: Glitch9.AIDevKit.OpenAI.Realtime

Assembly: .dll

Syntax

public class RealtimeItem

Properties

Arguments

The arguments of the function call (for "function_call" items).

Declaration

public string Arguments { get; set; }

Property Value

Type	Description
string

CallId

The ID of the function call (for "function_call" items).

Declaration

public string CallId { get; set; }

Property Value

Type	Description
string

Content

The content of the item.

Declaration

public RealtimeItemContent[] Content { get; set; }

Property Value

Type	Description
RealtimeItemContent[]

Id

The unique ID of the item.

Declaration

public string Id { get; set; }

Property Value

Type	Description
string

Name

The name of the function being called (for "function_call" items).

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Object

The object type.

Declaration

public string Object { get; set; }

Property Value

Type	Description
string

Output

The list of output items generated by the response.

Declaration

public RealtimeItem[] Output { get; set; }

Property Value

Type	Description
RealtimeItem[]

Role

The role associated with the item.

Declaration

public ChatRole? Role { get; set; }

Property Value

Type	Description
ChatRole?

Status

The status of the item.

Declaration

public RealtimeItemStatus? Status { get; set; }

Property Value

Type	Description
RealtimeItemStatus?

StatusDetails

Additional details about the status.

Declaration

public RealtimeItemStatusDetails StatusDetails { get; set; }

Property Value

Type	Description
RealtimeItemStatusDetails

Type

The type of the item.

Declaration

public RealtimeItemType Type { get; set; }

Property Value

Type	Description
RealtimeItemType

Usage

Usage statistics for the response.

Declaration

public Usage Usage { get; set; }

Property Value

Type	Description
Usage

Methods

GetOutputText()

Declaration

public string GetOutputText()

Returns

Type	Description
string

GetTranscript()

Declaration

public string GetTranscript()

Returns

Type	Description
string

ToStatusString()

Declaration

public string ToStatusString()

Returns

Type	Description
string

UserAudio(string)

Declaration

public static RealtimeItem UserAudio(string base64EncodedAudio)

Parameters

Type	Name	Description
string	base64EncodedAudio

Returns

Type	Description
RealtimeItem

UserMessage(string)

Declaration

public static RealtimeItem UserMessage(string text)

Parameters

Type	Name	Description
string	text

Returns

Type	Description
RealtimeItem