openai-core/com.aallam.openai.api.assistant/AssistantRequestBuilder

AssistantRequestBuilder

class AssistantRequestBuilder

Constructors

AssistantRequestBuilder

constructor()

Properties

var description: String?

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

var instructions: String?

The system instructions that the assistant uses. The maximum length is 32768 characters.

var metadata: Map<String, String>?

Set of 16 key-value pairs that can be attached to an object.

var model: ModelId?

ID of the model to use.

var name: String?

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

var responseFormat: AssistantResponseFormat?

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

var temperature: Double?

What sampling temperature to use, between 0 and 2.

var toolResources: ToolResources?

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool.

var tools: List<AssistantTool>?

A list of tools enabled on the assistant.

var topP: Double?

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.

Functions

fun build(): AssistantRequest

Create Assistant instance.