Class: OllamaEmbedding

OllamaEmbedding is an alias for Ollama that implements the BaseEmbedding interface.

Hierarchy

• Ollama

  ↳ OllamaEmbedding

Implements

• BaseEmbedding

Constructors

constructor

• new OllamaEmbedding(init): OllamaEmbedding

Parameters

Name	Type
init	Partial<Ollama> & { model: string ; modelMetadata?: Partial<LLMMetadata> }

Returns

OllamaEmbedding

Inherited from

Ollama.constructor

Defined in

packages/core/src/llm/ollama.ts:42

Properties

additionalChatOptions

• Optional additionalChatOptions: Record<string, unknown>

Inherited from

Ollama.additionalChatOptions

Defined in

packages/core/src/llm/ollama.ts:37

---

baseURL

• baseURL: string = "http://127.0.0.1:11434"

Inherited from

Ollama.baseURL

Defined in

packages/core/src/llm/ollama.ts:32

---

callbackManager

• Optional callbackManager: CallbackManager

Inherited from

Ollama.callbackManager

Defined in

packages/core/src/llm/ollama.ts:38

---

contextWindow

• contextWindow: number = 4096

Inherited from

Ollama.contextWindow

Defined in

packages/core/src/llm/ollama.ts:35

---

embedBatchSize

• embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Implementation of

BaseEmbedding.embedBatchSize

Inherited from

Ollama.embedBatchSize

Defined in

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

---

hasStreaming

• Readonly hasStreaming: true

Inherited from

Ollama.hasStreaming

Defined in

packages/core/src/llm/ollama.ts:28

---

model

• model: string

Inherited from

Ollama.model

Defined in

packages/core/src/llm/ollama.ts:31

---

modelMetadata

• Protected modelMetadata: Partial<LLMMetadata>

Inherited from

Ollama.modelMetadata

Defined in

packages/core/src/llm/ollama.ts:40

---

requestTimeout

• requestTimeout: number

Inherited from

Ollama.requestTimeout

Defined in

packages/core/src/llm/ollama.ts:36

---

temperature

• temperature: number = 0.7

Inherited from

Ollama.temperature

Defined in

packages/core/src/llm/ollama.ts:33

---

topP

• topP: number = 0.9

Inherited from

Ollama.topP

Defined in

packages/core/src/llm/ollama.ts:34

Accessors

metadata

• get metadata(): LLMMetadata

Returns

LLMMetadata

Inherited from

Ollama.metadata

Defined in

packages/core/src/llm/ollama.ts:55

Methods

chat

▸ chat(params): Promise<AsyncIterable<ChatResponseChunk>>

Get a chat response from the LLM

Parameters

Name	Type
params	LLMChatParamsStreaming

Returns

Promise<AsyncIterable<ChatResponseChunk>>

Inherited from

Ollama.chat

Defined in

packages/core/src/llm/ollama.ts:67

▸ chat(params): Promise<ChatResponse>

Parameters

Name	Type
params	LLMChatParamsNonStreaming

Returns

Promise<ChatResponse>

Inherited from

Ollama.chat

Defined in

packages/core/src/llm/ollama.ts:70

---

complete

▸ complete(params): Promise<AsyncIterable<CompletionResponse>>

Get a prompt completion from the LLM

Parameters

Name	Type
params	LLMCompletionParamsStreaming

Returns

Promise<AsyncIterable<CompletionResponse>>

Inherited from

Ollama.complete

Defined in

packages/core/src/llm/ollama.ts:143

▸ complete(params): Promise<CompletionResponse>

Parameters

Name	Type
params	LLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

Ollama.complete

Defined in

packages/core/src/llm/ollama.ts:146

---

getQueryEmbedding

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

Parameters

Name	Type
query	string

Returns

Promise<number[]>

Implementation of

BaseEmbedding.getQueryEmbedding

Inherited from

Ollama.getQueryEmbedding

Defined in

packages/core/src/llm/ollama.ts:217

---

getTextEmbedding

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

Parameters

Name	Type
text	string

Returns

Promise<number[]>

Implementation of

BaseEmbedding.getTextEmbedding

Inherited from

Ollama.getTextEmbedding

Defined in

packages/core/src/llm/ollama.ts:213

---

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[][]>

Implementation of

BaseEmbedding.getTextEmbeddings

Inherited from

Ollama.getTextEmbeddings

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[][]>

Implementation of

BaseEmbedding.getTextEmbeddingsBatch

Inherited from

Ollama.getTextEmbeddingsBatch

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

Implementation of

BaseEmbedding.similarity

Inherited from

Ollama.similarity

Defined in

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

---

tokens

▸ tokens(messages): number

Calculates the number of tokens needed for the given chat messages

Parameters

Name	Type
messages	ChatMessage[]

Returns

number

Inherited from

Ollama.tokens

Defined in

packages/core/src/llm/ollama.ts:186

---

transform

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

Parameters

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

Returns

Promise<BaseNode<Metadata>[]>

Implementation of

BaseEmbedding.transform

Inherited from

Ollama.transform

Defined in

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