All Implemented Interfaces:


public final class RealtimeConversationItemFunctionCall

A function call item in a Realtime conversation.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RealtimeConversationItemFunctionCall.Builder`	A builder for RealtimeConversationItemFunctionCall.
`public final class`	`RealtimeConversationItemFunctionCall.Object`	Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.
`public final class`	`RealtimeConversationItemFunctionCall.Status`	The status of the item. Has no effect on the conversation.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`arguments()`	The arguments of the function call.
`final String`	`name()`	The name of the function being called.
`final JsonValue`	`_type()`	The type of the item.
`final Optional<String>`	`id()`	The unique ID of the item.
`final Optional<String>`	`callId()`	The ID of the function call.
`final Optional<RealtimeConversationItemFunctionCall.Object>`	`object_()`	Identifier for the API object being returned - always `realtime.item`.
`final Optional<RealtimeConversationItemFunctionCall.Status>`	`status()`	The status of the item.
`final JsonField<String>`	`_arguments()`	Returns the raw JSON value of arguments.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<String>`	`_callId()`	Returns the raw JSON value of callId.
`final JsonField<RealtimeConversationItemFunctionCall.Object>`	`_object_()`	Returns the raw JSON value of object_.
`final JsonField<RealtimeConversationItemFunctionCall.Status>`	`_status()`	Returns the raw JSON value of status.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final RealtimeConversationItemFunctionCall.Builder`	`toBuilder()`
`final RealtimeConversationItemFunctionCall`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RealtimeConversationItemFunctionCall.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RealtimeConversationItemFunctionCall.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - arguments
```
 final String 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}.
  - name
```
 final String name()
```
    The name of the function being called.
  - _type
```
 final JsonValue _type()
```
    The type of the item. Always function_call.
    Expected to always return the following:
    JsonValue.from("function_call")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - id
```
 final Optional<String> id()
```
    The unique ID of the item. This may be provided by the client or generated by the server.
  - callId
```
 final Optional<String> callId()
```
    The ID of the function call.
  - object_
```
 final Optional<RealtimeConversationItemFunctionCall.Object> object_()
```
    Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
  - status
```
 final Optional<RealtimeConversationItemFunctionCall.Status> status()
```
    The status of the item. Has no effect on the conversation.
  - _arguments
```
 final JsonField<String> _arguments()
```
    Returns the raw JSON value of arguments.
    Unlike arguments, this method doesn't throw if the JSON field has an unexpected type.
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _id
```
 final JsonField<String> _id()
```
    Returns the raw JSON value of id.
    Unlike id, this method doesn't throw if the JSON field has an unexpected type.
  - _callId
```
 final JsonField<String> _callId()
```
    Returns the raw JSON value of callId.
    Unlike callId, this method doesn't throw if the JSON field has an unexpected type.
  - _object_
```
 final JsonField<RealtimeConversationItemFunctionCall.Object> _object_()
```
    Returns the raw JSON value of object_.
    Unlike object_, this method doesn't throw if the JSON field has an unexpected type.
  - _status
```
 final JsonField<RealtimeConversationItemFunctionCall.Status> _status()
```
    Returns the raw JSON value of status.
    Unlike status, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final RealtimeConversationItemFunctionCall.Builder toBuilder()
```
  - validate
```
 final RealtimeConversationItemFunctionCall validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RealtimeConversationItemFunctionCall.Builder builder()
```
    Returns a mutable builder for constructing an instance of RealtimeConversationItemFunctionCall.
    The following fields are required:
    .arguments() .name()

Class RealtimeConversationItemFunctionCall

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

arguments

name

_type

id

callId

object_

status

_arguments

_name

_id

_callId

_object_

_status

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder