Class: MultiModalEmbedding
Hierarchy
-
↳
MultiModalEmbedding
Constructors
constructor
• new MultiModalEmbedding(): MultiModalEmbedding
Returns
Inherited from
Properties
embedBatchSize
• embedBatchSize: number
= DEFAULT_EMBED_BATCH_SIZE
Inherited from
Defined in
packages/core/src/embeddings/types.ts:8
Methods
getImageEmbedding
▸ getImageEmbedding(images
): Promise
<number
[]>
Parameters
Name | Type |
---|---|
images | ImageType |
Returns
Promise
<number
[]>
Defined in
packages/core/src/embeddings/MultiModalEmbedding.ts:9
getImageEmbeddings
▸ getImageEmbeddings(images
): Promise
<number
[][]>
Parameters
Name | Type |
---|---|
images | ImageType [] |
Returns
Promise
<number
[][]>
Defined in
packages/core/src/embeddings/MultiModalEmbedding.ts:11
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:19
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:18
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:25
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:41
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
Defined in
packages/core/src/embeddings/types.ts:10