UpdateAssistantOptions interface

Package:

@azure/openai-assistants

The request details to use when modifying an existing assistant.

Properties

description	The modified description for the assistant to use.
fileIds	The modified list of previously uploaded fileIDs to attach to the assistant.
instructions	The modified 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 modified name for the assistant to use.
tools	The modified collection of tools to enable for the assistant.

Property Details

description

The modified description for the assistant to use.

description?: null | string

Property Value

null | string

fileIds

The modified list of previously uploaded fileIDs to attach to the assistant.

fileIds?: string[]

Property Value

string[]

instructions

The modified 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 modified name for the assistant to use.

name?: null | string

Property Value

null | string

tools

The modified collection of tools to enable for the assistant.

tools?: ToolDefinition[]

Property Value

ToolDefinition[]