Struct RetrieverResult

pub struct RetrieverResult {
    pub documents: Vec<Document>,
    pub metadata: HashMap<String, Value>,
}

A retriever result containing documents and metadata

Fields

documents: Vec<Document>

The retrieved documents

metadata: HashMap<String, Value>

Additional metadata about the retrieval

Implementations

impl RetrieverResult

pub fn new(documents: Vec<Document>) -> Self

Create a new retriever result

pub fn new_with_metadata( documents: Vec<Document>, metadata: HashMap<String, Value>, ) -> Self

Create a new retriever result with metadata

pub fn add_metadata(&mut self, key: impl Into<String>, value: Value)

Add metadata to the result

pub fn len(&self) -> usize

Get the number of documents

pub fn is_empty(&self) -> bool

Check if the result is empty

Trait Implementations

impl Clone for RetrieverResult

fn clone(&self) -> RetrieverResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetrieverResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RetrieverResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RetrieverResult

fn eq(&self, other: &RetrieverResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R> Runnable<String, RetrieverResult> for RunnableRetriever<R>

where R: BaseRetriever,

fn invoke<'life0, 'async_trait>( &'life0 self, input: String, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<RetrieverResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Invoke the runnable with a single input

fn invoke_simple<'life0, 'async_trait>( &'life0 self, input: Input, ) -> Pin<Box<dyn Future<Output = Result<Output>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Invoke the runnable with a single input (convenience method with default config)

fn batch<'life0, 'async_trait>( &'life0 self, inputs: Vec<Input>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Output>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Batch invoke the runnable with multiple inputs

fn stream<'life0, 'async_trait>( &'life0 self, input: Input, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<Output>> + Send>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stream the output of the runnable

fn input_schema(&self) -> Option<Value>

Get the input schema for this runnable

fn output_schema(&self) -> Option<Value>

Get the output schema for this runnable

fn config_schema(&self) -> Option<Value>

Get the configuration schema for this runnable

impl Serializable for RetrieverResult

fn namespace() -> Vec<String>

Get the namespace for this serializable object

fn is_serializable() -> bool

Check if this object is serializable

fn to_json(&self) -> Result<String>

Serialize this object to JSON

fn to_json_pretty(&self) -> Result<String>

Serialize this object to a pretty-printed JSON string

fn from_json(json: &str) -> Result<Self>

where Self: Sized,

Deserialize this object from JSON

fn to_dict(&self) -> Result<HashMap<String, Value>>

Serialize this object to a dictionary (HashMap)

fn from_dict(dict: &HashMap<String, Value>) -> Result<Self>

where Self: Sized,

Deserialize this object from a dictionary (HashMap)

fn type_name() -> &'static str

Get the type name for this serializable object

impl Serialize for RetrieverResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RetrieverResult