electron/docs/api/language-model.md

LanguageModel

Implement local AI language models

Process: Utility

Class: LanguageModel

Implement local AI language models

Process: Utility

new LanguageModel(initialState)

• initialState Object
  • inputUsage number
  • inputQuota number
  • temperature number
  • topK number

Note

Do not use this constructor directly outside of the class itself, as it will not be properly connected to the localAIHandler

Static Methods

The LanguageModel class has the following static methods:

LanguageModel.create([options]) Experimental

• options LanguageModelCreateOptions (optional)

Returns Promise<LanguageModel>

LanguageModel.availability([options]) Experimental

• options LanguageModelCreateCoreOptions (optional)

Returns Promise<string>

Determines the availability of the language model and returns one of the following strings:

• available
• downloadable
• downloading
• unavailable

LanguageModel.params() Experimental

Returns Promise<LanguageModelParams | null>

Instance Properties

The following properties are available on instances of LanguageModel:

languageModel.inputUsage Readonly Experimental

A number representing TODO.

languageModel.inputQuota Readonly Experimental

A number representing TODO.

languageModel.topK Readonly Experimental

A number representing TODO.

languageModel.temperature Readonly Experimental

A number representing TODO.

Instance Methods

The following methods are available on instances of LanguageModel:

languageModel.prompt(input, [options]) Experimental

• input LanguageModelMessage[] | string
• options LanguageModelPromptOptions (optional)

Returns Promise<string> | ReadableStream<string>

languageModel.append(input, [options]) Experimental

• input LanguageModelMessage[] | string
• options LanguageModelAppendOptions (optional)

Returns Promise<undefined>

languageModel.measureInputUsage(input, [options]) Experimental

• input LanguageModelMessage[] | string
• options LanguageModelPromptOptions (optional)

Returns Promise<number>

languageModel.clone([options]) Experimental

• options LanguageModelCloneOptions (optional)

Returns Promise<LanguageModel>

languageModel.destroy() Experimental

Destroys the model