Getting Started#

This guide serves as a quick introduction to bodhilib, helping you become familiar with its key features.

The primary aim of this guide is not to deep dive into the internal workings of bodhilib , but rather to offer a practical hands-on experience of interacting with various models and components, demonstrating their capabilities in generating results.

This guide has been compiled using a Jupyter Notebook, enabling you to interactively follow along. You can download the corresponding notebook from the BodhiSearch/bodhilib-guide repository.

To execute the code, you will need API keys for OpenAI. Either have it set as an environment variable OPENAI_API_KEY, or you will be prompted to input your keys using the getpass library when necessary.

In this introductory guide, we’ll cover the following topics:

  1. Prompt

  2. LLM

  3. PromptStream

  4. PromptTemplate

  5. PromptSource

  6. DataLoader

  7. Splitter

  8. Embedder

  9. VectorDB

  10. Extractive QnA

  11. RetrievalAugmentedGeneration

  12. BodhiEngine

  13. FastAPIRoutes

  14. BodhiProxy