Share via

CreateAgentOptionalParams interface

  • Reference
Package:
@azure/ai-projects

Optional parameters for creating agent.

Extends

Omit<CreateAgentOptions, "model">,OperationOptions

Inherited Properties

abortSignal

The signal which can be used to abort requests.
description

The description of the new agent.
instructions

The system instructions for the new agent 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.
name

The name of the new agent.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
responseFormat

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

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

The collection of tools to enable for the new agent.
topP

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

Options used when tracing is enabled.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

description

The description of the new agent.

description?: null | string

Property Value

null | string

Inherited From Omit.description

instructions

The system instructions for the new agent to use.

instructions?: null | string

Property Value

null | string

Inherited From Omit.instructions

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>

Inherited From Omit.metadata

name

The name of the new agent.

name?: null | string

Property Value

null | string

Inherited From Omit.name

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

responseFormat

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

responseFormat?: null | AgentsApiResponseFormatOption

Property Value

null | AgentsApiResponseFormatOption

Inherited From Omit.responseFormat

temperature

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.

temperature?: null | number

Property Value

null | number

Inherited From Omit.temperature

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.

toolResources?: null | ToolResources

Property Value

null | ToolResources

Inherited From Omit.toolResources

tools

The collection of tools to enable for the new agent.

tools?: ToolDefinition[]

Property Value

ToolDefinition[]

Inherited From Omit.tools

topP

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.

topP?: null | number

Property Value

null | number

Inherited From Omit.topP

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions