Class: ClipEmbedding

Extends

• MultiModalEmbedding

Constructors

new ClipEmbedding()

new ClipEmbedding(): ClipEmbedding

Returns

ClipEmbedding

Inherited from

MultiModalEmbedding . constructor

Properties

embedBatchSize

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from

MultiModalEmbedding . embedBatchSize

Source

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

---

modelType

modelType: ClipEmbeddingModelType = ClipEmbeddingModelType.XENOVA_CLIP_VIT_BASE_PATCH16

Source

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

---

processor

private processor: null | Processor = null

Source

packages/core/src/embeddings/ClipEmbedding.ts:34

---

textModel

private textModel: null | CLIPTextModelWithProjection = null

Source

packages/core/src/embeddings/ClipEmbedding.ts:36

---

tokenizer

private tokenizer: null | PreTrainedTokenizer = null

Source

packages/core/src/embeddings/ClipEmbedding.ts:33

---

visionModel

private visionModel: null | CLIPVisionModelWithProjection = null

Source

packages/core/src/embeddings/ClipEmbedding.ts:35

Methods

getImageEmbedding()

getImageEmbedding(image): Promise<number[]>

Parameters

• image: ImageType

Returns

Promise<number[]>

Overrides

MultiModalEmbedding . getImageEmbedding

Source

packages/core/src/embeddings/ClipEmbedding.ts:76

---

getImageEmbeddings()

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

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

Parameters

• images: ImageType[]

Returns

Promise<number[][]>

Inherited from

MultiModalEmbedding . getImageEmbeddings

Source

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

---

getProcessor()

getProcessor(): Promise<Processor>

Returns

Promise<Processor>

Source

packages/core/src/embeddings/ClipEmbedding.ts:46

---

getQueryEmbedding()

getQueryEmbedding(query): Promise<number[]>

Parameters

• query: string

Returns

Promise<number[]>

Overrides

MultiModalEmbedding . getQueryEmbedding

Source

packages/core/src/embeddings/ClipEmbedding.ts:91

---

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Parameters

• text: string

Returns

Promise<number[]>

Overrides

MultiModalEmbedding . getTextEmbedding

Source

packages/core/src/embeddings/ClipEmbedding.ts:83

---

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

MultiModalEmbedding . getTextEmbeddings

Source

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

---

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

MultiModalEmbedding . getTextEmbeddingsBatch

Source

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

---

getTextModel()

getTextModel(): Promise<CLIPTextModelWithProjection>

Returns

Promise<CLIPTextModelWithProjection>

Source

packages/core/src/embeddings/ClipEmbedding.ts:65

---

getTokenizer()

getTokenizer(): Promise<PreTrainedTokenizer>

Returns

Promise<PreTrainedTokenizer>

Source

packages/core/src/embeddings/ClipEmbedding.ts:38

---

getVisionModel()

getVisionModel(): Promise<CLIPVisionModelWithProjection>

Returns

Promise<CLIPVisionModelWithProjection>

Source

packages/core/src/embeddings/ClipEmbedding.ts:54

---

similarity()

similarity(embedding1, embedding2, mode): number

Parameters

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType= SimilarityType.DEFAULT

Returns

number

Inherited from

MultiModalEmbedding . similarity

Source

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

---

transform()

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

Parameters

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns

Promise <BaseNode <Metadata>[]>

Inherited from

MultiModalEmbedding . transform

Source

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