llmprism 0.4.0

A unified, fluent Rust interface for integrating Large Language Model providers -- a Rust port of the PHP Prism library.
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

use serde::{Deserialize, Serialize};

use super::Schema;

/// A schema for a value that may take any one of several different shapes.
///
/// Use this when a field can legitimately be, say, either a string or a number,
/// and you want the model to pick whichever fits.
///
/// # Example
///
/// ```
/// use llmprism::schema::{AnyOfSchema, NumberSchema, Schema, StringSchema};
///
/// // Accepts either a numeric id or a string slug.
/// let identifier = AnyOfSchema::new(
///     "identifier",
///     [Schema::Number(NumberSchema::new("id")), Schema::String(StringSchema::new("slug"))],
/// );
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AnyOfSchema {
    /// The field/parameter name this schema describes.
    pub name: String,
    /// A plain-language explanation of what this value represents, shown to the
    /// model so it can fill it in correctly.
    pub description: Option<String>,
    /// The set of shapes this value may take -- any one of these is valid.
    pub schemas: Vec<Schema>,
}

impl AnyOfSchema {
    /// Creates a schema for a value named `name` that may match any one of
    /// `schemas`.
    pub fn new(name: impl Into<String>, schemas: impl IntoIterator<Item = Schema>) -> Self {
        Self {
            name: name.into(),
            description: None,
            schemas: schemas.into_iter().collect(),
        }
    }

    /// Attaches a plain-language description, shown to the model.
    pub fn with_description(mut self, description: impl Into<String>) -> Self {
        self.description = Some(description.into());
        self
    }
}