prediction-guard 0.5.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
43

//! Data types for the PII detection endpoint.
use serde::{Deserialize, Serialize};

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

/// Denotes the different ways to replace any PII information that is found.
#[derive(Debug, Serialize, Deserialize)]
pub enum ReplaceMethod {
    #[serde(rename = "random")]
    Random,
    #[serde(rename = "mask")]
    Mask,
    #[serde(rename = "category")]
    Category,
    #[serde(rename = "fake")]
    Fake,
}

/// Represents individual check from the factuality endpoint.
#[derive(Debug, Deserialize, Serialize)]
pub struct Check {
    pub new_prompt: String,
    pub index: i64,
    pub status: String,
}

/// Request type for the PII detection endpoint.
#[derive(Debug, Deserialize, Serialize)]
pub struct Request {
    pub prompt: String,
    pub replace: bool,
    pub replace_method: ReplaceMethod,
}

/// Response type for the PII detection endpoint.
#[derive(Debug, Deserialize, Serialize)]
pub struct Response {
    pub id: Option<String>,
    pub object: Option<String>,
    pub created: Option<String>,
    pub checks: Option<Vec<Check>>,
}