AssistantCreationOptions interface

Package:

@azure/openai-assistants

The request details to use when creating a new assistant.

Properties

description	The description of the new assistant.
fileIds	A list of previously uploaded file IDs to attach to the assistant.
instructions	The system instructions for the new assistant to use.
metadata	A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
model	The ID of the model to use.
name	The name of the new assistant.
tools	The collection of tools to enable for the new assistant.

Property Details

description

The description of the new assistant.

description?: null | string

Property Value

null | string

fileIds

A list of previously uploaded file IDs to attach to the assistant.

fileIds?: string[]

Property Value

string[]

instructions

The system instructions for the new assistant to use.

instructions?: null | string

Property Value

null | string

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

model

The ID of the model to use.

model: string

Property Value

string

name

The name of the new assistant.

name?: null | string

Property Value

null | string

tools

The collection of tools to enable for the new assistant.

tools?: ToolDefinition[]

Property Value

ToolDefinition[]