Class Assistant

Namespace

Glitch9.AIDevKit.OpenAI

Renamed from AssistantObject to Assistant (2024.06.14)

public class Assistant : OpenAIObject, IData

Inheritance

object

OpenAIObject

Assistant

Implements

IData

Inherited Members

OpenAIObject.Id

OpenAIObject.Object

Properties

CodeInterpreterEnabled

public bool CodeInterpreterEnabled { get; set; }

Property Value

bool

CreatedAt

The Unix timestamp (in seconds) of when this object was created.

public UnixTime? CreatedAt { get; set; }

Property Value

UnixTime?

Description

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

public string Description { get; set; }

Property Value

string

FileSearchEnabled

public bool FileSearchEnabled { get; set; }

Property Value

bool

Instructions

The System instructions that the Assistant uses. The maximum length is 32768 characters.

public string Instructions { get; set; }

Property Value

string

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 maximum of 512 characters long.

public ServerDictionary Metadata { get; set; }

Property Value

ServerDictionary

Model

ID of the model.

public string Model { get; set; }

Property Value

string

Name

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

public string Name { get; set; }

Property Value

string

ResponseFormat

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. Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.

public ResponseFormat ResponseFormat { get; set; }

Property Value

ResponseFormat

Remarks

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Temperature

[Legacy] A list of file IDs attached to this AssistantObject. There can be a maximum of 20 files attached to the AssistantObject. Files are ordered by their creation date in ascending order.

public float? Temperature { get; set; }

Property Value

float?

ToolResources

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

public ToolResources ToolResources { get; set; }

Property Value

ToolResources

Tools

A list of Tool enabled on the Assistant. There can be a maximum of 128 tools per AssistantObject. Tools can be of types code_interpreter, retrieval, or Function.

public List<ToolWrapper> Tools { get; set; }

Property Value

List<ToolWrapper>

TopP

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

public float? TopP { get; set; }

Property Value

float?