Skip to main content

Class: BaseAgent

BaseAgent is the base class for all agents.

Implements​

  • BaseChatEngine
  • BaseQueryEngine

Constructors​

constructor​

• new BaseAgent(): BaseAgent

Returns​

BaseAgent

Methods​

_getPromptModules​

▸ _getPromptModules(): string[]

Returns​

string[]

Defined in​

packages/core/src/agent/types.ts:45

_getPrompts​

▸ _getPrompts(): string[]

Returns​

string[]

Defined in​

packages/core/src/agent/types.ts:41

chat​

▸ chat(params): Promise<AgentChatResponse | StreamingAgentChatResponse>

Parameters​

NameType
paramsChatEngineAgentParams

Returns​

Promise<AgentChatResponse | StreamingAgentChatResponse>

Implementation of​

BaseChatEngine.chat

Defined in​

packages/core/src/agent/types.ts:49

query​

▸ query(params): Promise<AgentChatResponse | StreamingAgentChatResponse>

query is the main entrypoint for the agent. It takes a query and returns a response.

Parameters​

NameType
paramsQueryEngineParamsNonStreaming

Returns​

Promise<AgentChatResponse | StreamingAgentChatResponse>

Implementation of​

BaseQueryEngine.query

Defined in​

packages/core/src/agent/types.ts:60

reset​

▸ reset(): void

Returns​

void

Defined in​

packages/core/src/agent/types.ts:53