@langchain/openai 0.0.5 → 0.0.6

package/README.md

@@ -1 +1,128 @@
-# langchain-openai
+# @langchain/openai
+
+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.
+
+To use, install the requirements, and configure your environment.
+
+```bash
+export OPENAI_API_KEY=your-api-key
+```
+
+Then initialize
+
+```typescript
+import { ChatOpenAI } from "@langchain/openai";
+
+const model = new ChatOpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+  modelName: "gpt-4-1106-preview",
+});
+const response = await model.invoke(new HumanMessage("Hello world!"));
+```
+
+### Streaming
+
+```typescript
+import { ChatOpenAI } from "@langchain/openai";
+
+const model = new ChatOpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+  modelName: "gpt-4-1106-preview",
+});
+const response = await model.stream(new HumanMessage("Hello world!"));
+```
+
+## Embeddings
+
+This package also adds support for OpenAI's embeddings model.
+
+```typescript
+import { OpenAIEmbeddings } from "@langchain/openai";
+
+const embeddings = new OpenAIEmbeddings({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+const res = await embeddings.embedQuery("Hello world");
+```
+
+## Development
+
+To develop the OpenAI package, you'll need to follow these instructions:
+
+### Install dependencies
+
+```bash
+yarn install
+```
+
+### Build the package
+
+```bash
+yarn build
+```
+
+Or from the repo root:
+
+```bash
+yarn build --filter=@langchain/openai
+```
+
+### 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`:
+
+```bash
+$ yarn test
+$ yarn test:int
+```
+
+### Lint & Format
+
+Run the linter & formatter to ensure your code is up to standard:
+
+```bash
+yarn lint && yarn 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 `scripts/create-entrypoints.js` and run `yarn build` to generate the new entrypoint.

package/dist/embeddings.cjs

@@ -38,6 +38,7 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             writable: true,
             value: 512
         });
+        // TODO: Update to `false` on next minor release (see: https://github.com/langchain-ai/langchainjs/pull/3612)
         Object.defineProperty(this, "stripNewLines", {
             enumerable: true,
             configurable: true,

package/dist/embeddings.d.ts

@@ -19,7 +19,8 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
     batchSize?: number;
     /**
      * Whether to strip new lines from the input text. This is recommended by
-     * OpenAI, but may not be suitable for all use cases.
+     * OpenAI for older models, but may not be suitable for all use cases.
+     * See: https://github.com/openai/openai-python/issues/418#issuecomment-1525939500
      */
     stripNewLines?: boolean;
 }

package/dist/embeddings.js

@@ -35,6 +35,7 @@ export class OpenAIEmbeddings extends Embeddings {
             writable: true,
             value: 512
         });
+        // TODO: Update to `false` on next minor release (see: https://github.com/langchain-ai/langchainjs/pull/3612)
         Object.defineProperty(this, "stripNewLines", {
             enumerable: true,
             configurable: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -13,7 +13,8 @@
     "url": "git@github.com:langchain-ai/langchainjs.git"
   },
   "scripts": {
-    "build": "yarn clean && yarn build:esm && yarn build:cjs && yarn build:scripts",
+    "build": "yarn run build:deps && yarn clean && yarn build:esm && yarn build:cjs && yarn build:scripts",
+    "build:deps": "yarn run turbo:command build --filter=@langchain/core",
     "build:esm": "NODE_OPTIONS=--max-old-space-size=4096 tsc --outDir dist/",
     "build:cjs": "NODE_OPTIONS=--max-old-space-size=4096 tsc --outDir dist-cjs/ -p tsconfig.cjs.json && node scripts/move-cjs-to-dist.js && rimraf dist-cjs",
     "build:watch": "node scripts/create-entrypoints.js && tsc --outDir dist/ --watch",
@@ -25,16 +26,16 @@
     "clean": "rimraf .turbo/ dist/ && NODE_OPTIONS=--max-old-space-size=4096 node scripts/create-entrypoints.js pre",
     "prepack": "yarn build",
     "release": "release-it --only-version --config .release-it.json",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --testPathIgnorePatterns=\\.int\\.test.ts --testTimeout 30000 --maxWorkers=50%",
-    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch --testPathIgnorePatterns=\\.int\\.test.ts",
-    "test:single": "NODE_OPTIONS=--experimental-vm-modules yarn run jest --config jest.config.cjs --testTimeout 100000",
+    "test": "yarn run build:deps && NODE_OPTIONS=--experimental-vm-modules jest --testPathIgnorePatterns=\\.int\\.test.ts --testTimeout 30000 --maxWorkers=50%",
+    "test:watch": "yarn run build:deps && NODE_OPTIONS=--experimental-vm-modules jest --watch --testPathIgnorePatterns=\\.int\\.test.ts",
+    "test:single": "yarn run build:deps && NODE_OPTIONS=--experimental-vm-modules yarn run jest --config jest.config.cjs --testTimeout 100000",
     "format": "prettier --write \"src\"",
     "format:check": "prettier --check \"src\""
   },
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": "~0.1.0",
+    "@langchain/core": "~0.1.2",
     "js-tiktoken": "^1.0.7",
     "openai": "^4.19.0",
     "zod": "^3.22.3",