API
API
PivotAIModelManager

PivotAIModelManager

PivotAITypes์— ์ •์˜๋œ AI ๋ชจ๋ธ๋“ค์„ ๋“ฑ๋กยท๊ด€๋ฆฌํ•˜๊ณ , ์งˆ์˜๋ฅผ ์œ„์ž„ํ•˜๋Š” ๋งค๋‹ˆ์ €.
๋ชจ๋ธ์€ name์œผ๋กœ ์‹๋ณ„๋˜๋ฉฐ, ํ•˜๋‚˜์˜ ๋ชจ๋ธ์„ ํ™œ์„ฑ(active) ๋ชจ๋ธ๋กœ ์ง€์ •ํ•ด ๊ธฐ๋ณธ ์งˆ์˜ ๋Œ€์ƒ์œผ๋กœ ์‚ฌ์šฉํ•œ๋‹ค.

Properties

activeModel: PivotAIModel readonly

ํ˜„์žฌ ํ™œ์„ฑ ๋ชจ๋ธ. ๋“ฑ๋ก๋œ ๋ชจ๋ธ์ด ์—†์œผ๋ฉด null.

default: undefined

models: Array (opens in a new tab)<PivotAIModel> readonly

๋“ฑ๋ก๋œ ๋ชจ๋“  ๋ชจ๋ธ ๋ชฉ๋ก.

default: undefined

Methods

clear(): void (opens in a new tab)

๋“ฑ๋ก๋œ ๋ชจ๋“  ๋ชจ๋ธ์„ ์ œ๊ฑฐํ•˜๊ณ  ํ™œ์„ฑ ๋ชจ๋ธ์„ ํ•ด์ œํ•œ๋‹ค.

get(name): PivotAIModel

name์— ํ•ด๋‹นํ•˜๋Š” ๋ชจ๋ธ์„ ๋ฐ˜ํ™˜ํ•œ๋‹ค. ์—†์œผ๋ฉด null.

ParameterType
namestring (opens in a new tab)

has(name): boolean (opens in a new tab)

name์— ํ•ด๋‹นํ•˜๋Š” ๋ชจ๋ธ์ด ๋“ฑ๋ก๋˜์–ด ์žˆ๋Š”์ง€ ์—ฌ๋ถ€.

ParameterType
namestring (opens in a new tab)

query(api, query, modelName?, toolChoice?): Promise (opens in a new tab)<AIConversationTurn>

์ž์—ฐ์–ด ์š”์ฒญ์„ ๋ชจ๋ธ์— ์ „๋‹ฌํ•˜์—ฌ ์‘๋‹ต์„ ๋ฐ›๋Š”๋‹ค.
modelName์„ ์ง€์ •ํ•˜๋ฉด ํ•ด๋‹น ๋ชจ๋ธ๋กœ, ์ƒ๋žตํ•˜๋ฉด ํ™œ์„ฑ ๋ชจ๋ธ๋กœ ์งˆ์˜ํ•œ๋‹ค.
toolChoice๋กœ ๋„๊ตฌ ํ˜ธ์ถœ ์ •์ฑ…(ํŠน์ • ๋ช…๋ น ๊ฐ•์ œ ๋“ฑ)์„ ์ง€์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.
์งˆ์˜ํ•  ๋ชจ๋ธ์ด ์—†์œผ๋ฉด ์˜ˆ์™ธ๋ฅผ throwํ•œ๋‹ค(๋ชจ๋ธ ํ˜ธ์ถœ ์‹คํŒจ ๋˜ํ•œ ์˜ˆ์™ธ๋กœ ์ „ํŒŒ๋œ๋‹ค).

ParameterType
apiPivotAIApi
querystring (opens in a new tab)
modelNamestring (opens in a new tab)
toolChoiceAIToolChoice

register(model, activate?): PivotAIModel

๋ชจ๋ธ์„ ๋“ฑ๋กํ•œ๋‹ค. ๊ฐ™์€ name์˜ ๋ชจ๋ธ์ด ์ด๋ฏธ ์žˆ์œผ๋ฉด ๊ต์ฒดํ•œ๋‹ค.
ํ™œ์„ฑ ๋ชจ๋ธ์ด ์•„์ง ์—†๊ฑฐ๋‚˜ activate๊ฐ€ true์ด๋ฉด ์ด ๋ชจ๋ธ์„ ํ™œ์„ฑ ๋ชจ๋ธ๋กœ ์ง€์ •ํ•œ๋‹ค.

ParameterType
modelPivotAIModel
activateboolean (opens in a new tab)

returnย ๋“ฑ๋ก๋œ ๋ชจ๋ธ

registerTools(tools, clear?, modelName?): Promise (opens in a new tab)<void (opens in a new tab)>

๋ชจ๋“ (๋˜๋Š” ์ง€์ •ํ•œ) ๋ชจ๋ธ์— ๋ช…๋ น(๋„๊ตฌ) ๋ชฉ๋ก์„ ๋“ฑ๋กํ•œ๋‹ค.

ParameterTypeDescription
toolsArray (opens in a new tab)<AIToolSchema>๋“ฑ๋กํ•  ๋ช…๋ น ๋ชฉ๋ก
clearboolean (opens in a new tab)true์ด๋ฉด ๊ธฐ์กด ๋ชฉ๋ก์„ ๋น„์šด ๋’ค ๋“ฑ๋กํ•œ๋‹ค.
modelNamestring (opens in a new tab)์ง€์ •ํ•˜๋ฉด ํ•ด๋‹น ๋ชจ๋ธ์—๋งŒ ๋“ฑ๋กํ•œ๋‹ค. ์ƒ๋žตํ•˜๋ฉด ๋ชจ๋“  ๋ชจ๋ธ์— ๋“ฑ๋กํ•œ๋‹ค.

setActiveModel(name): boolean (opens in a new tab)

name์— ํ•ด๋‹นํ•˜๋Š” ๋ชจ๋ธ์„ ํ™œ์„ฑ ๋ชจ๋ธ๋กœ ์ง€์ •ํ•œ๋‹ค.

ParameterType
namestring (opens in a new tab)

returnย ์ง€์ •๋œ ํ™œ์„ฑ ๋ชจ๋ธ

unregister(name): boolean (opens in a new tab)

name์— ํ•ด๋‹นํ•˜๋Š” ๋ชจ๋ธ์„ ์ œ๊ฑฐํ•œ๋‹ค.
์ œ๊ฑฐ๋œ ๋ชจ๋ธ์ด ํ™œ์„ฑ ๋ชจ๋ธ์ด์—ˆ๋‹ค๋ฉด, ๋‚จ์€ ๋ชจ๋ธ ์ค‘ ํ•˜๋‚˜๋ฅผ ํ™œ์„ฑ ๋ชจ๋ธ๋กœ ๋‹ค์‹œ ์ง€์ •ํ•œ๋‹ค.

ParameterType
namestring (opens in a new tab)

returnย ์ œ๊ฑฐ๋˜์—ˆ์œผ๋ฉด true