API
API
Interfaces
AICommandParameter

AICommandParameter

AICommand가 받는 단일 파라미터의 정의.
구현부에서 JSONSchema의 properties 항목으로 변환된다.
중첩 구조는 재귀적으로 표현한다 — array는 items로 원소 스키마를, object는 properties로 하위 속성을 지정한다.

Properties

defaultValue: any (opens in a new tab) readonly

default: undefined

description: string (opens in a new tab) readonly

LLM이 인자를 정확히 채우는 데 필요한 설명. function calling 품질을 위해 필수이다.

default: undefined

editable: boolean (opens in a new tab) readonly

사용자 수정 가능 여부. [주의] 현재 UI 용도로만 사용된다.

default: undefined

enum: Array (opens in a new tab)<string (opens in a new tab) | number (opens in a new tab)> readonly

허용되는 값의 집합(예: 정렬 방향 "asc"|"desc", 집계 "sum"|"avg"|"count").

default: undefined

items: AIToolParameter readonly

type이 "array"일 때 원소의 스키마.

default: undefined

name: string (opens in a new tab) readonly

default: undefined

properties: Array (opens in a new tab)<AIToolParameter> readonly

type이 "object"일 때 하위 속성들의 스키마.

default: undefined

range: { max: number;min: number;step: number; } readonly

값의 범위(예: 최소값, 최대값, 단계). [주의] 현재 UI 용도로만 사용된다.

default: undefined

required: boolean (opens in a new tab) readonly

default: undefined

type: 'string' | 'number' | 'boolean' | 'object' | 'integer' | 'array' readonly

default: undefined

visible: boolean (opens in a new tab) readonly

UI 표시 여부. [주의] 현재 UI 용도로만 사용된다.

default: undefined