prediction-guard 0.7.0

SDK for the Prediction Guard API
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

//! Data types that are used for the factuality endpoints.
use serde::{Deserialize, Serialize};

/// Path to the factuality endpoint.
pub const PATH: &str = "/factuality";

/// Request type for the factuality endpoint.
#[derive(Debug, Deserialize, Serialize)]
pub struct Request {
    pub(crate) reference: String,
    pub(crate) text: String,
}

impl Request {
    /// Creates a new request for factuality detection.
    ///
    /// ## Arguments
    ///
    /// * `reference` - The reference text to be used in the factuality check.
    /// * `text` - The text to check for factuality.
    pub fn new(reference: String, text: String) -> Request {
        Self { reference, text }
    }
}
/// Response type for the factuality endpoint.
#[derive(Debug, Default, Deserialize, Serialize)]
#[serde(default)]
pub struct Response {
    pub id: String,
    pub object: String,
    pub created: i64,
    pub checks: Vec<Check>,
}

/// Represents an individual check in the factuality Response.
#[derive(Debug, Default, Deserialize, Serialize)]
#[serde(default)]
pub struct Check {
    pub score: f64,
    pub index: i64,
    pub status: String,
}