Skip to main content

Interface: IUtilityAI

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:205

Interface​

IUtilityAI Defines the contract for a comprehensive Utility AI service.

Properties​

utilityId​

readonly utilityId: string

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:206

Methods​

analyzeSentiment()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:217

Parameters​

text​

string

options?​

SentimentAnalysisOptions

Returns​

Promise<SentimentResult>

calculateReadability()​

calculateReadability(text, options): Promise<ReadabilityResult>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:221

Parameters​

text​

string

options​

ReadabilityOptions

Returns​

Promise<ReadabilityResult>

calculateSimilarity()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:216

Parameters​

text1​

string

text2​

string

options?​

SimilarityOptions

Returns​

Promise<number>

checkHealth()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:236

Returns​

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

classifyText()​

classifyText(textToClassify, options): Promise<ClassificationResult>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:212

Parameters​

textToClassify​

string

options​

ClassificationOptions

Returns​

Promise<ClassificationResult>

detectLanguage()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:218

Parameters​

text​

string

options?​

LanguageDetectionOptions

Returns​

Promise<LanguageDetectionResult[]>

extractKeywords()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:213

Parameters​

textToAnalyze​

string

options?​

KeywordExtractionOptions

Returns​

Promise<string[]>

generateNGrams()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:220

Parameters​

tokens​

string[]

options​

NGramOptions

Returns​

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

initialize()​

initialize(config): Promise<void>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:208

Parameters​

config​

UtilityAIConfigBase & Record<string, any>

Returns​

Promise<void>

loadTrainedModel()?​

optional loadTrainedModel(modelTypeOrId, pathOrStoreId?): Promise<{ message?: string; success: boolean; }>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:247

Parameters​

modelTypeOrId​

string

pathOrStoreId?​

string

Returns​

Promise<{ message?: string; success: boolean; }>

normalizeText()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:219

Parameters​

text​

string

options?​

TextNormalizationOptions

Returns​

Promise<string>

parseJsonSafe()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:233

Parses a string that is expected to be JSON: as it is, else from inside the Markdown code fence it is or holds, which a model asked for JSON alone often answers in. An LLM-backed class sends a text that still does not parse for repair when attemptFixWithLLM is set.

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.

saveTrainedModel()?​

optional saveTrainedModel(modelTypeOrId, pathOrStoreId?): Promise<{ message?: string; pathOrStoreId?: string; success: boolean; }>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:246

Parameters​

modelTypeOrId​

string

pathOrStoreId?​

string

Returns​

Promise<{ message?: string; pathOrStoreId?: string; success: boolean; }>

shutdown()?​

optional shutdown(): Promise<void>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:237

Returns​

Promise<void>

stemTokens()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:215

Parameters​

tokens​

string[]

options?​

StemmingOptions

Returns​

Promise<string[]>

summarize()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:211

Parameters​

textToSummarize​

string

options?​

SummarizationOptions

Returns​

Promise<string>

tokenize()​

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

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:214

Parameters​

text​

string

options?​

TokenizationOptions

Returns​

Promise<string[]>

trainModel()?​

optional trainModel(trainingData, modelType, trainingOptions?): Promise<{ message?: string; modelId?: string; success: boolean; }>

Defined in: packages/agentos/src/cognition/nlp/ai_utilities/IUtilityAI.ts:240

Parameters​

trainingData​

any[]

modelType​

string

trainingOptions?​

Record<string, any>

Returns​

Promise<{ message?: string; modelId?: string; success: boolean; }>