Passa al contenuto principale

Class: abstract MultiModalEmbedding

Extends​

Extended by​

Constructors​

new MultiModalEmbedding()​

new MultiModalEmbedding(): MultiModalEmbedding

Returns​

MultiModalEmbedding

Inherited from​

BaseEmbedding . constructor

Properties​

embedBatchSize​

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from​

BaseEmbedding . embedBatchSize

Source​

packages/core/src/embeddings/types.ts:13

Methods​

getImageEmbedding()​

abstract getImageEmbedding(images): Promise<number[]>

Parameters​

• images: ImageType

Returns​

Promise<number[]>

Source​

packages/core/src/embeddings/MultiModalEmbedding.ts:18

getImageEmbeddings()​

getImageEmbeddings(images): Promise<number[][]>

Optionally override this method to retrieve multiple image embeddings in a single request

Parameters​

• images: ImageType[]

Returns​

Promise<number[][]>

Source​

packages/core/src/embeddings/MultiModalEmbedding.ts:24

getQueryEmbedding()​

getQueryEmbedding(query): Promise<null | number[]>

Parameters​

• query: MessageContentDetail

Returns​

Promise<null | number[]>

Overrides​

BaseEmbedding . getQueryEmbedding

Source​

packages/core/src/embeddings/MultiModalEmbedding.ts:58

getTextEmbedding()​

abstract getTextEmbedding(text): Promise<number[]>

Parameters​

• text: string

Returns​

Promise<number[]>

Inherited from​

BaseEmbedding . getTextEmbedding

Source​

packages/core/src/embeddings/types.ts:23

getTextEmbeddings()​

getTextEmbeddings(texts): Promise<number[][]>

Optionally override this method to retrieve multiple embeddings in a single request

Parameters​

• texts: string[]

Returns​

Promise<number[][]>

Inherited from​

BaseEmbedding . getTextEmbeddings

Source​

packages/core/src/embeddings/types.ts:39

getTextEmbeddingsBatch()​

getTextEmbeddingsBatch(texts, options?): Promise<number[][]>

Get embeddings for a batch of texts

Parameters​

• texts: string[]

• options?

• options.logProgress?: boolean

Returns​

Promise<number[][]>

Inherited from​

BaseEmbedding . getTextEmbeddingsBatch

Source​

packages/core/src/embeddings/types.ts:55

similarity()​

similarity(embedding1, embedding2, mode): number

Parameters​

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType= SimilarityType.DEFAULT

Returns​

number

Inherited from​

BaseEmbedding . similarity

Source​

packages/core/src/embeddings/types.ts:15

transform()​

transform(nodes, _options?): Promise <BaseNode <Metadata>[]>

Parameters​

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns​

Promise <BaseNode <Metadata>[]>

Overrides​

BaseEmbedding . transform

Source​

packages/core/src/embeddings/MultiModalEmbedding.ts:30