Interface Custom

Properties of the custom tool.

interface Custom {
    description?: string;
    format?: OpenAIClient.Chat.Completions.ChatCompletionCustomTool.Custom.Text | OpenAIClient.Chat.Completions.ChatCompletionCustomTool.Custom.Grammar;
    name: string;
}

Index

Properties

description? format? name

Properties

`Optional`description

description?: string

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

`Optional`format

format?: OpenAIClient.Chat.Completions.ChatCompletionCustomTool.Custom.Text | OpenAIClient.Chat.Completions.ChatCompletionCustomTool.Custom.Grammar

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

name

name: string

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