RealtimeConversationItemFunctionCallOutput interface

Package:

@azure/ai-projects

A function call output item in a Realtime conversation.

Extends

RealtimeConversationItem

Properties

call_id	The ID of the function call this output is for.
created_at	The Unix timestamp (in seconds) for when the item was persisted.
id	The unique ID of the item. This may be provided by the client or generated by the server.
name	The name of the function that was called. A Foundry extension: OpenAI's function_call_output does not carry the function name, only call_id.
object	Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
output	The output of the function call, this is free text and can contain any information or simply be empty.
response_id	The id of the response that produced this item, when applicable.
status	The status of the item. Has no effect on the conversation.
type	The type of the item. Always function_call_output.

Property Details

call_id

The ID of the function call this output is for.

call_id: string

Property Value

string

created_at

The Unix timestamp (in seconds) for when the item was persisted.

created_at?: Date

Property Value

Date

id

The unique ID of the item. This may be provided by the client or generated by the server.

id?: string

Property Value

string

name

The name of the function that was called. A Foundry extension: OpenAI's function_call_output does not carry the function name, only call_id.

name?: string

Property Value

string

object

Identifier for the API object being returned - always realtime.item. Optional when creating a new item.

object?: "realtime.item"

Property Value

"realtime.item"

output

The output of the function call, this is free text and can contain any information or simply be empty.

output: string

Property Value

string

response_id

The id of the response that produced this item, when applicable.

response_id?: string

Property Value

string

status

The status of the item. Has no effect on the conversation.

status?: "in_progress" | "completed" | "incomplete"

Property Value

"in_progress" | "completed" | "incomplete"

type

The type of the item. Always function_call_output.

type: "function_call_output"

Property Value

"function_call_output"