API
API
AICommand

AICommand

LLM์ด ํ˜ธ์ถœํ•  ์ˆ˜ ์žˆ๋Š” ๋ช…๋ น(๋„๊ตฌ)์˜ ์ •์˜.
๋ชจ๋ธ์— ๋“ฑ๋ก๋˜๋ฉด ๊ตฌํ˜„๋ถ€์—์„œ JSONSchema ๊ธฐ๋ฐ˜ function/tool ์ •์˜๋กœ ๋ณ€ํ™˜๋˜์–ด LLM์— ์ „๋‹ฌ๋œ๋‹ค.

See Also

https://json-schema.org/ (opens in a new tab)

Properties

description: string (opens in a new tab) readonly

LLM์ด ๋ช…๋ น์˜ ์šฉ๋„ยทํ˜ธ์ถœ ์‹œ์ ์„ ํŒ๋‹จํ•˜๋Š” ๊ทผ๊ฑฐ. function calling ํ’ˆ์งˆ์„ ์ขŒ์šฐํ•˜๋ฏ€๋กœ ํ•„์ˆ˜์ด๋‹ค.

default: undefined

examples: Array (opens in a new tab)<AIToolExample> readonly

ํ˜ธ์ถœ ํŒจํ„ด์„ ์•Œ๋ ค์ฃผ๋Š” few-shot ์˜ˆ์‹œ.
๋ณ€ํ™˜ ์‹œ description์— ํ•ฉ์ณ์ ธ LLM์˜ ์ธ์ž ์ฑ„์šฐ๊ธฐ ์ •ํ™•๋„๋ฅผ ๋†’์ธ๋‹ค.

default: undefined

name: string (opens in a new tab) readonly

๋ช…๋ น(๋„๊ตฌ) ์‹๋ณ„ ์ด๋ฆ„. LLM์— ๋…ธ์ถœ๋˜๋Š” ํ•จ์ˆ˜/๋„๊ตฌ ์ด๋ฆ„์œผ๋กœ ์‚ฌ์šฉ๋œ๋‹ค.

default: undefined

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

์ด ๋ช…๋ น์ด ๋ฐ›๋Š” ํŒŒ๋ผ๋ฏธํ„ฐ ์ •์˜ ๋ชฉ๋ก.

default: undefined

readOnly: boolean (opens in a new tab) readonly

์กฐํšŒ ์ „์šฉ(์ƒํƒœ๋ฅผ ๋ณ€๊ฒฝํ•˜์ง€ ์•Š๋Š”) ๋ช…๋ น ํ‘œ์‹.
MCP ๋…ธ์ถœ ์‹œ ํ‘œ์ค€ tool annotations(readOnlyHint)๋กœ ์ „๋‹ฌ๋ผ, ํด๋ผ์ด์–ธํŠธ๊ฐ€ ๋„๊ตฌ ์„ฑ๊ฒฉ(์กฐํšŒ/๋ณ€๊ฒฝ)์„ ํ‘œ์‹œยทํŒ๋‹จํ•˜๋Š” ๊ทผ๊ฑฐ๊ฐ€ ๋œ๋‹ค.

default: undefined