Skip to main content

Interface: Model<SETTINGS>

Type parameters

NameType
SETTINGSextends ModelSettings

Hierarchy

Accessors

settingsForEvent

get settingsForEvent(): Partial<SETTINGS>

Returns settings that should be recorded in observability events. Security-related settings (e.g. API keys) should not be included here.

Returns

Partial<SETTINGS>

Defined in

packages/modelfusion/src/model-function/Model.ts:19

Methods

withSettings

withSettings(additionalSettings): this

The withSettings method creates a new model with the same configuration as the original model, but with the specified settings changed.

Parameters

NameType
additionalSettingsPartial<SETTINGS>

Returns

this

Example

const model = new OpenAICompletionModel({
model: "gpt-3.5-turbo-instruct",
maxGenerationTokens: 500,
});

const modelWithMoreTokens = model.withSettings({
maxGenerationTokens: 1000,
});

Defined in

packages/modelfusion/src/model-function/Model.ts:34

Properties

modelInformation

modelInformation: ModelInformation

Defined in

packages/modelfusion/src/model-function/Model.ts:12


settings

Readonly settings: SETTINGS

Defined in

packages/modelfusion/src/model-function/Model.ts:13