Constructor Detail

Method Detail

• content

   final MessageCreateParams.Body.Builder content(MessageCreateParams.Content content)

  The text contents of the message.

• content

   final MessageCreateParams.Body.Builder content(JsonField<MessageCreateParams.Content> content)

  Sets Builder.content to an arbitrary JSON value.

  You should usually call Builder.content with a well-typed Content value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• content

   final MessageCreateParams.Body.Builder content(String text)

  Alias for calling content with Content.ofText(text).

• contentOfArrayOfContentParts

   final MessageCreateParams.Body.Builder contentOfArrayOfContentParts(List<MessageContentPartParam> arrayOfContentParts)

  Alias for calling content with Content.ofArrayOfContentParts(arrayOfContentParts).

• role

   final MessageCreateParams.Body.Builder role(MessageCreateParams.Role role)

  The role of the entity that is creating the message. Allowed values include:

  • user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.

  • assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.

• role

   final MessageCreateParams.Body.Builder role(JsonField<MessageCreateParams.Role> role)

  Sets Builder.role to an arbitrary JSON value.

  You should usually call Builder.role with a well-typed Role value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• attachments

   final MessageCreateParams.Body.Builder attachments(List<MessageCreateParams.Attachment> attachments)

  A list of files attached to the message, and the tools they should be added to.

• attachments

   final MessageCreateParams.Body.Builder attachments(Optional<List<MessageCreateParams.Attachment>> attachments)

  Alias for calling Builder.attachments with attachments.orElse(null).

• attachments

   final MessageCreateParams.Body.Builder attachments(JsonField<List<MessageCreateParams.Attachment>> attachments)

  Sets Builder.attachments to an arbitrary JSON value.

  You should usually call Builder.attachments with a well-typed List<Attachment> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addAttachment

   final MessageCreateParams.Body.Builder addAttachment(MessageCreateParams.Attachment attachment)

  Adds a single Attachment to attachments.

• metadata

   final MessageCreateParams.Body.Builder metadata(MessageCreateParams.Metadata metadata)

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• metadata

   final MessageCreateParams.Body.Builder metadata(Optional<MessageCreateParams.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final MessageCreateParams.Body.Builder metadata(JsonField<MessageCreateParams.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final MessageCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final MessageCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final MessageCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final MessageCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final MessageCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final MessageCreateParams.Body build()

  Returns an immutable instance of Body.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .content()
  .role()