Skip to main content

Tool

@codebolt/types

Interface: Tool

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/llm.ts:52

Represents a tool definition in OpenAI format

Properties​

PropertyTypeDescriptionDefined in
function{ description?: string; name: string; parameters?: { properties: Record<string, unknown>; required?: string[]; type: "object"; }; }Function definitioncommon/types/src/codeboltjstypes/libFunctionTypes/llm.ts:56
function.description?stringDescription of what the function doescommon/types/src/codeboltjstypes/libFunctionTypes/llm.ts:60
function.namestringName of the functioncommon/types/src/codeboltjstypes/libFunctionTypes/llm.ts:58
function.parameters?{ properties: Record<string, unknown>; required?: string[]; type: "object"; }JSON schema for the function parameterscommon/types/src/codeboltjstypes/libFunctionTypes/llm.ts:62
function.parameters.propertiesRecord<string, unknown>-common/types/src/codeboltjstypes/libFunctionTypes/llm.ts:64
function.parameters.required?string[]-common/types/src/codeboltjstypes/libFunctionTypes/llm.ts:65
function.parameters.type"object"-common/types/src/codeboltjstypes/libFunctionTypes/llm.ts:63
type"function"The type of toolcommon/types/src/codeboltjstypes/libFunctionTypes/llm.ts:54