Struct KagiClient

pub struct KagiClient {
    pub config: KagiConfig,
    pub inner_client: ClientWithMiddleware,
}

Fields

config: KagiConfig

inner_client: ClientWithMiddleware

Implementations

impl KagiClient

pub fn new(config: KagiConfig) -> Self

Create a KagiClient for a given KagiConfig and reqwest::Client.

Examples found in repository

examples/simple-fastgpt.rs (line 6)

async fn main() {
    let config = kagi_api::KagiConfig::with_api_key("api key goes here");
    let client = kagi_api::KagiClient::new(config);

    let use_cache = true;
    let answer = client
        .fastgpt("How do I entertain my cat?", use_cache)
        .await
        .expect("A valid FastGPT search result");

    // FIXME: Cannot `.render()` without kagi-cli: Remove `Render` trait's coupling from `Args`.
    serde_json::to_writer_pretty(std::io::stdout(), &answer).unwrap();
}

examples/simple-summary.rs (line 6)

async fn main() {
    let config = kagi_api::KagiConfig::with_api_key("api key goes here");
    let client = kagi_api::KagiClient::new(config);
    let options = SummaryOptions::default();

    let some_url = url::Url::parse("https://en.wikipedia.org/wiki/A_Cyborg_Manifesto").unwrap();
    let summary = client
        .summarize_url(some_url, options)
        .await
        .expect("A valid Universal Summarizer result");

    // FIXME: Cannot `.render()` without kagi-cli: Remove `Render` trait's coupling from `Args`.
    serde_json::to_writer_pretty(std::io::stdout(), &summary).unwrap();
}

pub fn with_replay( config: KagiConfig, reqwest_client: Client, record_replay_mode: RecordReplayMode, ) -> KagiResult<Self>

Create a KagiClient for a given KagiConfig and reqwest::Client.

Use rvcr::VCRMiddleware to log request/response to disk.

FIXME: Mention KAGI_API_LOGDIR.

FIXME: Avoid panics from rvcr by fixing them upstream.

pub async fn query<Q>( &self, endpoint: &str, request_body: Q, ) -> KagiResult<Response>

where Q: Serialize,

Trait Implementations

impl FastGPT for KagiClient

fn fastgpt<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, cache: bool, ) -> Pin<Box<dyn Future<Output = KagiResult<Answer>> + Send + 'async_trait>>

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

impl UniversalSummarizer for KagiClient

fn summarize<'life0, 'async_trait>( &'life0 self, subject: Subject, options: SummaryOptions, ) -> Pin<Box<dyn Future<Output = KagiResult<Summary>> + Send + 'async_trait>>

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

fn summarize_url<'life0, 'async_trait>( &'life0 self, url: Url, options: SummaryOptions, ) -> Pin<Box<dyn Future<Output = KagiResult<Summary>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

fn summarize_text<'life0, 'async_trait>( &'life0 self, text: String, options: SummaryOptions, ) -> Pin<Box<dyn Future<Output = KagiResult<Summary>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,