RealtimeConversationItemFunctionCall interface

Package:

@azure/ai-projects

A function call item in a Realtime conversation.

Extends

RealtimeConversationItem

Properties

arguments	The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example {"arg1": "value1", "arg2": 42}.
call_id	The ID of the function call.
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 being called.
object	Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
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.

Property Details

arguments

The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example {"arg1": "value1", "arg2": 42}.

arguments: string

Property Value

string

call_id

The ID of the function call.

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 being called.

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"

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.

type: "function_call"

Property Value

"function_call"