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

langchain[minor]: Add imports migration script #4103

Merged
merged 19 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from 7 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
46 changes: 46 additions & 0 deletions docs/core_docs/docs/guides/migrating.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Migration Guide

If you're still using the pre `0.1` version of LangChain, but want to upgrade to the latest version, we've created a script that can handle almost every aspect of the migration for you.

At a high level, the changes from `0.0` to `0.1` are new packages and import path updates.
We've done our best to keep all core code functionality the same, so migrating can be as painless as possible.

In simple terms, this script will scan your TypeScript codebase for any imports from `langchain/*`, and if it finds imports which have been moved in `0.1`, it'll automatically update the import paths for you.

The new packages it checks for are:

- `@langchain/core`
- `@langchain/community`
- `@langchain/openai`
- `@langchain/cohere`
- `@langchain/pinecone`

Some of these integration packages (not `core` or `community`) do have breaking changes. If you'd like to opt out of updating to those modules, you may pass in the `skipCheck` arg with a list of modules you'd like to ignore.

For example, `@langchain/cohere` bumps to the new Cohere SDK version. If you do not wish to upgrade, it will instead update your `cohere` imports to the `@langchain/community` package which still contains the previous version of the Cohere SDK.

The example below demonstrates how to run the migration script, checking all new packages.

### Setup

Install the new packages.

import IntegrationInstallTooltip from "@mdx_components/integration_install_tooltip.mdx";
import CodeBlock from "@theme/CodeBlock";
import MigrationExample from "@examples/guides/migrating.ts";

<IntegrationInstallTooltip></IntegrationInstallTooltip>

```bash npm2yarn
npm install @langchain/core @langchain/community @langchain/openai @langchain/cohere @langchain/pinecone
```

Then, install the required peer dependencies:

```bash npm2yarn
npm install ts-morph glob
```

Then, run the migration code as seen below.

<CodeBlock language="typescript">{MigrationExample}</CodeBlock>
2 changes: 2 additions & 0 deletions examples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"chromadb": "^1.5.3",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there! I noticed that the recent change in the package.json file added a new dev dependency "glob". This comment is to flag the change for maintainers to review. Keep up the great work!

"convex": "^1.3.1",
"faiss-node": "^0.5.1",
"glob": "^10.3.10",
"graphql": "^16.6.0",
"ioredis": "^5.3.2",
"js-yaml": "^4.1.0",
Expand All @@ -66,6 +67,7 @@
"prisma": "^4.11.0",
"redis": "^4.6.6",
"sqlite3": "^5.1.4",
"ts-morph": "^21.0.1",
"typeorm": "^0.3.12",
"typesense": "^1.5.3",
"uuid": "^9.0.0",
Expand Down
8 changes: 8 additions & 0 deletions examples/src/guides/migrating.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { updateEntrypointsFrom0_0_xTo0_1_x } from "langchain/util/migrations/0_1";

updateEntrypointsFrom0_0_xTo0_1_x({
localLangChainPath: "../langchain",
codePath: "/Users/my-profile/code/langchain-chatbot",
})
.then(() => console.log("done"))
.catch(console.error);
3 changes: 3 additions & 0 deletions langchain/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -799,6 +799,9 @@ util/math.d.ts
util/time.cjs
util/time.js
util/time.d.ts
util/migrations/0_1.cjs
util/migrations/0_1.js
util/migrations/0_1.d.ts
experimental/autogpt.cjs
experimental/autogpt.js
experimental/autogpt.d.ts
Expand Down
10 changes: 10 additions & 0 deletions langchain/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -811,6 +811,9 @@
"util/time.cjs",
"util/time.js",
"util/time.d.ts",
"util/migrations/0_1.cjs",
"util/migrations/0_1.js",
"util/migrations/0_1.d.ts",
"experimental/autogpt.cjs",
"experimental/autogpt.js",
"experimental/autogpt.d.ts",
Expand Down Expand Up @@ -1014,6 +1017,7 @@
"d3-dsv": "^2.0.0",
"epub2": "^3.0.1",
"fast-xml-parser": "^4.2.7",
"glob": "^10.3.10",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you will need to add these as devDependencies and mark them as optional below

"google-auth-library": "^8.9.0",
"googleapis": "^126.0.1",
"handlebars": "^4.7.8",
Expand All @@ -1034,6 +1038,7 @@
"redis": "^4.6.4",
"sonix-speech-recognition": "^2.1.1",
"srt-parser-2": "^1.2.3",
"ts-morph": "^21.0.1",
"typeorm": "^0.3.12",
"vectordb": "^0.1.4",
"weaviate-ts-client": "^1.4.0",
Expand Down Expand Up @@ -2573,6 +2578,11 @@
"import": "./util/time.js",
"require": "./util/time.cjs"
},
"./util/migrations/0_1": {
"types": "./util/migrations/0_1.d.ts",
"import": "./util/migrations/0_1.js",
"require": "./util/migrations/0_1.cjs"
},
"./experimental/autogpt": {
"types": "./experimental/autogpt.d.ts",
"import": "./experimental/autogpt.js",
Expand Down
2 changes: 2 additions & 0 deletions langchain/scripts/create-entrypoints.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@ const entrypoints = {
"util/document": "util/document",
"util/math": "util/math",
"util/time": "util/time",
"util/migrations/0_1": "util/migrations/0_0-0_1-migrate-imports",
// experimental
"experimental/autogpt": "experimental/autogpt/index",
"experimental/openai_assistant": "experimental/openai_assistant/index",
Expand Down Expand Up @@ -702,6 +703,7 @@ const requiresOptionalDependency = [
"experimental/prompts/handlebars",
"experimental/tools/pyinterpreter",
"util/convex",
"util/migrations/0_1",
];

const extraImportMapEntries = [
Expand Down
1 change: 1 addition & 0 deletions langchain/src/load/import_constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ export const optionalImportEntrypoints = [
"langchain/graphs/neo4j_graph",
"langchain/hub",
"langchain/util/convex",
"langchain/util/migrations/0_1",
"langchain/experimental/multimodal_embeddings/googlevertexai",
"langchain/experimental/chat_models/anthropic_functions",
"langchain/experimental/llms/bittensor",
Expand Down
3 changes: 3 additions & 0 deletions langchain/src/load/import_type.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,9 @@ export interface OptionalImportMap {
"langchain/util/convex"?:
| typeof import("../util/convex.js")
| Promise<typeof import("../util/convex.js")>;
"langchain/util/migrations/0_1"?:
| typeof import("../util/migrations/0_0-0_1-migrate-imports.js")
| Promise<typeof import("../util/migrations/0_0-0_1-migrate-imports.js")>;
"langchain/experimental/multimodal_embeddings/googlevertexai"?:
| typeof import("../experimental/multimodal_embeddings/googlevertexai.js")
| Promise<typeof import("../experimental/multimodal_embeddings/googlevertexai.js")>;
Expand Down
Loading