Package io.github.stefanbratanov.jvm.openai

Class CreateMessageRequest.Builder

java.lang.Object
io.github.stefanbratanov.jvm.openai.CreateMessageRequest.Builder
Enclosing class:
CreateMessageRequest
public static class CreateMessageRequest.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • role

      public CreateMessageRequest.Builder role(String role)
      Parameters:
      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.

    • content

      public CreateMessageRequest.Builder content(String content)
      Parameters:
      content - The content of the message.

    • fileIds

      public CreateMessageRequest.Builder fileIds(List<String> fileIds)
      Parameters:
      fileIds - A list of File IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like retrieval and code_interpreter that can access and use files.

    • metadata

      public CreateMessageRequest.Builder metadata(Map<String,String> metadata)
      Parameters:
      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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

    • build

      public CreateMessageRequest build()