Skip to content

Processors

Classes

MessageProcessor

Defined in: packages/core/src/core/processors/message-processor.ts:12

Base abstract class for content processors that handle different types of input and generate appropriate responses using LLM.

Extends

Constructors

new MessageProcessor()

new MessageProcessor(llmClient, character, logLevel): MessageProcessor

Defined in: packages/core/src/core/processors/message-processor.ts:13

Parameters
llmClient

LLMClient

character

Character

logLevel

LogLevel = LogLevel.ERROR

Returns

MessageProcessor

Overrides

BaseProcessor.constructor

Properties

character

protected character: Character

Defined in: packages/core/src/core/processors/message-processor.ts:15

The character personality to use for responses

Inherited from

BaseProcessor.character

contentLimit

protected contentLimit: number = 1000

Defined in: packages/core/src/core/processor.ts:29

Inherited from

BaseProcessor.contentLimit

llmClient

protected llmClient: LLMClient

Defined in: packages/core/src/core/processors/message-processor.ts:14

The LLM client instance to use for processing

Inherited from

BaseProcessor.llmClient

logger

protected logger: Logger

Defined in: packages/core/src/core/processor.ts:15

Logger instance for this processor

Inherited from

BaseProcessor.logger

loggerLevel

protected loggerLevel: LogLevel = LogLevel.ERROR

Defined in: packages/core/src/core/processor.ts:26

The logging level to use

Inherited from

BaseProcessor.loggerLevel

metadata

protected metadata: object

Defined in: packages/core/src/core/processor.ts:25

Metadata about this processor including name and description

description

description: string

name

name: string

Inherited from

BaseProcessor.metadata

Methods

canHandle()

canHandle(content): boolean

Defined in: packages/core/src/core/processors/message-processor.ts:34

Logic to decide if this processor can handle the given content. This processor is designed to handle shorter messages and text content.

Parameters
content

any

Returns

boolean

Overrides

BaseProcessor.canHandle

getName()

getName(): string

Defined in: packages/core/src/core/processor.ts:42

Gets the name of this processor

Returns

string

The processor name from metadata

Inherited from

BaseProcessor.getName

process()

process(content, otherContext, ioContext?): Promise<ProcessedResult>

Defined in: packages/core/src/core/processors/message-processor.ts:43

Processes the given content and returns a result.

Parameters
content

any

The content to process

otherContext

string

Additional context string to consider during processing

ioContext?

Optional context containing available outputs and actions

availableActions

IOHandler[]

Array of available action handlers

availableOutputs

IOHandler[]

Array of available output handlers

Returns

Promise<ProcessedResult>

Promise resolving to the processed result

Overrides

BaseProcessor.process


ResearchQuantProcessor

Defined in: packages/core/src/core/processors/research-processor.ts:20

Example Research/Quant Processor

Responsibilities:

  1. Scrape or read inbound content and attempt to extract relevant data for research
  2. Summarize and rank key insights
  3. (Optionally) produce embeddings or structured data suitable for a vector DB
  4. Suggest next steps or tasks (e.g., writing to a vector store, scheduling a scrape, etc.)

Extends

Constructors

new ResearchQuantProcessor()

new ResearchQuantProcessor(llmClient, character, logLevel, contentLimit, tokenLimit): ResearchQuantProcessor

Defined in: packages/core/src/core/processors/research-processor.ts:21

Parameters
llmClient

LLMClient

character

Character

logLevel

LogLevel = LogLevel.ERROR

contentLimit

number = 1000

tokenLimit

number = 100000

Returns

ResearchQuantProcessor

Overrides

BaseProcessor.constructor

Properties

character

protected character: Character

Defined in: packages/core/src/core/processors/research-processor.ts:23

The character personality to use for responses

Inherited from

BaseProcessor.character

contentLimit

protected contentLimit: number = 1000

Defined in: packages/core/src/core/processors/research-processor.ts:25

Inherited from

BaseProcessor.contentLimit

llmClient

protected llmClient: LLMClient

Defined in: packages/core/src/core/processors/research-processor.ts:22

The LLM client instance to use for processing

Inherited from

BaseProcessor.llmClient

logger

protected logger: Logger

Defined in: packages/core/src/core/processor.ts:15

Logger instance for this processor

Inherited from

BaseProcessor.logger

loggerLevel

protected loggerLevel: LogLevel = LogLevel.ERROR

Defined in: packages/core/src/core/processor.ts:26

The logging level to use

Inherited from

BaseProcessor.loggerLevel

metadata

protected metadata: object

Defined in: packages/core/src/core/processor.ts:25

Metadata about this processor including name and description

description

description: string

name

name: string

Inherited from

BaseProcessor.metadata

tokenLimit

protected tokenLimit: number = 100000

Defined in: packages/core/src/core/processors/research-processor.ts:26

Methods

canHandle()

canHandle(content): boolean

Defined in: packages/core/src/core/processors/research-processor.ts:44

Logic to decide if this processor can handle the given content. This processor is designed to handle longer-form content like datasets and scraped data.

Parameters
content

any

Returns

boolean

Overrides

BaseProcessor.canHandle

getName()

getName(): string

Defined in: packages/core/src/core/processor.ts:42

Gets the name of this processor

Returns

string

The processor name from metadata

Inherited from

BaseProcessor.getName

process()

process(content, otherContext, ioContext?): Promise<any>

Defined in: packages/core/src/core/processors/research-processor.ts:319

Processes the given content and returns a result.

Parameters
content

any

The content to process

otherContext

string

Additional context string to consider during processing

ioContext?

Optional context containing available outputs and actions

availableActions

IOHandler[]

Array of available action handlers

availableOutputs

IOHandler[]

Array of available output handlers

Returns

Promise<any>

Promise resolving to the processed result

Overrides

BaseProcessor.process