Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Add iris to your Cargo.toml:

[dependencies]
iris = "0.1.0"

Feature Flags

Iris provides several feature flags to enable optional functionalities, particularly for embedding generation:

  • embeddings-candle: Enables Hugging Face Candle integration for running models locally.
  • embeddings-openai: Enables OpenAI API integration.
  • embeddings-multimodal: Enables multimodal embedding support (image + text) via Candle.
  • embeddings-all: Enables all embedding features.
# Example: interacting with OpenAI
iris = { version = "0.1.0", features = ["embeddings-openai"] }