Class: OllamaEmbedding

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

Hierarchy

• Ollama

  ↳ OllamaEmbedding

Implements

• BaseEmbedding

Constructors

constructor

• new OllamaEmbedding(params): OllamaEmbedding

Parameters

Name	Type
params	OllamaParams

Returns

OllamaEmbedding

Inherited from

Ollama.constructor

Defined in

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

Properties

embedBatchSize

• embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Implementation of

BaseEmbedding.embedBatchSize

Inherited from

Ollama.embedBatchSize

Defined in

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

---

hasStreaming

• Readonly hasStreaming: true

Inherited from

Ollama.hasStreaming

Defined in

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

---

model

• model: string

Inherited from

Ollama.model

Defined in

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

---

options

• options: Partial<Omit<Options, "temperature" | "top_p" | "num_ctx">> & Pick<Options, "temperature" | "top_p" | "num_ctx">

Inherited from

Ollama.options

Defined in

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

Accessors

metadata

• get metadata(): LLMMetadata

Returns

LLMMetadata

Inherited from

Ollama.metadata

Defined in

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

Methods

chat

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

Get a chat response from the LLM

Parameters

Name	Type
params	LLMChatParamsStreaming<object, object>

Returns

Promise<AsyncIterable<ChatResponseChunk>>

Inherited from

Ollama.chat

Defined in

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

▸ chat(params): Promise<ChatResponse<object>>

Parameters

Name	Type
params	LLMChatParamsNonStreaming<object, object>

Returns

Promise<ChatResponse<object>>

Inherited from

Ollama.chat

Defined in

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

---

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

▸ complete(params): Promise<CompletionResponse>

Parameters

Name	Type
params	LLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

Ollama.complete

Defined in

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

---

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

---

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

---

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

---

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

---

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

---

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

---

copy

▸ copy(source, destination): Promise<StatusResponse>

Parameters

Name	Type
source	string
destination	string

Returns

Promise<StatusResponse>

Inherited from

Ollama.copy

Defined in

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

---

create

▸ create(modelName, options?): Promise<ProgressResponse>

Parameters

Name	Type
modelName	string
options?	Omit<CreateRequest, "model"> & { stream: false }

Returns

Promise<ProgressResponse>

Inherited from

Ollama.create

Defined in

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

▸ create(modelName, options): Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Parameters

Name	Type
modelName	string
options	Omit<CreateRequest, "model"> & { stream: true }

Returns

Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Inherited from

Ollama.create

Defined in

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

---

delete

▸ delete(modelName): Promise<StatusResponse>

Parameters

Name	Type
modelName	string

Returns

Promise<StatusResponse>

Inherited from

Ollama.delete

Defined in

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

---

detail

▸ detail(modelName, options?): Promise<ShowResponse>

Parameters

Name	Type
modelName	string
options?	Omit<ShowRequest, "model">

Returns

Promise<ShowResponse>

Inherited from

Ollama.detail

Defined in

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

---

list

▸ list(): Promise<ModelResponse[]>

Returns

Promise<ModelResponse[]>

Inherited from

Ollama.list

Defined in

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

---

pull

▸ pull(modelName, options?): Promise<ProgressResponse>

Parameters

Name	Type
modelName	string
options?	Omit<CreateRequest, "model"> & { stream: false }

Returns

Promise<ProgressResponse>

Inherited from

Ollama.pull

Defined in

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

▸ pull(modelName, options): Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Parameters

Name	Type
modelName	string
options	Omit<CreateRequest, "model"> & { stream: true }

Returns

Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Inherited from

Ollama.pull

Defined in

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

---

push

▸ push(modelName, options?): Promise<ProgressResponse>

Parameters

Name	Type
modelName	string
options?	Omit<CreateRequest, "model"> & { stream: false }

Returns

Promise<ProgressResponse>

Inherited from

Ollama.push

Defined in

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

▸ push(modelName, options): Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Parameters

Name	Type
modelName	string
options	Omit<CreateRequest, "model"> & { stream: true }

Returns

Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Inherited from

Ollama.push

Defined in

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