Integration Guides

What's inside

• Integration Overviews: Get a high-level understanding of how the mixedbread API integrates with various frameworks and services.
• Step-by-Step Guides: Follow along with detailed instructions for each integration process, ensuring a smooth implementation.
• Code Examples: Jump right in with practical code snippets in multiple programming languages. 💻

Haystack Integration

Haystack is the open-source Python framework by deepset for building custom apps with large language models (LLMs). It enables quick experimentation with the latest NLP models while providing flexibility and ease of use. Our inspiring community of users and builders has shaped Haystack into a complete framework for building production-ready NLP apps.

Integrating mixedbread with Haystack is a piece of cake! 🍰 Here's how to get started:

Getting Started

1. Haystack Setup: Ensure you have Haystack installed and configured. Refer to Haystack's quickstart guide for setup instructions.
2. Install the mixedbread Extension: Run pip install mixedbread-ai-haystack to install our Haystack extension.
3. Set Up Your mixedbread API Key: If you haven't already, sign up to obtain your mixedbread API key and store it securely.
4. Configure Environment Variables: Set your MIXEDBREAD_API_KEY environment variable to your API key, or pass it directly to the constructor of the class you're using.

Code Examples 💻

Indexing Pipeline

Query Pipeline

Documentation 📚

• Haystack Documentation
• PyPI Package
• Haystack mixedbread Integration Docs

LangChain Integration

LangChain is a powerful framework for building applications with language models.

Steps for Integration 🛠️

1. LangChain Setup: Ensure you have LangChain installed and configured. Refer to LangChain's Quickstart Guide for setup instructions.
2. Set Up Your mixedbread API Key: If you haven't already, sign up for your mixedbread API key and store it securely.
3. Configure Environment Variables: For now, set your EMBAAS_API_KEY environment variable to your API key or pass it directly to the constructor. Stay tuned for the upcoming change to MIXEDBREADAI_API_KEY.

Code Examples 💻

Text Embedding

Documentation 📚

• LangChain Docs
• LangChain mixedbread Integration Docs

Need a Hand? 🙋

If you encounter any issues or have questions about integrating the mixedbread API with these platforms, contact us or join our Discord community. We're here to help!