Skip to content

@chinmaymk/aikit v0.0.40


@chinmaymk/aikit / EmbeddingOptions

Interface: EmbeddingOptions

Defined in: types.ts:231

The basic options for controlling embedding generation. These are the options that all embedding providers understand.

Extended by

Properties

model?

optional model: string

Defined in: types.ts:233

The specific embedding model you want to use. e.g., 'text-embedding-3-small' or 'text-embedding-004'.


dimensions?

optional dimensions: number

Defined in: types.ts:235

The number of dimensions in the output embeddings. Only supported by some models.


taskType?

optional taskType: "query" | "document" | "similarity" | "classification" | "clustering"

Defined in: types.ts:237

The type of task the embeddings will be used for. Helps optimize the embeddings.


autoTruncate?

optional autoTruncate: boolean

Defined in: types.ts:239

Whether to automatically truncate input text that exceeds the model's limit.

Released under the MIT License.