Aller au contenu principal

Class: OllamaEmbedding

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

Hierarchy

Implements

Constructors

constructor

new OllamaEmbedding(init): OllamaEmbedding

Parameters

NameType
initPartial<Ollama> & { model: string ; modelMetadata?: Partial<LLMMetadata> }

Returns

OllamaEmbedding

Inherited from

Ollama.constructor

Defined in

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

Properties

additionalChatOptions

Optional additionalChatOptions: Record<string, unknown>

Inherited from

Ollama.additionalChatOptions

Defined in

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


baseURL

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

Inherited from

Ollama.baseURL

Defined in

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


contextWindow

contextWindow: number = 4096

Inherited from

Ollama.contextWindow

Defined in

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


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


model

model: string

Inherited from

Ollama.model

Defined in

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


modelMetadata

Protected modelMetadata: Partial<LLMMetadata>

Inherited from

Ollama.modelMetadata

Defined in

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


requestTimeout

requestTimeout: number

Inherited from

Ollama.requestTimeout

Defined in

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


temperature

temperature: number = 0.7

Inherited from

Ollama.temperature

Defined in

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


topP

topP: number = 0.9

Inherited from

Ollama.topP

Defined in

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

Accessors

metadata

get metadata(): LLMMetadata

Returns

LLMMetadata

Inherited from

Ollama.metadata

Defined in

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

Methods

chat

chat(params): Promise<AsyncIterable<{ delta: string ; options?: Record<string, unknown> }>>

Get a chat response from the LLM

Parameters

NameType
paramsLLMChatParamsStreaming<Record<string, unknown>>

Returns

Promise<AsyncIterable<{ delta: string ; options?: Record<string, unknown> }>>

Inherited from

Ollama.chat

Defined in

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

chat(params): Promise<ChatResponse<Record<string, unknown>>>

Parameters

NameType
paramsLLMChatParamsNonStreaming<Record<string, unknown>>

Returns

Promise<ChatResponse<Record<string, unknown>>>

Inherited from

Ollama.chat

Defined in

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


complete

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

Get a prompt completion from the LLM

Parameters

NameType
paramsLLMCompletionParamsStreaming

Returns

Promise<AsyncIterable<CompletionResponse>>

Inherited from

Ollama.complete

Defined in

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

complete(params): Promise<CompletionResponse>

Parameters

NameType
paramsLLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

Ollama.complete

Defined in

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


getQueryEmbedding

getQueryEmbedding(query): Promise<number[]>

Parameters

NameType
querystring

Returns

Promise<number[]>

Implementation of

BaseEmbedding.getQueryEmbedding

Inherited from

Ollama.getQueryEmbedding

Defined in

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


getTextEmbedding

getTextEmbedding(text): Promise<number[]>

Parameters

NameType
textstring

Returns

Promise<number[]>

Implementation of

BaseEmbedding.getTextEmbedding

Inherited from

Ollama.getTextEmbedding

Defined in

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


getTextEmbeddings

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

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

Parameters

NameType
textsstring[]

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

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

NameTypeDefault value
embedding1number[]undefined
embedding2number[]undefined
modeSimilarityTypeSimilarityType.DEFAULT

Returns

number

Implementation of

BaseEmbedding.similarity

Inherited from

Ollama.similarity

Defined in

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


transform

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

Parameters

NameType
nodesBaseNode<Metadata>[]
_options?any

Returns

Promise<BaseNode<Metadata>[]>

Implementation of

BaseEmbedding.transform

Inherited from

Ollama.transform

Defined in

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