OpenAIEmbeddings
features and configuration options, please refer to the API reference.
Overview
Integration details
Setup
To access OpenAI embedding models you’ll need to create a/an OpenAI account, get an API key, and install thelangchain-openai
integration package.
Credentials
Head to platform.openai.com to sign up to OpenAI and generate an API key. Once you’ve done this set the OPENAI_API_KEY environment variable:Installation
The LangChain OpenAI integration lives in thelangchain-openai
package:
Instantiation
Now we can instantiate our model object and generate chat completions:Indexing and Retrieval
Embedding models are often used in retrieval-augmented generation (RAG) flows, both as part of indexing data as well as later retrieving it. For more detailed instructions, please see our RAG tutorials. Below, see how to index and retrieve data using theembeddings
object we initialized above. In this example, we will index and retrieve a sample document in the InMemoryVectorStore
.
Direct Usage
Under the hood, the vectorstore and retriever implementations are callingembeddings.embed_documents(...)
and embeddings.embed_query(...)
to create embeddings for the text(s) used in from_texts
and retrieval invoke
operations, respectively.
You can directly call these methods to get embeddings for your own use cases.
Embed single texts
You can embed single texts or documents withembed_query
:
Embed multiple texts
You can embed multiple texts withembed_documents
:
API Reference
For detailed documentation onOpenAIEmbeddings
features and configuration options, please refer to the API reference.