Skip to main content
This will help you get started with FireworksEmbeddings embedding models using LangChain. For detailed documentation on FireworksEmbeddings features and configuration options, please refer to the API reference.

Overview

Integration details

Setup

To access Fireworks embedding models you’ll need to create a Fireworks account, get an API key, and install the @langchain/fireworks integration package.

Credentials

Head to fireworks.ai to sign up to Fireworks and generate an API key. Once you’ve done this set the FIREWORKS_API_KEY environment variable:
If you want to get automated tracing of your model calls you can also set your LangSmith API key by uncommenting below:

Installation

The LangChain FireworksEmbeddings integration lives in the @langchain/fireworks package:

Instantiation

Now we can instantiate our model object and embed text:

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 under the Learn tab. Below, see how to index and retrieve data using the embeddings object we initialized above. In this example, we will index and retrieve a sample document using the demo MemoryVectorStore.

Direct usage

Under the hood, the vectorstore and retriever implementations are calling embeddings.embedDocument(...) and embeddings.embedQuery(...) to create embeddings for the text(s) used in fromDocuments and the retriever’s invoke operations, respectively. You can directly call these methods to get embeddings for your own use cases.

Embed single texts

You can embed queries for search with embedQuery. This generates a vector representation specific to the query:

Embed multiple texts

You can embed multiple texts for indexing with embedDocuments. The internals used for this method may (but do not have to) differ from embedding queries:

API reference

For detailed documentation of all FireworksEmbeddings features and configurations head to the API reference.