AgentRunner
Defined in: .build/typescript/packages/core/src/agent/base.ts:256
Runner will manage the task execution and provide a high-level API for the user
Deprecated
Section titled “Deprecated”Use agent instead.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”AI extends LLM
Store extends object = object
AdditionalMessageOptions
Section titled “AdditionalMessageOptions”AdditionalMessageOptions extends object = AI extends LLM<object, infer AdditionalMessageOptions> ? AdditionalMessageOptions : never
AdditionalChatOptions
Section titled “AdditionalChatOptions”AdditionalChatOptions extends object = object
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew AgentRunner<AI,Store,AdditionalMessageOptions,AdditionalChatOptions>(params):AgentRunner<AI,Store,AdditionalMessageOptions,AdditionalChatOptions>
Defined in: .build/typescript/packages/core/src/agent/base.ts:321
Parameters
Section titled “Parameters”params
Section titled “params”AgentRunnerParams<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>
Returns
Section titled “Returns”AgentRunner<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”defaultTaskHandler
Section titled “defaultTaskHandler”
staticdefaultTaskHandler:TaskHandler<LLM<object,object>>
Defined in: .build/typescript/packages/core/src/agent/base.ts:288
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get llm():
AI
Defined in: .build/typescript/packages/core/src/agent/base.ts:341
Returns
Section titled “Returns”AI
chatHistory
Section titled “chatHistory”Get Signature
Section titled “Get Signature”get chatHistory():
ChatMessage<AdditionalMessageOptions>[]
Defined in: .build/typescript/packages/core/src/agent/base.ts:345
Returns
Section titled “Returns”ChatMessage<AdditionalMessageOptions>[]
Overrides
Section titled “Overrides”verbose
Section titled “verbose”Get Signature
Section titled “Get Signature”get verbose():
boolean
Defined in: .build/typescript/packages/core/src/agent/base.ts:349
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”createStore()
Section titled “createStore()”
abstractcreateStore():Store
Defined in: .build/typescript/packages/core/src/agent/base.ts:282
Returns
Section titled “Returns”Store
defaultCreateStore()
Section titled “defaultCreateStore()”
staticdefaultCreateStore():object
Defined in: .build/typescript/packages/core/src/agent/base.ts:284
Returns
Section titled “Returns”object
reset()
Section titled “reset()”reset():
void
Defined in: .build/typescript/packages/core/src/agent/base.ts:353
Returns
Section titled “Returns”void
getTools()
Section titled “getTools()”getTools(
query):BaseToolWithCall[] |Promise<BaseToolWithCall[]>
Defined in: .build/typescript/packages/core/src/agent/base.ts:357
Parameters
Section titled “Parameters”Returns
Section titled “Returns”BaseToolWithCall[] | Promise<BaseToolWithCall[]>
shouldContinue()
Section titled “shouldContinue()”
staticshouldContinue<AI,Store,AdditionalMessageOptions>(task):boolean
Defined in: .build/typescript/packages/core/src/agent/base.ts:363
Type Parameters
Section titled “Type Parameters”AI extends LLM<object, object>
Store extends object = object
AdditionalMessageOptions
Section titled “AdditionalMessageOptions”AdditionalMessageOptions extends object = AI extends LLM<object, AdditionalMessageOptions> ? AdditionalMessageOptions : never
Parameters
Section titled “Parameters”Readonly<TaskStep<AI, Store, AdditionalMessageOptions>>
Returns
Section titled “Returns”boolean
createTask()
Section titled “createTask()”createTask(
message,stream,verbose,chatHistory?,additionalChatOptions?):ReadableStream<TaskStepOutput<AI,Store,AdditionalMessageOptions,AdditionalChatOptions>>
Defined in: .build/typescript/packages/core/src/agent/base.ts:376
Parameters
Section titled “Parameters”message
Section titled “message”stream
Section titled “stream”boolean = false
verbose
Section titled “verbose”undefined | boolean
chatHistory?
Section titled “chatHistory?”ChatMessage<AdditionalMessageOptions>[]
additionalChatOptions?
Section titled “additionalChatOptions?”AdditionalChatOptions
Returns
Section titled “Returns”ReadableStream<TaskStepOutput<AI, Store, AdditionalMessageOptions, AdditionalChatOptions>>
chat()
Section titled “chat()”Call Signature
Section titled “Call Signature”chat(
params):Promise<EngineResponse>
Defined in: .build/typescript/packages/core/src/agent/base.ts:420
Parameters
Section titled “Parameters”params
Section titled “params”NonStreamingChatEngineParams<AdditionalMessageOptions, AdditionalChatOptions>
Returns
Section titled “Returns”Promise<EngineResponse>
Overrides
Section titled “Overrides”Call Signature
Section titled “Call Signature”chat(
params):Promise<ReadableStream<EngineResponse>>
Defined in: .build/typescript/packages/core/src/agent/base.ts:426
Parameters
Section titled “Parameters”params
Section titled “params”StreamingChatEngineParams<AdditionalMessageOptions, AdditionalChatOptions>
Returns
Section titled “Returns”Promise<ReadableStream<EngineResponse>>