Class: OllamaEmbedding

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

Extends

• Ollama

Implements

• BaseEmbedding

Constructors

new OllamaEmbedding()

new OllamaEmbedding(params): OllamaEmbedding

Parameters

• params: OllamaParams

Returns

OllamaEmbedding

Inherited from

Ollama.constructor

Defined in

packages/llamaindex/src/llm/ollama.ts:75

Properties

embedBatchSize

embedBatchSize: number

Implementation of

BaseEmbedding.embedBatchSize

Inherited from

Ollama.embedBatchSize

Defined in

packages/core/dist/embeddings/index.d.ts:34

---

embedInfo?

optional embedInfo: EmbeddingInfo

Implementation of

BaseEmbedding.embedInfo

Inherited from

Ollama.embedInfo

Defined in

packages/core/dist/embeddings/index.d.ts:35

---

getTextEmbeddings()

getTextEmbeddings: (texts) => Promise<number[][]>

Optionally override this method to retrieve multiple embeddings in a single request

Parameters

• texts: string[]

Returns

Promise<number[][]>

Implementation of

BaseEmbedding.getTextEmbeddings

Inherited from

Ollama.getTextEmbeddings

Defined in

packages/core/dist/embeddings/index.d.ts:43

---

hasStreaming

readonly hasStreaming: true = true

Inherited from

Ollama.hasStreaming

Defined in

packages/llamaindex/src/llm/ollama.ts:61

---

model

model: string

Inherited from

Ollama.model

Defined in

packages/llamaindex/src/llm/ollama.ts:66

---

ollama

ollama: Ollama

Inherited from

Ollama.ollama

Defined in

packages/llamaindex/src/llm/ollama.ts:63

---

options

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

Inherited from

Ollama.options

Defined in

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

Accessors

metadata

get metadata(): LLMMetadata

Returns

LLMMetadata

Inherited from

Ollama.metadata

Defined in

packages/llamaindex/src/llm/ollama.ts:87

Methods

abort()

abort(): void

Returns

void

Inherited from

Ollama.abort

Defined in

packages/llamaindex/src/llm/ollama.ts:205

---

chat()

chat(params)

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

Get a chat response from the LLM

Parameters

• params: LLMChatParamsStreaming<object, object>

Returns

Promise<AsyncIterable<ChatResponseChunk>>

Inherited from

Ollama.chat

Defined in

packages/llamaindex/src/llm/ollama.ts:99

chat(params)

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

Get a chat response from the LLM

Parameters

• params: LLMChatParamsNonStreaming<object, object>

Returns

Promise<ChatResponse<object>>

Inherited from

Ollama.chat

Defined in

packages/llamaindex/src/llm/ollama.ts:102

---

complete()

complete(params)

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

Get a prompt completion from the LLM

Parameters

• params: LLMCompletionParamsStreaming

Returns

Promise<AsyncIterable<CompletionResponse>>

Inherited from

Ollama.complete

Defined in

packages/llamaindex/src/llm/ollama.ts:140

complete(params)

complete(params): Promise<CompletionResponse>

Get a prompt completion from the LLM

Parameters

• params: LLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

Ollama.complete

Defined in

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

---

copy()

copy(request): Promise<StatusResponse>

Parameters

• request: CopyRequest

Returns

Promise<StatusResponse>

Inherited from

Ollama.copy

Defined in

packages/llamaindex/src/llm/ollama.ts:241

---

create()

create(request)

create(request): Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Parameters

• request: CreateRequest & object

Returns

Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Inherited from

Ollama.create

Defined in

packages/llamaindex/src/llm/ollama.ts:220

create(request)

create(request): Promise<ProgressResponse>

Parameters

• request: CreateRequest & object

Returns

Promise<ProgressResponse>

Inherited from

Ollama.create

Defined in

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

---

delete()

delete(request): Promise<StatusResponse>

Parameters

• request: DeleteRequest

Returns

Promise<StatusResponse>

Inherited from

Ollama.delete

Defined in

packages/llamaindex/src/llm/ollama.ts:238

---

embeddings()

embeddings(request): Promise<EmbeddingsResponse>

Parameters

• request: EmbeddingsRequest

Returns

Promise<EmbeddingsResponse>

Inherited from

Ollama.embeddings

Defined in

packages/llamaindex/src/llm/ollama.ts:250

