ChatGPT-Java-API/com.cjcrafter.openai.assistants/ModifyAssistantRequest/Builder

Builder

class Builder : AbstractAssistantBuilder<ModifyAssistantRequest>

Functions

Link copied to clipboard
Link copied to clipboard
fun addTool(tool: Tool): AbstractAssistantBuilder<ModifyAssistantRequest>

Adds the given tool to the assistant's tools.

Link copied to clipboard
open override fun build(): ModifyAssistantRequest

Builds the ModifyAssistantRequest instance.

Link copied to clipboard
fun description(description: String?): AbstractAssistantBuilder<ModifyAssistantRequest>

The description of the assistant. This is typically extremely short, and for the user's benefit rather than for the assistant's benefit.

Link copied to clipboard
fun fileIds(fileIds: MutableList<String>?): AbstractAssistantBuilder<ModifyAssistantRequest>

Sets the files available to the assistant for data analysis and retrieval. Make sure that the assistant has at least one of data analysis or retrieval tools.

Link copied to clipboard
fun instructions(instructions: String?): AbstractAssistantBuilder<ModifyAssistantRequest>

Sets the instructions for the assistant to follow. Instructions are generally a set of "commands" in natural language that the assistant should follow. This option is where all of your prompt engineering goes.

Link copied to clipboard
fun metadata(metadata: MutableMap<String, String>?): AbstractAssistantBuilder<ModifyAssistantRequest>

Sets the metadata map. This metadata is not used by OpenAI, instead, it is data that can be used by YOU, the developer, to store information.

Link copied to clipboard
fun model(model: String): AbstractAssistantBuilder<ModifyAssistantRequest>

The model to the Assistant should default to using if no model is specified. Use com.cjcrafter.openai.Models to get a list of models.

Link copied to clipboard
fun name(name: String?): AbstractAssistantBuilder<ModifyAssistantRequest>

The name of the assistant.

Link copied to clipboard
fun tools(tools: MutableList<Tool>?): AbstractAssistantBuilder<ModifyAssistantRequest>

Sets the tools available to the assistant. When using tools, you should use instructions to command the assistant to use the tools. Otherwise, the assistant tends to skip over the tools.