use-rag 0.0.1

RAG metadata primitives for RustUse AI workflows.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# use-rag

RAG metadata primitives for `RustUse` AI workflows.

## Experimental

`use-rag` is experimental while `use-ai` remains below `0.3.0`.

## Example

```rust
use use_rag::{RagCorpusName, RagRetrieverKind, RagRetrievalMode};

let corpus = RagCorpusName::new("support-docs")?;

assert_eq!(corpus.as_str(), "support-docs");
assert_eq!("file search".parse::<RagRetrieverKind>()?, RagRetrieverKind::FileSearch);
assert_eq!(RagRetrievalMode::TopK.as_str(), "top-k");
# Ok::<(), use_rag::RagError>(())
```

## Scope

- RAG corpus, document, and chunk identifiers plus chunk, retriever, retrieval, ranking, citation, grounding, assembly, and freshness labels.
- Metadata only.

## Non-goals

- Retrieval, embedding computation, vector search, ranking execution, context assembly, crawling, or citation verification.

## License

Licensed under either Apache-2.0 or MIT.