modelMapper

@waldiez/react v0.4.8

const modelMapper: object

Defined in: src/waldiez/models/mappers/model/modelMapper.ts:33

modelMapper is a utility object that provides methods to import and export models, as well as convert them to and from node format. It includes methods to import a model from JSON, export a model to JSON, and convert a WaldiezModel instance to a WaldiezNodeModel instance.

Type declaration¶

asNode()¶

asNode: (model, position?) => WaldiezNodeModel

Converts a WaldiezModel instance to a WaldiezNodeModel instance. It sets the position based on the provided coordinates or defaults to (0, 0).

Parameters¶

model¶

WaldiezModel

position?¶

x¶

number

y¶

number

Returns¶

WaldiezNodeModel

A new instance of WaldiezNodeModel representing the model.

exportModel()¶

exportModel: (modelNode, replaceSecrets) => object

Exports a model to JSON. If replaceSecrets is true, it replaces sensitive information with "REPLACE_ME".

Parameters¶

modelNode¶

WaldiezNodeModel

replaceSecrets¶

boolean

Returns¶

object

A JSON representation of the model.

createdAt¶

createdAt: string = modelNode.data.createdAt

data¶

data: object

data.apiKey¶

apiKey: null | string

data.apiType¶

apiType: WaldiezModelAPIType = modelNode.data.apiType

data.apiVersion¶

apiVersion: null | string = modelNode.data.apiVersion

data.aws¶

aws: undefined | null | WaldiezModelAWS | {[key: string]: undefined | null | string; }

data.baseUrl¶

baseUrl: null | string = modelNode.data.baseUrl

data.defaultHeaders¶

defaultHeaders: {[key: string]: unknown; } | {[key: string]: unknown; }

data.extras¶

extras: {[key: string]: unknown; } | {[key: string]: unknown; }

data.maxTokens¶

maxTokens: null | number = modelNode.data.maxTokens

data.price¶

price: WaldiezModelPrice = modelNode.data.price

data.temperature¶

temperature: null | number = modelNode.data.temperature

data.topP¶

topP: null | number = modelNode.data.topP

description¶

description: string = modelNode.data.description

id¶

id: string = modelNode.id

name¶

name: string = modelNode.data.label

requirements¶

requirements: string[] = modelNode.data.requirements

tags¶

tags: string[] = modelNode.data.tags

type¶

type: string = "model"

updatedAt¶

updatedAt: string = modelNode.data.updatedAt

importModel()¶

importModel: (json) => WaldiezModel

Imports a model from JSON. If the JSON is invalid or missing, it creates a new model with default values.

Parameters¶

json¶

unknown

Returns¶

WaldiezModel

A new instance of WaldiezModel.

See¶

WaldiezModel