Skip to content

README.md

Latest commit

 

History

History
39 lines (27 loc) · 1.07 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.07 KB

sift-embed

sift-embed is the canonical runnable embedding reference for consuming sift as a library from another Rust crate.

This example intentionally stays on the stable crate-root surface:

  • It depends on sift through the crate root.
  • It builds a standalone sift-embed executable.
  • It renders SearchResponse locally instead of using sift::internal.
  • It demonstrates the direct search mode only.

For the full library surface, including turn-aware and controller modes, see LIBRARY.md.

Build And Run

From the repository root:

just embed-build
just embed-sift tests/fixtures/rich-docs "architecture decision"

You can also run the example directly through Cargo:

cargo run --manifest-path examples/sift-embed/Cargo.toml -- search "hybrid search"
cargo run --manifest-path examples/sift-embed/Cargo.toml -- search tests/fixtures/rich-docs "architecture decision"

Command Shape

sift-embed search [OPTIONS] [PATH] <QUERY>

If PATH is omitted, sift-embed search "<term>" searches the current directory.