Class: abstract
MultiModalEmbedding
Extends
Extended by
Constructors
new MultiModalEmbedding()
new MultiModalEmbedding():
MultiModalEmbedding
Returns
Inherited from
Properties
embedBatchSize
embedBatchSize:
number
=DEFAULT_EMBED_BATCH_SIZE
Inherited from
BaseEmbedding
. embedBatchSize
Source
packages/core/src/embeddings/types.ts:11
Methods
getImageEmbedding()
abstract
getImageEmbedding(images
):Promise
<number
[]>
Parameters
• images: ImageType
Returns
Promise
<number
[]>
Source
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
• images: ImageType
[]
Returns
Promise
<number
[][]>
Source
packages/core/src/embeddings/MultiModalEmbedding.ts:20
getQueryEmbedding()
abstract
getQueryEmbedding(query
):Promise
<number
[]>
Parameters
• query: string
Returns
Promise
<number
[]>
Inherited from
BaseEmbedding
. getQueryEmbedding
Source
packages/core/src/embeddings/types.ts:22
getTextEmbedding()
abstract
getTextEmbedding(text
):Promise
<number
[]>
Parameters
• text: string
Returns
Promise
<number
[]>
Inherited from
BaseEmbedding
. getTextEmbedding
Source
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
• texts: string
[]
Returns
Promise
<number
[][]>
Inherited from
BaseEmbedding
. 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
BaseEmbedding
. getTextEmbeddingsBatch
Source
packages/core/src/embeddings/types.ts:44
similarity()
similarity(
embedding1
,embedding2
,mode
):number
Parameters
• embedding1: number
[]
• embedding2: number
[]
• mode: SimilarityType
= SimilarityType.DEFAULT