Skip to main content
Module

x/openai/resources/beta/mod.ts>Assistant

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Go to Latest
namespace Assistant
import { Assistant } from "https://deno.land/x/openai@v4.21.0/resources/beta/mod.ts";
interface Assistant
import { type Assistant } from "https://deno.land/x/openai@v4.21.0/resources/beta/mod.ts";

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

Properties

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

description: string | null

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

file_ids: Array<string>

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.

instructions: string | null

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

metadata: unknown | null

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.

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: string | null

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

object: "assistant"

The object type, which is always assistant.

tools: Array<Assistant.CodeInterpreter | Assistant.Retrieval | Assistant.Function>

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, retrieval, or function.