Citation • Rust AI Agent SDK
Citation: A citation referencing a source document.
Citation
Defined in the RAG module.
Rust AI Agent SDK
A citation referencing a source document.
Fields
| Name | Type | Description |
|---|---|---|
id | String | Citation ID (e.g., “[1]”) |
source | String | Source document or URL |
text | String | Relevant text snippet |
page | Option<u32> | Page number if applicable |
score | Option<f32> | Relevance score (0.0 to 1.0) |
metadata | HashMap<String | Additional metadata |
Methods
new
fn new(id: impl Into<String>, source: impl Into<String>, text: impl Into<String>) -> SelfCreate a new citation
Parameters:
| Name | Type |
|---|---|
id | impl Into<String> |
source | impl Into<String> |
text | impl Into<String> |
page
fn page(mut self, page: u32) -> SelfSet the page number
Parameters:
| Name | Type |
|---|---|
page | u32 |
score
fn score(mut self, score: f32) -> SelfSet the relevance score
Parameters:
| Name | Type |
|---|---|
score | f32 |
metadata
fn metadata(mut self, key: impl Into<String>, value: impl Into<String>) -> SelfAdd metadata
Parameters:
| Name | Type |
|---|---|
key | impl Into<String> |
value | impl Into<String> |
Source
View on GitHubpraisonai/src/rag/mod.rs at line 42