rig-core 0.44.0

An opinionated library for building LLM powered applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Perplexity's typed reply extras. Perplexity has no typed request
//! option: its Sonar Chat API was retired on 2026-09-27, so its request
//! fields are left to `additional_params` and its replies are read from
//! recordings.
//!
//! ```
//! use rig_core::completion::CompletionResponse;
//! use rig_core::providers::perplexity::extension::PerplexityExt;
//!
//! fn sources(reply: &CompletionResponse) -> Vec<String> {
//!     reply
//!         .extras_lossy::<PerplexityExt>()
//!         .citations
//!         .unwrap_or_default()
//! }
//! # let _ = sources;
//! ```

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::completion::provider_options::reply_field;
use crate::completion::{ExtensionOptions, ProviderExtension, ReplyExtras};
use crate::message::Api;

/// Perplexity's extension marker.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct PerplexityExt;

impl ProviderExtension for PerplexityExt {
    const PROVIDER: &'static str = super::PROVIDER_NAME;
    type Options = PerplexityOptions;
    type Extras = PerplexityExtras;
}

/// Perplexity's request options: none.
#[non_exhaustive]
#[derive(Clone, Debug, Default, PartialEq, Serialize)]
pub struct PerplexityOptions {}

impl PerplexityOptions {
    /// No option set.
    pub fn new() -> Self {
        Self::default()
    }
}

impl ExtensionOptions for PerplexityOptions {
    type Ext = PerplexityExt;
}

/// Perplexity's reply fields. Each is `None` when the reply lacks it.
#[non_exhaustive]
#[derive(Clone, Debug, Default, PartialEq)]
pub struct PerplexityExtras {
    /// The URLs the answer cites, in citation order.
    pub citations: Option<Vec<String>>,
    /// The search results the answer drew on.
    pub search_results: Option<Vec<SearchResult>>,
    /// The images the search returned.
    pub images: Option<Vec<Value>>,
    /// Follow-up questions Perplexity suggests.
    pub related_questions: Option<Vec<String>>,
    /// What the request cost.
    pub cost: Option<PerplexityCost>,
    /// How much search context went into the prompt.
    pub search_context_size: Option<String>,
}

/// One search result.
#[non_exhaustive]
#[derive(Clone, Debug, Default, PartialEq, Eq, Deserialize)]
pub struct SearchResult {
    /// The page title.
    #[serde(default)]
    pub title: Option<String>,
    /// The page URL.
    #[serde(default)]
    pub url: Option<String>,
    /// The publication date.
    #[serde(default)]
    pub date: Option<String>,
    /// When the page last changed.
    #[serde(default)]
    pub last_updated: Option<String>,
    /// The excerpt the answer drew on.
    #[serde(default)]
    pub snippet: Option<String>,
    /// Where the result came from, such as `web`.
    #[serde(default)]
    pub source: Option<String>,
}

/// What a Perplexity request cost, in USD.
#[non_exhaustive]
#[derive(Clone, Copy, Debug, Default, PartialEq, Deserialize)]
pub struct PerplexityCost {
    /// For the prompt tokens.
    #[serde(default)]
    pub input_tokens_cost: Option<f64>,
    /// For the completion tokens.
    #[serde(default)]
    pub output_tokens_cost: Option<f64>,
    /// Per request.
    #[serde(default)]
    pub request_cost: Option<f64>,
    /// In all.
    #[serde(default)]
    pub total_cost: Option<f64>,
}

impl ReplyExtras for PerplexityExtras {
    fn from_reply(_api: &Api, raw: &Value) -> Result<Self, serde_json::Error> {
        Ok(Self {
            citations: reply_field(raw, "/citations")?,
            search_results: reply_field(raw, "/search_results")?,
            images: reply_field(raw, "/images")?,
            related_questions: reply_field(raw, "/related_questions")?,
            cost: reply_field(raw, "/usage/cost")?,
            search_context_size: reply_field(raw, "/usage/search_context_size")?,
        })
    }
}

#[cfg(test)]
mod tests;