Documentation Index
Fetch the complete documentation index at: https://docs.praison.ai/llms.txt
Use this file to discover all available pages before exploring further.
RewriteResult
Defined in the Specialized Agents module.
Rust AI Agent SDK
Result of query rewriting
Fields
| Name | Type | Description |
|---|
original_query | String | Original query |
rewritten_queries | Vec<String> | Rewritten queries |
strategy_used | RewriteStrategy | Strategy used |
hypothetical_document | Option<String> | Hypothetical document (for HyDE strategy) |
step_back_question | Option<String> | Step-back question (for step-back strategy) |
sub_queries | Option<Vec<String>> | Sub-queries (for sub-queries strategy) |
metadata | HashMap<String | Additional metadata |
serde_json | :Value> | Additional metadata |
Methods
new
fn new(
original: impl Into<String>,
rewritten: Vec<String>,
strategy: RewriteStrategy,
) -> Self
Create a new rewrite result
Parameters:
| Name | Type |
|---|
original | impl Into<String> |
rewritten | Vec<String> |
strategy | RewriteStrategy |
with_hypothetical_document
fn with_hypothetical_document(mut self, doc: impl Into<String>) -> Self
Set hypothetical document
Parameters:
| Name | Type |
|---|
doc | impl Into<String> |
with_step_back_question
fn with_step_back_question(mut self, question: impl Into<String>) -> Self
Set step-back question
Parameters:
| Name | Type |
|---|
question | impl Into<String> |
with_sub_queries
fn with_sub_queries(mut self, queries: Vec<String>) -> Self
Set sub-queries
Parameters:
| Name | Type |
|---|
queries | Vec<String> |
fn with_metadata(mut self, key: impl Into<String>, value: impl Into<serde_json::Value>) -> Self
Add metadata
Parameters:
| Name | Type |
|---|
key | impl Into<String> |
value | impl Into<serde_json::Value> |
primary_query
fn primary_query(&self) -> Option<&str>
Get the primary rewritten query
all_queries
fn all_queries(&self) -> Vec<&str>
Get all queries for retrieval
Source
View on GitHub
praisonai/src/specialized_agents.rs at line 457