Package version:

Interface UpdateAgentOptionalParams

Optional parameters.

interface UpdateAgentOptionalParams {
    description?: null | string;
    instructions?: null | string;
    metadata?: any;
    model?: string;
    name?: null | string;
    responseFormat?: null | AgentsResponseFormatOption;
    temperature?: null | number;
    toolResources?: ToolResources;
    tools?: {};
    topP?: null | number;
}

Hierarchy

  • unknown
    • UpdateAgentOptionalParams

Properties

description? instructions? metadata? model? name? responseFormat? temperature? toolResources? tools? topP?

Properties

Optionaldescription

description?: null | string

The modified description for the agent to use.

Optionalinstructions

instructions?: null | string

The modified system instructions for the new agent to use.

Optionalmetadata

metadata?: any

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.

Optionalmodel

model?: string

The ID of the model to use.

Optionalname

name?: null | string

The modified name for the agent to use.

OptionalresponseFormat

responseFormat?: null | AgentsResponseFormatOption

The response format of the tool calls used by this agent.

Optionaltemperature

temperature?: null | number

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

OptionaltoolResources

toolResources?: ToolResources

A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Optionaltools

tools?: {}

The modified collection of tools to enable for the agent.

OptionaltopP

topP?: null | number

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

Settings

Member Visibility