Class: BaseEmbedding

Hierarchy

• BaseEmbedding

  ↳ HuggingFaceEmbedding

  ↳ MistralAIEmbedding

  ↳ MultiModalEmbedding

  ↳ OpenAIEmbedding

  ↳ Ollama

Implements

• TransformComponent

Constructors

constructor

• new BaseEmbedding(): BaseEmbedding

Returns

BaseEmbedding

Methods

getQueryEmbedding

▸ getQueryEmbedding(query): Promise<number[]>

Parameters

Name	Type
query	string

Returns

Promise<number[]>

Defined in

packages/core/src/embeddings/types.ts:15

---

getTextEmbedding

▸ getTextEmbedding(text): Promise<number[]>

Parameters

Name	Type
text	string

Returns

Promise<number[]>

Defined in

packages/core/src/embeddings/types.ts:14

---

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:6

---

transform

▸ transform(nodes, _options?): Promise<BaseNode<Metadata>[]>

Parameters

Name	Type
nodes	BaseNode<Metadata>[]
_options?	any

Returns

Promise<BaseNode<Metadata>[]>

Implementation of

TransformComponent.transform

Defined in

packages/core/src/embeddings/types.ts:17