Skip to main content

​
RewriteResult

Defined in the Specialized Agents module.
Rust AI Agent SDK Result of query rewriting

​
Fields

NameTypeDescription
original_queryStringOriginal query
rewritten_queriesVec<String>Rewritten queries
strategy_usedRewriteStrategyStrategy used
hypothetical_documentOption<String>Hypothetical document (for HyDE strategy)
step_back_questionOption<String>Step-back question (for step-back strategy)
sub_queriesOption<Vec<String>>Sub-queries (for sub-queries strategy)
metadataHashMap<StringAdditional 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:
NameType
originalimpl Into&lt;String&gt;
rewrittenVec&lt;String&gt;
strategyRewriteStrategy

​
with_hypothetical_document

fn with_hypothetical_document(mut self, doc: impl Into<String>) -> Self
Set hypothetical document Parameters:
NameType
docimpl Into&lt;String&gt;

​
with_step_back_question

fn with_step_back_question(mut self, question: impl Into<String>) -> Self
Set step-back question Parameters:
NameType
questionimpl Into&lt;String&gt;

​
with_sub_queries

fn with_sub_queries(mut self, queries: Vec<String>) -> Self
Set sub-queries Parameters:
NameType
queriesVec&lt;String&gt;

​
with_metadata

fn with_metadata(mut self, key: impl Into<String>, value: impl Into<serde_json::Value>) -> Self
Add metadata Parameters:
NameType
keyimpl Into&lt;String&gt;
valueimpl Into&lt;serde_json::Value&gt;

​
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