Interface: EmbeddingModel<TValue>
Defined in: packages/protocol/src/embedding-model/model.ts:17
Embedding model interface.
TValue is the type of values that can be embedded. Currently string for text, but could support images, audio, etc. in the future.
Type Parameters
| Type Parameter | Default type |
|---|---|
TValue | string |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
maxEmbeddingsPerCall? | readonly | number | Maximum number of values that can be embedded in a single call. undefined means no limit is known. | packages/protocol/src/embedding-model/model.ts:37 |
modelId | readonly | string | Provider-specific model ID. | packages/protocol/src/embedding-model/model.ts:31 |
provider | readonly | string | Provider ID. | packages/protocol/src/embedding-model/model.ts:26 |
spec | readonly | "1.0" | The embedding model must specify which embedding model interface version it implements. | packages/protocol/src/embedding-model/model.ts:21 |
supportsParallelCalls? | readonly | boolean | Whether this model can handle multiple embed calls in parallel. | packages/protocol/src/embedding-model/model.ts:42 |
Methods
embed()
embed(request: EmbeddingModelRequest<TValue>): Promise<EmbeddingModelResponse>;Defined in: packages/protocol/src/embedding-model/model.ts:49
Generate embeddings for the given input values.
Parameters
| Parameter | Type | Description |
|---|---|---|
request | EmbeddingModelRequest<TValue> | The embedding request. |
Returns
Promise<EmbeddingModelResponse>