From 3030b5694b794b039a9c88b7d3d26965ceaf076c Mon Sep 17 00:00:00 2001 From: jacoblee93 Date: Sat, 16 Dec 2023 20:13:56 -0800 Subject: [PATCH] Update READMEs --- .../template/README.md | 30 ++++++++++++++++++- libs/langchain-anthropic/README.md | 30 ++++++++++++++++++- libs/langchain-community/README.md | 28 +++++++++++++++++ libs/langchain-google-genai/README.md | 30 ++++++++++++++++++- libs/langchain-mistralai/README.md | 30 ++++++++++++++++++- libs/langchain-openai/README.md | 30 ++++++++++++++++++- 6 files changed, 173 insertions(+), 5 deletions(-) diff --git a/libs/create-langchain-integration/template/README.md b/libs/create-langchain-integration/template/README.md index f096b788847e..a7704a4885d3 100644 --- a/libs/create-langchain-integration/template/README.md +++ b/libs/create-langchain-integration/template/README.md @@ -1,6 +1,6 @@ # @langchain/ -This package contains the LangChainJS integrations for through their SDK. +This package contains the LangChain.js integrations for through their SDK. ## Installation @@ -8,6 +8,34 @@ This package contains the LangChainJS integrations for through t npm install @langchain/ ``` +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/": "^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 `` class, which is the recommended way to interface with the series of models. diff --git a/libs/langchain-anthropic/README.md b/libs/langchain-anthropic/README.md index cf9b20682ab7..5d00b48a31db 100644 --- a/libs/langchain-anthropic/README.md +++ b/libs/langchain-anthropic/README.md @@ -1,6 +1,6 @@ # @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 @@ -8,6 +8,34 @@ This package contains the LangChainJS integrations for Anthropic through their S 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. diff --git a/libs/langchain-community/README.md b/libs/langchain-community/README.md index 1547d713efca..f87adc245a68 100644 --- a/libs/langchain-community/README.md +++ b/libs/langchain-community/README.md @@ -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/": "^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. diff --git a/libs/langchain-google-genai/README.md b/libs/langchain-google-genai/README.md index b9e372e93cbb..6ba0b9b2214b 100644 --- a/libs/langchain-google-genai/README.md +++ b/libs/langchain-google-genai/README.md @@ -1,6 +1,6 @@ # @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 @@ -8,6 +8,34 @@ This package contains the LangChainJS integrations for Gemini through their gene 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. diff --git a/libs/langchain-mistralai/README.md b/libs/langchain-mistralai/README.md index 30c7f2adffa4..447252e81910 100644 --- a/libs/langchain-mistralai/README.md +++ b/libs/langchain-mistralai/README.md @@ -1,6 +1,6 @@ # @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 @@ -8,6 +8,34 @@ This package contains the LangChainJS integrations for Mistral through their SDK 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. diff --git a/libs/langchain-openai/README.md b/libs/langchain-openai/README.md index f0ae390ab2f4..a98ad4a52f7c 100644 --- a/libs/langchain-openai/README.md +++ b/libs/langchain-openai/README.md @@ -1,6 +1,6 @@ # @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 @@ -8,6 +8,34 @@ This package contains the LangChainJS integrations for OpenAI through their SDK. 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.