llmprism 0.1.1

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

use serde::{Deserialize, Serialize};

use super::Schema;

/// A schema for a list of values, all sharing the same shape.
///
/// # Example
///
/// ```
/// use llmprism::schema::{ArraySchema, Schema, StringSchema};
///
/// // A list of ingredient names.
/// let ingredients = ArraySchema::new("ingredients", Schema::String(StringSchema::new("ingredient")));
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ArraySchema {
    /// The field/parameter name this schema describes.
    pub name: String,
    /// A plain-language explanation of what this list represents, shown to the
    /// model so it can fill it in correctly.
    pub description: Option<String>,
    /// The schema every element of the list must match.
    pub items: Box<Schema>,
}

impl ArraySchema {
    /// Creates a schema for a list named `name`, where every element matches
    /// `items`.
    pub fn new(name: impl Into<String>, items: Schema) -> Self {
        Self {
            name: name.into(),
            description: None,
            items: Box::new(items),
        }
    }

    /// 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
    }
}