Skip to content

Documentation / @agentick/core / ModelClass

Interface: ModelClass() ​

Defined in: core/src/model/adapter.ts:129

ModelClass - A model adapter that can be used both programmatically and as JSX.

This is the return type of createAdapter. It behaves like:

  • An EngineModel for programmatic use (createApp, direct generate/stream calls)
  • A JSX component for declarative use in agent trees

Example ​

typescript
const model = createAdapter({ ... });

// Use as JSX component
<model temperature={0.9}>
  <MyAgent />
</model>

// Use with createApp
const app = createApp(Agent, { model });

// Direct execution
const output = await model.generate(input);
for await (const event of model.stream(input)) { ... }

Extends ​

ModelClass(props): ReactElement

Defined in: core/src/model/adapter.ts:131

Use as JSX component

Parameters ​

props ​

ModelClassProps

Returns ​

ReactElement

Properties ​

embed? ​

optional embed: Procedure<(input) => Promise<EmbedResult>, false>

Defined in: core/src/model/model.ts:69

Generate embeddings (optional — only available on models with embedding support)

Inherited from ​

EngineModel.embed


fromEngineState()? ​

optional fromEngineState: (input) => Promise<ModelInput>

Defined in: core/src/model/model.ts:63

Convert engine state (COMInput) to model input

Parameters ​

input ​

COMInput

Returns ​

Promise<ModelInput>

Inherited from ​

EngineModel.fromEngineState


generate ​

generate: Procedure<(input) => Promise<ModelOutput>>

Defined in: core/src/model/model.ts:57

Generate a response (non-streaming)

Inherited from ​

EngineModel.generate


metadata ​

metadata: ModelMetadata

Defined in: core/src/model/model.ts:54

Model metadata (id, description, capabilities, etc.)

Inherited from ​

EngineModel.metadata


stream? ​

optional stream: Procedure<(input) => AsyncIterable<StreamEvent>, false>

Defined in: core/src/model/model.ts:60

Generate a streaming response

Inherited from ​

EngineModel.stream


toEngineState()? ​

optional toEngineState: (output) => Promise<EngineResponse>

Defined in: core/src/model/model.ts:66

Convert model output to engine response

Parameters ​

output ​

ModelOutput

Returns ​

Promise<EngineResponse>

Inherited from ​

EngineModel.toEngineState

Released under the ISC License.