Class: Ollama()
Unified language model interface
Extends
Extended by
Implements
Ollama<
Options
>(nodes
,options
?):Promise
<BaseNode
<Metadata
>[]>
Unified language model interface
Type Parameters
• Options extends Record
<string
, unknown
>
Parameters
• options?: Options
Returns
Defined in
packages/providers/ollama/dist/index.d.ts:10
Constructors
new Ollama()
new Ollama(
params
):Ollama
Parameters
• params: OllamaParams
Returns
Overrides
Defined in
packages/providers/ollama/dist/index.d.ts:14
Properties
embedBatchSize
embedBatchSize:
number
Inherited from
Defined in
packages/core/embeddings/dist/index.d.ts:45
embedInfo?
optional
embedInfo:EmbeddingInfo
Inherited from
Defined in
packages/core/embeddings/dist/index.d.ts:46
getTextEmbeddings()
getTextEmbeddings: (
texts
) =>Promise
<number
[][]>
Optionally override this method to retrieve multiple embeddings in a single request
Parameters
• texts: string
[]
Returns
Promise
<number
[][]>
Inherited from
BaseEmbedding
.getTextEmbeddings
Defined in
packages/core/embeddings/dist/index.d.ts:55
id
id:
string
Inherited from
Defined in
packages/core/schema/dist/index.d.ts:171
model
model:
string
Defined in
packages/providers/ollama/dist/index.d.ts:12
ollama
readonly
ollama:Ollama
Defined in
packages/providers/ollama/dist/index.d.ts:11
options
options:
Partial
<Omit
<Options
,"temperature"
|"top_p"
|"num_ctx"
>> &Pick
<Options
,"temperature"
|"top_p"
|"num_ctx"
>
Defined in
packages/providers/ollama/dist/index.d.ts:13
Accessors
metadata
Get Signature
get metadata():
LLMMetadata
Returns
Implementation of
Defined in
packages/providers/ollama/dist/index.d.ts:15
Methods
chat()
chat(params)
chat(
params
):Promise
<AsyncIterable
<ChatResponseChunk
,any
,any
>>
Get a chat response from the LLM
Parameters
• params: LLMChatParamsStreaming
<object
, object
>
Returns
Promise
<AsyncIterable
<ChatResponseChunk
, any
, any
>>
Implementation of
Defined in
packages/providers/ollama/dist/index.d.ts:16
chat(params)
chat(
params
):Promise
<ChatResponse
<object
>>
Parameters
• params: LLMChatParamsNonStreaming
<object
, object
>
Returns
Promise
<ChatResponse
<object
>>
Implementation of
Defined in
packages/providers/ollama/dist/index.d.ts:17
complete()
complete(params)
complete(
params
):Promise
<AsyncIterable
<CompletionResponse
,any
,any
>>
Get a prompt completion from the LLM
Parameters
• params: LLMCompletionParamsStreaming
Returns
Promise
<AsyncIterable
<CompletionResponse
, any
, any
>>
Implementation of
Defined in
packages/providers/ollama/dist/index.d.ts:18
complete(params)
complete(
params
):Promise
<CompletionResponse
>
Parameters
• params: LLMCompletionParamsNonStreaming
Returns
Promise
<CompletionResponse
>
Implementation of
Defined in
packages/providers/ollama/dist/index.d.ts:19
getQueryEmbedding()
getQueryEmbedding(
query
):Promise
<null
|number
[]>
Parameters
• query: MessageContentDetail
Returns
Promise
<null
| number
[]>
Inherited from
BaseEmbedding
.getQueryEmbedding
Defined in
packages/core/embeddings/dist/index.d.ts:50
getTextEmbedding()
getTextEmbedding(
text
):Promise
<number
[]>
Parameters
• text: string
Returns
Promise
<number
[]>
Overrides
BaseEmbedding
.getTextEmbedding
Defined in
packages/providers/ollama/dist/index.d.ts:21
getTextEmbeddingsBatch()
getTextEmbeddingsBatch(
texts
,options
?):Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
• texts: string
[]
• options?: BaseEmbeddingOptions
Returns
Promise
<number
[][]>
Inherited from
BaseEmbedding
.getTextEmbeddingsBatch
Defined in
packages/core/embeddings/dist/index.d.ts:61
similarity()
similarity(
embedding1
,embedding2
,mode
?):number
Parameters
• embedding1: number
[]
• embedding2: number
[]
• mode?: SimilarityType
Returns
number
Inherited from
Defined in
packages/core/embeddings/dist/index.d.ts:48
truncateMaxTokens()
truncateMaxTokens(
input
):string
[]
Parameters
• input: string
[]
Returns
string
[]
Inherited from
BaseEmbedding
.truncateMaxTokens
Defined in
packages/core/embeddings/dist/index.d.ts:62