Struct SearchConfig

pub struct SearchConfig {
    pub search_engine: String,
    pub max_search_results: u8,
    pub size_limit_per_result: u16,
    pub endpoint: String,
    pub content_type: ContentType,
    pub output_content_type: ContentType,
    pub method: String,
    pub additional_headers: Option<HashMap<String, String>>,
    pub parser: fn(&Value) -> Result<SearchOutput, Box<dyn Error>>,
    pub summarization_prompts: Option<(String, String)>,
    pub summarize_ctx_size: Option<usize>,
}

Available on crate feature search only.

The base Search Configuration holding all relevant information to access a search api and retrieve results.

Fields

search_engine: String

The search engine we’re currently focusing on. Currently only one supported, to ensure stability.

max_search_results: u8

The total number of results.

size_limit_per_result: u16

The size limit of every search result.

endpoint: String

The endpoint for the search API.

content_type: ContentType

The content type of the input.

output_content_type: ContentType

The (expected) content type of the output.

method: String

Method expected by the api endpoint.

additional_headers: Option<HashMap<String, String>>

Additional headers for any other purpose.

parser: fn(&Value) -> Result<SearchOutput, Box<dyn Error>>

Callback function to parse the output of the api-service. Implementation left to the user.

summarization_prompts: Option<(String, String)>

Prompts for use with summarization functionality. If set to None, use hard-coded prompts.

summarize_ctx_size: Option<usize>

Context size for summary generation. If None, will use the 4 char ~ 1 token metric to generate summary.

Implementations

impl SearchConfig

pub fn parse_into_results( &self, raw_results: &Value, ) -> Result<SearchOutput, Box<dyn Error>>

Wrapper for the parser() function.

pub fn new( search_engine: String, max_search_results: u8, size_limit_per_result: u16, endpoint: String, content_type: ContentType, output_content_type: ContentType, method: String, additional_headers: Option<HashMap<String, String>>, parser: fn(&Value) -> Result<SearchOutput, Box<dyn Error>>, summarization_prompts: Option<(String, String)>, summarize_ctx_size: Option<usize>, ) -> SearchConfig

pub async fn perform_search<T: Serialize>( &self, search_input: &T, ) -> Result<SearchOutput, LlamaCoreError>

Perform a web search with a Serialize-able input. The search_input is used as is to query the search endpoint.

pub async fn summarize_search<T: Serialize>( &self, search_input: &T, ) -> Result<String, LlamaCoreError>

Perform a search and summarize the corresponding search results

Trait Implementations

impl Debug for SearchConfig

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

Formats the value using the given formatter.