Skip to content

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

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

Interface: AssistantCreateParams

Beta.Assistants.AssistantCreateParams

Table of contents

Properties

Properties

description

Optional 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:127


file_ids

Optional 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:133


instructions

Optional 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:138


metadata

Optional 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:145


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:123


name

Optional 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:149


tools

Optional tools: (AssistantToolsCode | AssistantToolsRetrieval | AssistantToolsFunction)[]

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:154

Typescript Libraries

Modules

Namespaces

Clone this wiki locally