MultiModalEmbedding
Defined in: packages/core/src/embeddings/muti-model.ts:16
Extends
Section titled “Extends”
abstractMultiModalEmbedding<Options>(nodes,options?):Promise
Defined in: packages/core/src/embeddings/muti-model.ts:16
Type Parameters
Section titled “Type Parameters”Options
Section titled “Options”Options extends Record<string, unknown>
Parameters
Section titled “Parameters”options?
Section titled “options?”Options
Returns
Section titled “Returns”Promise
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew MultiModalEmbedding():MultiModalEmbedding
Defined in: packages/core/src/embeddings/muti-model.ts:19
Returns
Section titled “Returns”MultiModalEmbedding
Overrides
Section titled “Overrides”Properties
Section titled “Properties”embedBatchSize
Section titled “embedBatchSize”embedBatchSize:
number=DEFAULT_EMBED_BATCH_SIZE
Defined in: packages/core/src/embeddings/base.ts:13
Inherited from
Section titled “Inherited from”id:
string
Defined in: packages/core/src/schema/type.ts:22
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”similarity()
Section titled “similarity()”similarity(
embedding1,embedding2,mode):number
Defined in: packages/core/src/embeddings/base.ts:55
Parameters
Section titled “Parameters”embedding1
Section titled “embedding1”number[]
embedding2
Section titled “embedding2”number[]
SimilarityType = SimilarityType.DEFAULT
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”getTextEmbedding()
Section titled “getTextEmbedding()”getTextEmbedding(
text):Promise<number[]>
Defined in: packages/core/src/embeddings/base.ts:63
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<number[]>
Inherited from
Section titled “Inherited from”BaseEmbedding.getTextEmbedding
getTextEmbeddings()
Section titled “getTextEmbeddings()”getTextEmbeddings(
texts):Promise<number[][]>
Defined in: packages/core/src/embeddings/base.ts:84
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<number[][]>
Inherited from
Section titled “Inherited from”BaseEmbedding.getTextEmbeddings
getTextEmbeddingsBatch()
Section titled “getTextEmbeddingsBatch()”getTextEmbeddingsBatch(
texts):Promise<number[][]>
Defined in: packages/core/src/embeddings/base.ts:99
Get embeddings for a batch of texts
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<number[][]>
Inherited from
Section titled “Inherited from”BaseEmbedding.getTextEmbeddingsBatch
getImageEmbedding()
Section titled “getImageEmbedding()”
abstractgetImageEmbedding(images):Promise<number[]>
Defined in: packages/core/src/embeddings/muti-model.ts:17
Parameters
Section titled “Parameters”images
Section titled “images”Returns
Section titled “Returns”Promise<number[]>
getImageEmbeddings()
Section titled “getImageEmbeddings()”getImageEmbeddings(
images):Promise<number[][]>
Defined in: packages/core/src/embeddings/muti-model.ts:51
Optionally override this method to retrieve multiple image embeddings in a single request
Parameters
Section titled “Parameters”images
Section titled “images”Returns
Section titled “Returns”Promise<number[][]>
getQueryEmbedding()
Section titled “getQueryEmbedding()”getQueryEmbedding(
query):Promise<number[] |null>
Defined in: packages/core/src/embeddings/muti-model.ts:57
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<number[] | null>