Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update READMEs #3693

Merged
merged 1 commit into from
Dec 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion libs/create-langchain-integration/template/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,41 @@
# @langchain/<ADD_PACKAGE_NAME_HERE>

This package contains the LangChainJS integrations for <ADD_NAME_HERE> through their SDK.
This package contains the LangChain.js integrations for <ADD_NAME_HERE> through their SDK.

## Installation

```bash npm2yarn
npm install @langchain/<ADD_PACKAGE_NAME_HERE>
```

This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).
If you are using this package with other LangChain packages, you should make sure that all of the packages depend on the same instance of @langchain/core.
You can do so by adding appropriate field to your project's `package.json` like this:

```json
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/<ADD_PACKAGE_NAME_HERE>": "^0.0.0",
"langchain": "0.0.207"
},
"resolutions": {
"@langchain/core": "0.1.1"
},
"overrides": {
"@langchain/core": "0.1.1"
},
"pnpm": {
"overrides": {
"@langchain/core": "0.1.1"
}
}
}
```

The field you need depends on the package manager you're using, but we recommend adding a field for the common `yarn`, `npm`, and `pnpm` to maximize compatibility.

## Chat Models

This package contains the `<ADD_CLASS_NAME_HERE>` class, which is the recommended way to interface with the <ADD_NAME_HERE> series of models.
Expand Down
30 changes: 29 additions & 1 deletion libs/langchain-anthropic/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,41 @@
# @langchain/anthropic

This package contains the LangChainJS integrations for Anthropic through their SDK.
This package contains the LangChain.js integrations for Anthropic through their SDK.

## Installation

```bash npm2yarn
npm install @langchain/anthropic
```

This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).
If you are using this package with other LangChain packages, you should make sure that all of the packages depend on the same instance of @langchain/core.
You can do so by adding appropriate fields to your project's `package.json` like this:

```json
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/anthropic": "^0.0.0",
"langchain": "0.0.207"
},
"resolutions": {
"@langchain/core": "0.1.1"
},
"overrides": {
"@langchain/core": "0.1.1"
},
"pnpm": {
"overrides": {
"@langchain/core": "0.1.1"
}
}
}
```

The field you need depends on the package manager you're using, but we recommend adding a field for the common `yarn`, `npm`, and `pnpm` to maximize compatibility.

## Chat Models

This package contains the `ChatAnthropic` class, which is the recommended way to interface with the Anthropic series of models.
Expand Down
28 changes: 28 additions & 0 deletions libs/langchain-community/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,34 @@
$ yarn add @langchain/community
```

This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).
If you are using this package with other LangChain packages, you should make sure that all of the packages depend on the same instance of @langchain/core.
You can do so by adding appropriate field to your project's `package.json` like this:

```json
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/<ADD_PACKAGE_NAME_HERE>": "^0.0.0",
"langchain": "0.0.207"
},
"resolutions": {
"@langchain/core": "0.1.1"
},
"overrides": {
"@langchain/core": "0.1.1"
},
"pnpm": {
"overrides": {
"@langchain/core": "0.1.1"
}
}
}
```

The field you need depends on the package manager you're using, but we recommend adding a field for the common `yarn`, `npm`, and `pnpm` to maximize compatibility.

## 🤔 What is this?

LangChain Community contains third-party integrations that implement the base interfaces defined in LangChain Core, making them ready-to-use in any LangChain application.
Expand Down
30 changes: 29 additions & 1 deletion libs/langchain-google-genai/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,41 @@
# @langchain/google-genai

This package contains the LangChainJS integrations for Gemini through their generative-ai SDK.
This package contains the LangChain.js integrations for Gemini through their generative-ai SDK.

## Installation

```bash npm2yarn
npm install @langchain/google-genai
```

This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).
If you are using this package with other LangChain packages, you should make sure that all of the packages depend on the same instance of @langchain/core.
You can do so by adding appropriate field to your project's `package.json` like this:

```json
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/google-genai": "^0.0.0",
"langchain": "0.0.207"
},
"resolutions": {
"@langchain/core": "0.1.1"
},
"overrides": {
"@langchain/core": "0.1.1"
},
"pnpm": {
"overrides": {
"@langchain/core": "0.1.1"
}
}
}
```

The field you need depends on the package manager you're using, but we recommend adding a field for the common `yarn`, `npm`, and `pnpm` to maximize compatibility.

## Chat Models

This package contains the `ChatGoogleGenerativeAI` class, which is the recommended way to interface with the Google Gemini series of models.
Expand Down
30 changes: 29 additions & 1 deletion libs/langchain-mistralai/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,41 @@
# @langchain/mistralai

This package contains the LangChainJS integrations for Mistral through their SDK.
This package contains the LangChain.js integrations for Mistral through their SDK.

## Installation

```bash npm2yarn
npm install @langchain/mistralai
```

This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).
If you are using this package with other LangChain packages, you should make sure that all of the packages depend on the same instance of @langchain/core.
You can do so by adding appropriate field to your project's `package.json` like this:

```json
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/mistralai": "^0.0.0",
"langchain": "0.0.207"
},
"resolutions": {
"@langchain/core": "0.1.1"
},
"overrides": {
"@langchain/core": "0.1.1"
},
"pnpm": {
"overrides": {
"@langchain/core": "0.1.1"
}
}
}
```

The field you need depends on the package manager you're using, but we recommend adding a field for the common `yarn`, `npm`, and `pnpm` to maximize compatibility.

## Chat Models

This package contains the `ChatMistralAI` class, which is the recommended way to interface with the Mistral series of models.
Expand Down
30 changes: 29 additions & 1 deletion libs/langchain-openai/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,41 @@
# @langchain/openai

This package contains the LangChainJS integrations for OpenAI through their SDK.
This package contains the LangChain.js integrations for OpenAI through their SDK.

## Installation

```bash npm2yarn
npm install @langchain/openai
```

This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).
If you are using this package with other LangChain packages, you should make sure that all of the packages depend on the same instance of @langchain/core.
You can do so by adding appropriate fields to your project's `package.json` like this:

```json
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/openai": "^0.0.0",
"langchain": "0.0.207"
},
"resolutions": {
"@langchain/core": "0.1.1"
},
"overrides": {
"@langchain/core": "0.1.1"
},
"pnpm": {
"overrides": {
"@langchain/core": "0.1.1"
}
}
}
```

The field you need depends on the package manager you're using, but we recommend adding a field for the common `yarn`, `npm`, and `pnpm` to maximize compatibility.

## Chat Models

This package contains the `ChatOpenAI` class, which is the recommended way to interface with the OpenAI series of models.
Expand Down