CustomToolParam interface

Package:

@azure/ai-projects

A custom tool that processes input using a specified format. Learn more about custom tools

Extends

Tool

Properties

description	Optional description of the custom tool, used to provide more context.
format	The input format for the custom tool. Default is unconstrained text.
name	The name of the custom tool, used to identify it in tool calls.
type	The type of the custom tool. Always custom.

Property Details

description

Optional description of the custom tool, used to provide more context.

description?: string

Property Value

string

format

The input format for the custom tool. Default is unconstrained text.

format?: CustomToolParamFormatUnion

Property Value

CustomToolParamFormatUnion

name

The name of the custom tool, used to identify it in tool calls.

name: string

Property Value

string

type

The type of the custom tool. Always custom.

type: "custom"

Property Value

"custom"