BaseEmbedding
Defined in: packages/core/src/embeddings/base.ts:12
Extends
Section titled “Extends”TransformComponent<Promise<BaseNode[]>>
Extended by
Section titled “Extended by”BaseEmbedding<
Options>(nodes,options?):Promise
Defined in: packages/core/src/embeddings/base.ts:12
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”new BaseEmbedding(
optionsOrTransformFn?):BaseEmbedding
Defined in: packages/core/src/embeddings/base.ts:16
Parameters
Section titled “Parameters”optionsOrTransformFn?
Section titled “optionsOrTransformFn?”{ transformFn?: (nodes) => Promise<BaseNode<Metadata>[]>; embedFunc?: TextEmbedFunc; } | (nodes) => Promise<BaseNode<Metadata>[]>
Returns
Section titled “Returns”BaseEmbedding
Overrides
Section titled “Overrides”TransformComponent.constructor
Properties
Section titled “Properties”embedBatchSize
Section titled “embedBatchSize”embedBatchSize:
number=DEFAULT_EMBED_BATCH_SIZE
Defined in: packages/core/src/embeddings/base.ts:13
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
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[]>
getQueryEmbedding()
Section titled “getQueryEmbedding()”getQueryEmbedding(
query):Promise<number[] |null>
Defined in: packages/core/src/embeddings/base.ts:71
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<number[] | null>
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[][]>
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[][]>