---

encodeImage()

encodeImage(image): Promise<string>

Parameters

• image: string | Uint8Array

Returns

Promise<string>

Inherited from

Ollama.encodeImage

Defined in

packages/llamaindex/src/llm/ollama.ts:208

---

generate()

generate(request)

generate(request): Promise<AsyncGenerator<GenerateResponse, any, unknown>>

Parameters

• request: GenerateRequest & object

Returns

Promise<AsyncGenerator<GenerateResponse, any, unknown>>

Inherited from

Ollama.generate

Defined in

packages/llamaindex/src/llm/ollama.ts:211

generate(request)

generate(request): Promise<GenerateResponse>

Parameters

• request: GenerateRequest & object

Returns

Promise<GenerateResponse>

Inherited from

Ollama.generate

Defined in

packages/llamaindex/src/llm/ollama.ts:214

---

getQueryEmbedding()

getQueryEmbedding(query): Promise<null | number[]>

Parameters

• query: MessageContentDetail

Returns

Promise<null | number[]>

Implementation of

BaseEmbedding.getQueryEmbedding

Inherited from

Ollama.getQueryEmbedding

Defined in

packages/core/dist/embeddings/index.d.ts:38

---

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Parameters

• text: string

Returns

Promise<number[]>

Implementation of

BaseEmbedding.getTextEmbedding

Inherited from

Ollama.getTextEmbedding

Defined in

packages/llamaindex/src/llm/ollama.ts:190

---

getTextEmbeddingsBatch()

getTextEmbeddingsBatch(texts, options?): Promise<number[][]>

Get embeddings for a batch of texts

Parameters

• texts: string[]

• options?: BaseEmbeddingOptions

Returns

Promise<number[][]>

Implementation of

BaseEmbedding.getTextEmbeddingsBatch

Inherited from

Ollama.getTextEmbeddingsBatch

Defined in

packages/core/dist/embeddings/index.d.ts:49

---

list()

list(): Promise<ListResponse>

Returns

Promise<ListResponse>

Inherited from

Ollama.list

Defined in

packages/llamaindex/src/llm/ollama.ts:244

---

pull()

pull(request)

pull(request): Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Parameters

• request: PullRequest & object

Returns

Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Inherited from

Ollama.pull

Defined in

packages/llamaindex/src/llm/ollama.ts:229

pull(request)

pull(request): Promise<ProgressResponse>

Parameters

• request: PullRequest & object

Returns

Promise<ProgressResponse>

Inherited from

Ollama.pull

Defined in

packages/llamaindex/src/llm/ollama.ts:232

---

push()

push(request)

push(request): Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Parameters

• request: PushRequest & object

Returns

Promise<AsyncGenerator<ProgressResponse, any, unknown>>

Inherited from

Ollama.push

Defined in

packages/llamaindex/src/llm/ollama.ts:196

push(request)

push(request): Promise<ProgressResponse>

Parameters

• request: PushRequest & object

Returns

Promise<ProgressResponse>

Inherited from

Ollama.push

Defined in

packages/llamaindex/src/llm/ollama.ts:199

---

show()

show(request): Promise<ShowResponse>

Parameters

• request: ShowRequest

Returns

Promise<ShowResponse>

Inherited from

Ollama.show

Defined in

packages/llamaindex/src/llm/ollama.ts:247

---

similarity()

similarity(embedding1, embedding2, mode?): number

Parameters

• embedding1: number[]

• embedding2: number[]

• mode?: SimilarityType

Returns

number

Implementation of

BaseEmbedding.similarity

Inherited from

Ollama.similarity

Defined in

packages/core/dist/embeddings/index.d.ts:36

---

transform()

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

Parameters

• nodes: BaseNode<Metadata>[]

• options?: BaseEmbeddingOptions

Returns

Promise<BaseNode<Metadata>[]>

Implementation of

BaseEmbedding.transform

Inherited from

Ollama.transform

Defined in

packages/core/dist/embeddings/index.d.ts:50

---

truncateMaxTokens()

truncateMaxTokens(input): string[]

Parameters

• input: string[]

Returns

string[]

Implementation of

BaseEmbedding.truncateMaxTokens

Inherited from

Ollama.truncateMaxTokens

Defined in

packages/core/dist/embeddings/index.d.ts:51