Constructor Detail

Method Detail

• threadId

   final MessageCreateParams.Builder threadId(String threadId)

• threadId

   final MessageCreateParams.Builder threadId(Optional<String> threadId)

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

• body

   final MessageCreateParams.Builder body(MessageCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • content

  • role

  • attachments

  • metadata

• content

   final MessageCreateParams.Builder content(MessageCreateParams.Content content)

  The text contents of the message.

• content

   final MessageCreateParams.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.Builder content(String text)

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

• contentOfArrayOfContentParts

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

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

• role

   final MessageCreateParams.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.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.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.Builder attachments(Optional<List<MessageCreateParams.Attachment>> attachments)

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

• attachments

   final MessageCreateParams.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.Builder addAttachment(MessageCreateParams.Attachment attachment)

  Adds a single Attachment to attachments.

• metadata

   final MessageCreateParams.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.Builder metadata(Optional<MessageCreateParams.Metadata> metadata)

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

• metadata

   final MessageCreateParams.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.

• additionalBodyProperties

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

• putAdditionalBodyProperty

   final MessageCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final MessageCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final MessageCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final MessageCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final MessageCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final MessageCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final MessageCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final MessageCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final MessageCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final MessageCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final MessageCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final MessageCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final MessageCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final MessageCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final MessageCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final MessageCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final MessageCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final MessageCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final MessageCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final MessageCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final MessageCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final MessageCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final MessageCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final MessageCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final MessageCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final MessageCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final MessageCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final MessageCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final MessageCreateParams build()

  Returns an immutable instance of MessageCreateParams.

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

  The following fields are required:

  .content()
  .role()