Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
@langchain/openai
Advanced tools
@langchain/openai is an npm package that provides tools and utilities for integrating OpenAI's language models into your applications. It allows you to easily interact with OpenAI's API, enabling functionalities such as text generation, conversation handling, and more.
Text Generation
This feature allows you to generate text based on a given prompt using OpenAI's language models. The code sample demonstrates how to use the `generate` method to create text.
const { OpenAI } = require('@langchain/openai');
const openai = new OpenAI('your-api-key');
async function generateText(prompt) {
const response = await openai.generate({
model: 'text-davinci-003',
prompt: prompt,
max_tokens: 100
});
console.log(response.data.choices[0].text);
}
generateText('Once upon a time');
Conversation Handling
This feature allows you to handle conversations by sending a series of messages to OpenAI's conversational models. The code sample demonstrates how to use the `converse` method to manage a conversation.
const { OpenAI } = require('@langchain/openai');
const openai = new OpenAI('your-api-key');
async function handleConversation(messages) {
const response = await openai.converse({
model: 'gpt-3.5-turbo',
messages: messages
});
console.log(response.data.choices[0].message.content);
}
const messages = [
{ role: 'system', content: 'You are a helpful assistant.' },
{ role: 'user', content: 'What is the weather like today?' }
];
handleConversation(messages);
Custom Fine-Tuning
This feature allows you to fine-tune OpenAI's models with custom training data. The code sample demonstrates how to use the `fineTune` method to train a model with specific data.
const { OpenAI } = require('@langchain/openai');
const openai = new OpenAI('your-api-key');
async function fineTuneModel(trainingData) {
const response = await openai.fineTune({
model: 'text-davinci-003',
training_data: trainingData
});
console.log(response.data);
}
const trainingData = [
{ prompt: 'Translate the following English text to French: "Hello, world!"', completion: 'Bonjour, le monde!' }
];
fineTuneModel(trainingData);
The `openai` npm package is the official OpenAI API client for Node.js. It provides similar functionalities for interacting with OpenAI's models, including text generation, conversation handling, and more. Compared to @langchain/openai, it is the direct client provided by OpenAI and may have more up-to-date features and support.
The `node-openai` package is a community-maintained client for OpenAI's API. It provides basic functionalities for text generation and other interactions with OpenAI's models. It may lack some of the advanced features and optimizations found in @langchain/openai.
This package contains the LangChain.js integrations for OpenAI through their SDK.
npm install @langchain/openai @langchain/core
This package, along with the main LangChain package, depends on @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:
{
"name": "your-project",
"version": "0.0.0",
"dependencies": {
"@langchain/core": "^0.3.0",
"@langchain/openai": "^0.0.0"
},
"resolutions": {
"@langchain/core": "^0.3.0"
},
"overrides": {
"@langchain/core": "^0.3.0"
},
"pnpm": {
"overrides": {
"@langchain/core": "^0.3.0"
}
}
}
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.
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.
export OPENAI_API_KEY=your-api-key
Then initialize
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!"));
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!"));
This package also adds support for OpenAI's embeddings model.
import { OpenAIEmbeddings } from "@langchain/openai";
const embeddings = new OpenAIEmbeddings({
apiKey: process.env.OPENAI_API_KEY,
});
const res = await embeddings.embedQuery("Hello world");
To develop the OpenAI package, you'll need to follow these instructions:
yarn install
yarn build
Or from the repo root:
yarn build --filter=@langchain/openai
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
:
$ yarn test
$ yarn test:int
Run the linter & formatter to ensure your code is up to standard:
yarn lint && yarn format
If you add a new file to be exported, either import & re-export from src/index.ts
, or add it to the entrypoints
field in the config
variable located inside langchain.config.js
and run yarn build
to generate the new entrypoint.
FAQs
OpenAI integrations for LangChain.js
The npm package @langchain/openai receives a total of 431,990 weekly downloads. As such, @langchain/openai popularity was classified as popular.
We found that @langchain/openai demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.