Interface AssistantUpdateParams

interface AssistantUpdateParams {
    description?: null | string;
    file_ids?: string[];
    instructions?: null | string;
    metadata?: unknown;
    model?: string;
    name?: null | string;
    tools?: (openai.OpenAI.Beta.Assistants.AssistantUpdateParams.AssistantToolsCode | openai.OpenAI.Beta.Assistants.AssistantUpdateParams.AssistantToolsRetrieval | openai.OpenAI.Beta.Assistants.AssistantUpdateParams.AssistantToolsFunction)[];
}

Properties

description? file_ids? instructions? metadata? model? name? tools?

Properties

Optional description

description?: null | string

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

Optional 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. If a file was previously attached to the list but does not show up in the list, it will be deleted from the assistant.

Optional instructions

instructions?: null | string

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

Optional 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.

Optional 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.

Optional name

name?: null | string

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

Optional tools

tools?: (openai.OpenAI.Beta.Assistants.AssistantUpdateParams.AssistantToolsCode | openai.OpenAI.Beta.Assistants.AssistantUpdateParams.AssistantToolsRetrieval | openai.OpenAI.Beta.Assistants.AssistantUpdateParams.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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc