Constructor Detail

Method Detail

• id

   final Message.Builder id(String id)

  The unique ID of the message.

• id

   final Message.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

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

• content

   final Message.Builder content(List<Message.Content> content)

  The content of the message

• content

   final Message.Builder content(JsonField<List<Message.Content>> content)

  Sets Builder.content to an arbitrary JSON value.

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

• addContent

   final Message.Builder addContent(Message.Content content)

  Adds a single Content to Builder.content.

• addContent

   final Message.Builder addContent(ResponseInputText inputText)

  Alias for calling addContent with Content.ofInputText(inputText).

• addContent

   final Message.Builder addContent(ResponseOutputText outputText)

  Alias for calling addContent with Content.ofOutputText(outputText).

• addContent

   final Message.Builder addContent(TextContent text)

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

• addContent

   final Message.Builder addContent(SummaryTextContent summaryText)

  Alias for calling addContent with Content.ofSummaryText(summaryText).

• addContent

   final Message.Builder addContent(Message.Content.ReasoningText reasoningText)

  Alias for calling addContent with Content.ofReasoningText(reasoningText).

• addContent

   final Message.Builder addContent(ResponseOutputRefusal refusal)

  Alias for calling addContent with Content.ofRefusal(refusal).

• addContent

   final Message.Builder addContent(ResponseInputImage inputImage)

  Alias for calling addContent with Content.ofInputImage(inputImage).

• addContent

   final Message.Builder addContent(ComputerScreenshotContent computerScreenshot)

  Alias for calling addContent with Content.ofComputerScreenshot(computerScreenshot).

• addContent

   final Message.Builder addContent(ResponseInputFile inputFile)

  Alias for calling addContent with Content.ofInputFile(inputFile).

• addInputTextContent

   final Message.Builder addInputTextContent(String text)

  Alias for calling addContent with the following:

  ResponseInputText.builder()
      .text(text)
      .build()

• addTextContent

   final Message.Builder addTextContent(String text)

  Alias for calling addContent with the following:

  TextContent.builder()
      .text(text)
      .build()

• addSummaryTextContent

   final Message.Builder addSummaryTextContent(String text)

  Alias for calling addContent with the following:

  SummaryTextContent.builder()
      .text(text)
      .build()

• addReasoningTextContent

   final Message.Builder addReasoningTextContent(String text)

  Alias for calling addContent with the following:

  Content.ReasoningText.builder()
      .text(text)
      .build()

• addRefusalContent

   final Message.Builder addRefusalContent(String refusal)

  Alias for calling addContent with the following:

  ResponseOutputRefusal.builder()
      .refusal(refusal)
      .build()

• addInputImageContent

   final Message.Builder addInputImageContent(ResponseInputImage.Detail detail)

  Alias for calling addContent with the following:

  ResponseInputImage.builder()
      .detail(detail)
      .build()

• role

   final Message.Builder role(Message.Role role)

  The role of the message. One of unknown, user, assistant, system, critic, discriminator, developer, or tool.

• role

   final Message.Builder role(JsonField<Message.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.

• status

   final Message.Builder status(Message.Status status)

  The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

• status

   final Message.Builder status(JsonField<Message.Status> status)

  Sets Builder.status to an arbitrary JSON value.

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

• type

   final Message.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("message")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

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

• putAdditionalProperty

   final Message.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final Message.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final Message.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final Message build()

  Returns an immutable instance of Message.

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

  The following fields are required:

  .id()
  .content()
  .role()
  .status()