Interface IEmbedding

Interface for embedding providers.

Deprecated

Use BaseEmbeddings from @memberjunction/ai instead, which provides a more complete API with proper typing (EmbedTextResult, EmbedTextsResult).

interface IEmbedding {
    createBatchEmbedding(
        text: string[],
        options?: EmbeddingOptions,
    ): Promise<BatchEmbeddingResult>;
    createEmbedding(
        text: string,
        options?: EmbeddingOptions,
    ): Promise<EmbeddingResult>;
}

Index

Methods

createBatchEmbedding createEmbedding

Methods

createBatchEmbedding

createBatchEmbedding(
text: string[],
options?: EmbeddingOptions,
): Promise<BatchEmbeddingResult>
Parameters
- text: string[]
- Optionaloptions: EmbeddingOptions
Returns Promise<BatchEmbeddingResult>
- Defined in generic/IEmbedding.ts:8

createEmbedding

createEmbedding(
text: string,
options?: EmbeddingOptions,
): Promise<EmbeddingResult>
Parameters
- text: string
- Optionaloptions: EmbeddingOptions
Returns Promise<EmbeddingResult>
- Defined in generic/IEmbedding.ts:7