rstructor 0.2.10

Rust equivalent of Python's Instructor + Pydantic: Extract structured, validated data from LLMs (OpenAI, Anthropic, Grok, Gemini) using type-safe Rust structs and enums
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

#[cfg(test)]
mod container_description_tests {
    use rstructor::{Instructor, SchemaType};
    use serde::{Deserialize, Serialize};

    /// A test struct with a container-level description
    #[derive(Instructor, Serialize, Deserialize, Debug)]
    #[llm(description = "This is a struct description")]
    struct StructWithDescription {
        #[llm(description = "Field description")]
        field1: String,

        #[llm(description = "Another field description")]
        field2: i32,
    }

    /// A test enum with a container-level description
    #[derive(Instructor, Serialize, Deserialize, Debug)]
    #[llm(description = "This is an enum description")]
    enum EnumWithDescription {
        Option1,
        Option2,
        Option3,
    }

    // Struct without a description
    #[derive(Instructor, Serialize, Deserialize, Debug)]
    struct StructWithoutDescription {
        #[llm(description = "Field description")]
        field: String,
    }

    // Enum without a description
    #[derive(Instructor, Serialize, Deserialize, Debug)]
    enum EnumWithoutDescription {
        Value1,
        Value2,
    }

    #[test]
    fn test_struct_with_description() {
        let schema = StructWithDescription::schema();
        let schema_json = schema.to_json();

        // Check that description was added to the schema
        assert_eq!(schema_json["description"], "This is a struct description");

        // Check that the field descriptions are still there
        assert_eq!(
            schema_json["properties"]["field1"]["description"],
            "Field description"
        );
        assert_eq!(
            schema_json["properties"]["field2"]["description"],
            "Another field description"
        );
    }

    #[test]
    fn test_enum_with_description() {
        let schema = EnumWithDescription::schema();
        let schema_json = schema.to_json();

        // Check that description was added to the schema
        assert_eq!(schema_json["description"], "This is an enum description");

        // Check that the enum values are still there
        let enum_values = schema_json["enum"].as_array().unwrap();
        assert_eq!(enum_values.len(), 3);
        assert!(enum_values.iter().any(|v| v == "Option1"));
        assert!(enum_values.iter().any(|v| v == "Option2"));
        assert!(enum_values.iter().any(|v| v == "Option3"));
    }

    #[test]
    fn test_struct_without_description() {
        let schema = StructWithoutDescription::schema();
        let schema_json = schema.to_json();

        // Check that there's no description in the schema
        assert!(!schema_json.as_object().unwrap().contains_key("description"));
    }

    #[test]
    fn test_enum_without_description() {
        let schema = EnumWithoutDescription::schema();
        let schema_json = schema.to_json();

        // Check that there's no description in the schema
        assert!(!schema_json.as_object().unwrap().contains_key("description"));
    }
}