Interface: ObjectGenerationModel<PROMPT, SETTINGS>
Type parameters
| Name | Type |
|---|---|
PROMPT | PROMPT |
SETTINGS | extends ObjectGenerationModelSettings = ObjectGenerationModelSettings |
Hierarchy
-
Model<SETTINGS>↳
ObjectGenerationModel
Implemented by
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>
Inherited from
Model.settingsForEvent
Defined in
packages/modelfusion/src/model-function/Model.ts:19
Methods
doGenerateObject
▸ doGenerateObject(schema, prompt, options?): PromiseLike<{ rawResponse: unknown ; usage?: { completionTokens: number ; promptTokens: number ; totalTokens: number } ; value: unknown ; valueText: string }>
Parameters
| Name | Type |
|---|---|
schema | Schema<unknown> & JsonSchemaProducer |
prompt | PROMPT |
options? | FunctionOptions |
Returns
PromiseLike<{ rawResponse: unknown ; usage?: { completionTokens: number ; promptTokens: number ; totalTokens: number } ; value: unknown ; valueText: string }>
Defined in
packages/modelfusion/src/model-function/generate-object/ObjectGenerationModel.ts:14
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
| Name | Type |
|---|---|
additionalSettings | Partial<SETTINGS> |
Returns
this
Example
const model = new OpenAICompletionModel({
model: "gpt-3.5-turbo-instruct",
maxGenerationTokens: 500,
});
const modelWithMoreTokens = model.withSettings({
maxGenerationTokens: 1000,
});
Inherited from
Defined in
packages/modelfusion/src/model-function/Model.ts:34
Properties
modelInformation
• modelInformation: ModelInformation
Inherited from
Defined in
packages/modelfusion/src/model-function/Model.ts:12
settings
• Readonly settings: SETTINGS