Class: BaseEmbedding
Hierarchy
-
BaseEmbedding↳
Ollama
Implements
Implemented by
Constructors
constructor
• new BaseEmbedding(): BaseEmbedding
Returns
Properties
embedBatchSize
• embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE
Defined in
packages/core/src/embeddings/types.ts:9
Methods
getQueryEmbedding
▸ getQueryEmbedding(query): Promise<number[]>
Parameters
| Name | Type |
|---|---|
query | string |
Returns
Promise<number[]>
Defined in
packages/core/src/embeddings/types.ts:20
getTextEmbedding
▸ getTextEmbedding(text): Promise<number[]>
Parameters
| Name | Type |
|---|---|
text | string |
Returns
Promise<number[]>
Defined in
packages/core/src/embeddings/types.ts:19
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[][]>
Defined in
packages/core/src/embeddings/types.ts:26
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[][]>
Defined in
packages/core/src/embeddings/types.ts:42
similarity
▸ similarity(embedding1, embedding2, mode?): number
Parameters
| Name | Type | Default value |
|---|---|---|
embedding1 | number[] | undefined |
embedding2 | number[] | undefined |
mode | SimilarityType | SimilarityType.DEFAULT |
Returns
number
Defined in
packages/core/src/embeddings/types.ts:11
transform
▸ transform(nodes, _options?): Promise<BaseNode<Metadata>[]>
Parameters
| Name | Type |
|---|---|
nodes | BaseNode<Metadata>[] |
_options? | any |