Skip to main content

Class: HybridUtilityAI

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:46

Routes each utility method to the most appropriate backend:

  • LLM: summarization, classification, keyword extraction, JSON repair
  • Statistical: tokenization, stemming, n-grams, readability, similarity
  • Either with preference: sentiment, language detection

If the preferred backend is unavailable, falls back to the other.

Implements

Constructors

Constructor

new HybridUtilityAI(config): HybridUtilityAI

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:51

Parameters

config

HybridUtilityAIConfig

Returns

HybridUtilityAI

Properties

utilityId

readonly utilityId: string

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:47

Implementation of

IUtilityAI.utilityId

Methods

analyzeSentiment()

analyzeSentiment(text, options?): Promise<SentimentResult>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:129

Parameters

text

string

options?

SentimentAnalysisOptions

Returns

Promise<SentimentResult>

Implementation of

IUtilityAI.analyzeSentiment


calculateReadability()

calculateReadability(text, options): Promise<ReadabilityResult>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:119

Parameters

text

string

options

ReadabilityOptions

Returns

Promise<ReadabilityResult>

Implementation of

IUtilityAI.calculateReadability


calculateSimilarity()

calculateSimilarity(text1, text2, options?): Promise<number>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:123

Parameters

text1

string

text2

string

options?

SimilarityOptions

Returns

Promise<number>

Implementation of

IUtilityAI.calculateSimilarity


checkHealth()

checkHealth(): Promise<{ dependencies?: object[]; details?: any; isHealthy: boolean; }>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:139

Returns

Promise<{ dependencies?: object[]; details?: any; isHealthy: boolean; }>

Implementation of

IUtilityAI.checkHealth


classifyText()

classifyText(textToClassify, options): Promise<ClassificationResult>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:81

Parameters

textToClassify

string

options

ClassificationOptions

Returns

Promise<ClassificationResult>

Implementation of

IUtilityAI.classifyText


detectLanguage()

detectLanguage(text, options?): Promise<LanguageDetectionResult[]>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:133

Parameters

text

string

options?

LanguageDetectionOptions

Returns

Promise<LanguageDetectionResult[]>

Implementation of

IUtilityAI.detectLanguage


extractKeywords()

extractKeywords(textToAnalyze, options?): Promise<string[]>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:85

Parameters

textToAnalyze

string

options?

KeywordExtractionOptions

Returns

Promise<string[]>

Implementation of

IUtilityAI.extractKeywords


generateNGrams()

generateNGrams(tokens, options): Promise<Record<number, string[][]>>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:115

Parameters

tokens

string[]

options

NGramOptions

Returns

Promise<Record<number, string[][]>>

Implementation of

IUtilityAI.generateNGrams


initialize()

initialize(config): Promise<void>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:60

Parameters

config

UtilityAIConfigBase & Record<string, any>

Returns

Promise<void>

Implementation of

IUtilityAI.initialize


normalizeText()

normalizeText(text, options?): Promise<string>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:111

Parameters

text

string

options?

TextNormalizationOptions

Returns

Promise<string>

Implementation of

IUtilityAI.normalizeText


parseJsonSafe()

parseJsonSafe<T>(jsonString, options?): Promise<T | null>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:89

Safely parses a string that is expected to be JSON, potentially using an LLM to fix common issues.

Type Parameters

T

T = any

The expected type of the parsed JSON object.

Parameters

jsonString

string

The string to parse.

options?

ParseJsonOptions<T>

Options for parsing and fixing.

Returns

Promise<T | null>

The parsed object, or null if parsing and fixing fail.

Implementation of

IUtilityAI.parseJsonSafe


shutdown()

shutdown(): Promise<void>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:163

Returns

Promise<void>

Implementation of

IUtilityAI.shutdown


stemTokens()

stemTokens(tokens, options?): Promise<string[]>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:107

Parameters

tokens

string[]

options?

StemmingOptions

Returns

Promise<string[]>

Implementation of

IUtilityAI.stemTokens


summarize()

summarize(textToSummarize, options?): Promise<string>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:77

Parameters

textToSummarize

string

options?

SummarizationOptions

Returns

Promise<string>

Implementation of

IUtilityAI.summarize


tokenize()

tokenize(text, options?): Promise<string[]>

Defined in: packages/agentos/src/nlp/ai_utilities/HybridUtilityAI.ts:103

Parameters

text

string

options?

TokenizationOptions

Returns

Promise<string[]>

Implementation of

IUtilityAI.tokenize