Skip to content

@ralphschuler.ai function caller.index.<internal>.OpenAI.Beta.Assistants.Assistant

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: Assistant

Beta.Assistants.Assistant

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

Table of contents

Properties

Properties

created_at

created_at: number

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

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:44


description

description: null | string

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

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:48


file_ids

file_ids: 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.

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:54


id

id: string

The identifier, which can be referenced in API endpoints.

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:40


instructions

instructions: null | string

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

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:59


metadata

metadata: unknown

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.

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:66


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.

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:74


name

name: null | string

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

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:78


object

object: "assistant"

The object type, which is always assistant.

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:82


tools

tools: (CodeInterpreter | Retrieval | 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.

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:87

Typescript Libraries

Modules

Namespaces

Clone this wiki locally