!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())

[Skip to main content](#__docusaurus_skipToContent_fallback)

LangChain v0.2 is coming soon! Preview the new docs [here](/v0.2/docs/introduction/).

[

![🦜️🔗 Langchain](/v0.1/img/brand/wordmark.png)![🦜️🔗 Langchain](/v0.1/img/brand/wordmark-dark.png)

](/v0.1/)[Docs](/v0.1/docs/get_started/introduction/)[Use cases](/v0.1/docs/use_cases/)[Integrations](/v0.1/docs/integrations/platforms/)[API Reference](https://api.js.langchain.com)

[More](#)

*   [People](/v0.1/docs/people/)
*   [Community](/v0.1/docs/community/)
*   [Tutorials](/v0.1/docs/additional_resources/tutorials/)
*   [Contributing](/v0.1/docs/contributing/)

[v0.1](#)

*   [v0.2](https://js.langchain.com/v0.2/docs/introduction)
*   [v0.1](/v0.1/docs/get_started/introduction/)

[🦜🔗](#)

*   [LangSmith](https://smith.langchain.com)
*   [LangSmith Docs](https://docs.smith.langchain.com)
*   [LangChain Hub](https://smith.langchain.com/hub)
*   [LangServe](https://github.com/langchain-ai/langserve)
*   [Python Docs](https://python.langchain.com/)

[Chat](https://chatjs.langchain.com)[](https://github.com/langchain-ai/langchainjs)

Search

*   [Providers](/v0.1/docs/integrations/platforms/)
    
    *   [Providers](/v0.1/docs/integrations/platforms/)
    *   [Anthropic](/v0.1/docs/integrations/platforms/anthropic/)
    *   [AWS](/v0.1/docs/integrations/platforms/aws/)
    *   [Google](/v0.1/docs/integrations/platforms/google/)
    *   [Microsoft](/v0.1/docs/integrations/platforms/microsoft/)
    *   [OpenAI](/v0.1/docs/integrations/platforms/openai/)
*   [Components](/v0.1/docs/integrations/components/)
    
    *   [LLMs](/v0.1/docs/integrations/llms/)
        
    *   [Chat models](/v0.1/docs/integrations/chat/)
        
    *   [Document loaders](/v0.1/docs/integrations/document_loaders/)
        
    *   [Document transformers](/v0.1/docs/integrations/document_transformers/)
        
    *   [Document compressors](/v0.1/docs/integrations/document_compressors/)
        
    *   [Text embedding models](/v0.1/docs/integrations/text_embedding/)
        
        *   [Alibaba Tongyi](/v0.1/docs/integrations/text_embedding/alibaba_tongyi/)
        *   [Azure OpenAI](/v0.1/docs/integrations/text_embedding/azure_openai/)
        *   [Baidu Qianfan](/v0.1/docs/integrations/text_embedding/baidu_qianfan/)
        *   [Bedrock](/v0.1/docs/integrations/text_embedding/bedrock/)
        *   [Cloudflare Workers AI](/v0.1/docs/integrations/text_embedding/cloudflare_ai/)
        *   [Cohere](/v0.1/docs/integrations/text_embedding/cohere/)
        *   [Fireworks](/v0.1/docs/integrations/text_embedding/fireworks/)
        *   [Google AI](/v0.1/docs/integrations/text_embedding/google_generativeai/)
        *   [Google PaLM](/v0.1/docs/integrations/text_embedding/google_palm/)
        *   [Google Vertex AI](/v0.1/docs/integrations/text_embedding/google_vertex_ai/)
        *   [Gradient AI](/v0.1/docs/integrations/text_embedding/gradient_ai/)
        *   [HuggingFace Inference](/v0.1/docs/integrations/text_embedding/hugging_face_inference/)
        *   [Llama CPP](/v0.1/docs/integrations/text_embedding/llama_cpp/)
        *   [Minimax](/v0.1/docs/integrations/text_embedding/minimax/)
        *   [Mistral AI](/v0.1/docs/integrations/text_embedding/mistralai/)
        *   [Nomic](/v0.1/docs/integrations/text_embedding/nomic/)
        *   [Ollama](/v0.1/docs/integrations/text_embedding/ollama/)
        *   [OpenAI](/v0.1/docs/integrations/text_embedding/openai/)
        *   [Prem AI](/v0.1/docs/integrations/text_embedding/premai/)
        *   [TensorFlow](/v0.1/docs/integrations/text_embedding/tensorflow/)
        *   [Together AI](/v0.1/docs/integrations/text_embedding/togetherai/)
        *   [HuggingFace Transformers](/v0.1/docs/integrations/text_embedding/transformers/)
        *   [Voyage AI](/v0.1/docs/integrations/text_embedding/voyageai/)
        *   [ZhipuAI](/v0.1/docs/integrations/text_embedding/zhipuai/)
    *   [Vector stores](/v0.1/docs/integrations/vectorstores/)
        
    *   [Retrievers](/v0.1/docs/integrations/retrievers/)
        
    *   [Tools](/v0.1/docs/integrations/tools/)
        
    *   [Agents and toolkits](/v0.1/docs/integrations/toolkits/)
        
    *   [Chat Memory](/v0.1/docs/integrations/chat_memory/)
        
    *   [Stores](/v0.1/docs/integrations/stores/)
        

*   [](/v0.1/)
*   [Components](/v0.1/docs/integrations/components/)
*   [Text embedding models](/v0.1/docs/integrations/text_embedding/)
*   OpenAI

On this page

OpenAI
======

The `OpenAIEmbeddings` class uses the OpenAI API to generate embeddings for a given text. By default it strips new line characters from the text, as recommended by OpenAI, but you can disable this by passing `stripNewLines: false` to the constructor.

tip

See [this section for general instructions on installing integration packages](/v0.1/docs/get_started/installation/#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

    npm install @langchain/openai

    yarn add @langchain/openai

    pnpm add @langchain/openai

    import { OpenAIEmbeddings } from "@langchain/openai";const embeddings = new OpenAIEmbeddings({  apiKey: "YOUR-API-KEY", // In Node.js defaults to process.env.OPENAI_API_KEY  batchSize: 512, // Default value if omitted is 512. Max is 2048  model: "text-embedding-3-large",});

If you're part of an organization, you can set `process.env.OPENAI_ORGANIZATION` to your OpenAI organization id, or pass it in as `organization` when initializing the model.

Specifying dimensions[​](#specifying-dimensions "Direct link to Specifying dimensions")
---------------------------------------------------------------------------------------

With the `text-embedding-3` class of models, you can specify the size of the embeddings you want returned. For example by default `text-embedding-3-large` returns embeddings of dimension 3072:

    const embeddings = new OpenAIEmbeddings({  model: "text-embedding-3-large",});const vectors = await embeddings.embedDocuments(["some text"]);console.log(vectors[0].length);

    3072

But by passing in `dimensions: 1024` we can reduce the size of our embeddings to 1024:

    const embeddings1024 = new OpenAIEmbeddings({  model: "text-embedding-3-large",  dimensions: 1024,});const vectors2 = await embeddings1024.embedDocuments(["some text"]);console.log(vectors2[0].length);

    1024

Custom URLs[​](#custom-urls "Direct link to Custom URLs")
---------------------------------------------------------

You can customize the base URL the SDK sends requests to by passing a `configuration` parameter like this:

    const model = new OpenAIEmbeddings({  configuration: {    baseURL: "https://your_custom_url.com",  },});

You can also pass other `ClientOptions` parameters accepted by the official SDK.

If you are hosting on Azure OpenAI, see the [dedicated page instead](/v0.1/docs/integrations/text_embedding/azure_openai/).

* * *

#### Help us out by providing feedback on this documentation page:

[

Previous

Ollama

](/v0.1/docs/integrations/text_embedding/ollama/)[

Next

Prem AI

](/v0.1/docs/integrations/text_embedding/premai/)

*   [Specifying dimensions](#specifying-dimensions)
*   [Custom URLs](#custom-urls)

Community

*   [Discord](https://discord.gg/cU2adEyC7w)
*   [Twitter](https://twitter.com/LangChainAI)

GitHub

*   [Python](https://github.com/langchain-ai/langchain)
*   [JS/TS](https://github.com/langchain-ai/langchainjs)

More

*   [Homepage](https://langchain.com)
*   [Blog](https://blog.langchain.dev)

Copyright © 2024 LangChain, Inc.