Class: abstract
BaseEmbedding
Extended by
Implements
Constructors
new BaseEmbedding()
new BaseEmbedding():
BaseEmbedding
Returns
Properties
embedBatchSize
embedBatchSize:
number
=DEFAULT_EMBED_BATCH_SIZE
Source
packages/core/src/embeddings/types.ts:11
Methods
getQueryEmbedding()
abstract
getQueryEmbedding(query
):Promise
<number
[]>
Parameters
• query: string
Returns
Promise
<number
[]>
Source
packages/core/src/embeddings/types.ts:22
getTextEmbedding()
abstract
getTextEmbedding(text
):Promise
<number
[]>
Parameters
• text: string
Returns
Promise
<number
[]>
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
[][]>
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
[][]>
Source
packages/core/src/embeddings/types.ts:44
similarity()
similarity(
embedding1
,embedding2
,mode
):number
Parameters
• embedding1: number
[]
• embedding2: number
[]
• mode: SimilarityType
= SimilarityType.DEFAULT
Returns
number
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
>[]>
Implementation of
TransformComponent
. transform