Constructor Detail

Method Detail

• id

   final Optional<String> id()

  For an item of type (message | function_call | function_call_output) this field allows the client to assign the unique ID of the item. It is not required because the server will generate one if not provided.

  For an item of type item_reference, this field is required and is a reference to any item that has previously existed in the conversation.

• arguments

   final Optional<String> arguments()

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

• callId

   final Optional<String> callId()

  The ID of the function call (for function_call and function_call_output items). If passed on a function_call_output item, the server will check that a function_call item with the same ID exists in the conversation history.

• content

   final Optional<List<ConversationItemWithReference.Content>> content()

  The content of the message, applicable for message items.

  • Message items of role system support only input_text content

  • Message items of role user support input_text and input_audio content

  • Message items of role assistant support text content.

• name

   final Optional<String> name()

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

• object_

   final Optional<ConversationItemWithReference.Object> object_()

  Identifier for the API object being returned - always realtime.item.

• output

   final Optional<String> output()

  The output of the function call (for function_call_output items).

• role

   final Optional<ConversationItemWithReference.Role> role()

  The role of the message sender (user, assistant, system), only applicable for message items.

• status

   final Optional<ConversationItemWithReference.Status> status()

  The status of the item (completed, incomplete, in_progress). These have no effect on the conversation, but are accepted for consistency with the conversation.item.created event.

• type

   final Optional<ConversationItemWithReference.Type> type()

  The type of the item (message, function_call, function_call_output, item_reference).

• _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.

• _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.

• _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.

• _content

   final JsonField<List<ConversationItemWithReference.Content>> _content()

  Returns the raw JSON value of content.

  Unlike content, 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.

• _object_

   final JsonField<ConversationItemWithReference.Object> _object_()

  Returns the raw JSON value of object_.

  Unlike object_, this method doesn't throw if the JSON field has an unexpected type.

• _output

   final JsonField<String> _output()

  Returns the raw JSON value of output.

  Unlike output, this method doesn't throw if the JSON field has an unexpected type.

• _role

   final JsonField<ConversationItemWithReference.Role> _role()

  Returns the raw JSON value of role.

  Unlike role, this method doesn't throw if the JSON field has an unexpected type.

• _status

   final JsonField<ConversationItemWithReference.Status> _status()

  Returns the raw JSON value of status.

  Unlike status, this method doesn't throw if the JSON field has an unexpected type.

• _type

   final JsonField<ConversationItemWithReference.Type> _type()

  Returns the raw JSON value of type.

  Unlike type, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final ConversationItemWithReference.Builder toBuilder()

• validate

   final ConversationItemWithReference validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static ConversationItemWithReference.Builder builder()

  Returns a mutable builder for constructing an instance of ConversationItemWithReference.