Package io.github.stefanbratanov.jvm.openai

Class CreateAssistantRequest.Builder

java.lang.Object

io.github.stefanbratanov.jvm.openai.CreateAssistantRequest.Builder

Enclosing class:

CreateAssistantRequest

public static class CreateAssistantRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateAssistantRequest	build()
CreateAssistantRequest.Builder	description(String description)
CreateAssistantRequest.Builder	fileIds(List<String> fileIds)
CreateAssistantRequest.Builder	instructions(String instructions)
CreateAssistantRequest.Builder	metadata(Map<String,String> metadata)
CreateAssistantRequest.Builder	model(OpenAIModel model)
CreateAssistantRequest.Builder	model(String model)
CreateAssistantRequest.Builder	name(String name)
CreateAssistantRequest.Builder	tool(Tool tool)
CreateAssistantRequest.Builder	tools(List<Tool> tools)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

model

public CreateAssistantRequest.Builder model(String model)

Parameters:

model - ID of the model to use.

model

public CreateAssistantRequest.Builder model(OpenAIModel model)

Parameters:

model - OpenAIModel to use

name

public CreateAssistantRequest.Builder name(String name)

Parameters:

name - The name of the assistant. The maximum length is 256 characters.

description

public CreateAssistantRequest.Builder description(String description)

Parameters:

description - The description of the assistant. The maximum length is 512 characters.

instructions

public CreateAssistantRequest.Builder instructions(String instructions)

Parameters:

instructions - The system instructions that the assistant uses. The maximum length is 256,000 characters.

tool

public CreateAssistantRequest.Builder tool(Tool tool)

Parameters:

tool - tool to append to the list of tools enabled on the assistant.

tools

public CreateAssistantRequest.Builder tools(List<Tool> tools)

Parameters:

tools - tools to append to the list of tools enabled on the assistant.

fileIds

public CreateAssistantRequest.Builder fileIds(List<String> fileIds)

Parameters:

fileIds - A list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

metadata

public CreateAssistantRequest.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 CreateAssistantRequest build()