Class: MultiModalEmbedding

Hierarchy

• BaseEmbedding

  ↳ MultiModalEmbedding

  ↳↳ ClipEmbedding

Constructors

constructor

• new MultiModalEmbedding(): MultiModalEmbedding

Returns

MultiModalEmbedding

Inherited from

BaseEmbedding.constructor

Properties

embedBatchSize

• embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from

BaseEmbedding.embedBatchSize

Defined in

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

Methods

getImageEmbedding

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

Parameters

Name	Type
images	ImageType

Returns

Promise<number[]>

Defined in

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

---

getImageEmbeddings

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

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

Parameters

Name	Type
images	ImageType[]

Returns

Promise<number[][]>

Defined in

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

---

getQueryEmbedding

▸ getQueryEmbedding(query): Promise<number[]>

Parameters

Name	Type
query	string

Returns

Promise<number[]>

Inherited from

BaseEmbedding.getQueryEmbedding

Defined in

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

---

getTextEmbedding

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

Parameters

Name	Type
text	string

Returns

Promise<number[]>

Inherited from

BaseEmbedding.getTextEmbedding

Defined in

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

---

getTextEmbeddings

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

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

Parameters

Name	Type
texts	string[]

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddings

Defined in

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

---

getTextEmbeddingsBatch

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

Get embeddings for a batch of texts

Parameters

Name	Type
texts	string[]
options?	Object
options.logProgress?	boolean

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddingsBatch

Defined in

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

---

similarity

▸ similarity(embedding1, embedding2, mode?): number

Parameters

Name	Type	Default value
embedding1	number[]	undefined
embedding2	number[]	undefined
mode	SimilarityType	SimilarityType.DEFAULT

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

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

---

transform

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

Parameters

Name	Type
nodes	BaseNode<Metadata>[]
_options?	any

Returns

Promise<BaseNode<Metadata>[]>

Overrides

BaseEmbedding.transform

Defined in

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