npm.io
1.3.0 • Published 4 months ago

@langchain/ollama

Licence
MIT
Version
1.3.0
Deps
1
Size
265 kB
Vulns
0
Weekly
0
Stars
18.3K

@langchain/ollama

This package contains the LangChain.js integrations for Ollama via the ollama TypeScript SDK.

Installation

npm install @langchain/ollama @langchain/core

Setup

To use this package, you need to have Ollama running locally:

  1. Download and install Ollama from ollama.com
  2. Pull a model: ollama pull llama3
  3. Ensure the Ollama server is running (it starts automatically after installation)

By default, the package connects to http://localhost:11434. You can customize this by setting the baseUrl option when instantiating the model.

Chat Models

import { ChatOllama } from "@langchain/ollama";

const model = new ChatOllama({
  model: "llama3", // Default value.
});

const result = await model.invoke(["human", "Hello, how are you?"]);

Development

To develop the @langchain/ollama package, you'll need to follow these instructions:

Install dependencies
pnpm install
Build the package
pnpm build

Or from the repo root:

pnpm build --filter @langchain/ollama
Run tests

Test files should live within a tests/ file in the src/ folder. Unit tests should end in .test.ts and integration tests should end in .int.test.ts:

$ pnpm test
$ pnpm test:int
Lint & Format

Run the linter & formatter to ensure your code is up to standard:

pnpm lint && pnpm format
Adding new entrypoints

If you add a new file to be exported, either import & re-export from src/index.ts, or add it to the exports field in the package.json file and run pnpm build to generate the new entrypoint.