Skip to content

User Guide

Detailed guides for every component and feature of iris-haystack.

  • IRISDocumentStore

    Initialization options, table schema, connection management, and all four protocol methods.

    DocumentStore

  • Embedding Retriever

    Semantic search via IRIS native VECTOR_COSINE. Supports FilterPolicy and runtime filter overrides.

    IRISEmbeddingRetriever

  • BM25 Retriever

    Keyword ranking via Okapi BM25 computed in-memory over the filtered document set.

    IRISBm25Retriever

  • Metadata Filtering

    Legacy dict format, full Haystack operator/conditions format, all Python types and operators.

    Filtering

  • Pipeline Serialization

    Save and restore Haystack pipelines that include an IRISDocumentStore to/from YAML files.

    Serialization

  • Credentials & Secrets

    How to supply IRIS credentials safely using Haystack Secret objects and environment variables.

    Credentials