class

OpenAI::AssistantObject

Inherits JSON::Serializable < Reference < Object

Represents an assistant that can call the model and use tools.

Constructors

new(pull : JSON::PullParser)

new(id : String = "", object : AssistantObjectObject = AssistantObjectObject::Assistant, created_at : Int64 = 0, name : AssistantObjectName = nil, description : AssistantObjectDescription = nil, model : String = "", instructions : AssistantObjectInstructions = nil, tools : Array(AssistantTool) = [] of AssistantTool, tool_resources : AssistantObjectToolResources | Nil = nil, metadata : Metadata = nil, temperature : AssistantObjectTemperature | Nil = nil, top_p : AssistantObjectTopP | Nil = nil, response_format : AssistantObjectResponseFormat | Nil = nil)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

created_at

The Unix timestamp (in seconds) for when the assistant was created.

created_at=(created_at : Int64)

The Unix timestamp (in seconds) for when the assistant was created.

description

description=(description : AssistantObjectDescription)

id

The identifier, which can be referenced in API endpoints.

id=(id : String)

The identifier, which can be referenced in API endpoints.

instructions

instructions=(instructions : AssistantObjectInstructions)

metadata

metadata=(metadata : Metadata)

model

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

model=(model : String)

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

name

name=(name : AssistantObjectName)

object

The object type, which is always assistant.

object=(object : AssistantObjectObject)

The object type, which is always assistant.

response_format

response_format=(response_format : AssistantObjectResponseFormat | Nil)

temperature

temperature=(temperature : AssistantObjectTemperature | Nil)

tool_resources

tool_resources=(tool_resources : AssistantObjectToolResources | Nil)

tools

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

tools=(tools : Array(AssistantTool))

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

top_p

top_p=(top_p : AssistantObjectTopP | Nil)

validate!