genai 0.6.0-beta.16

Multi-AI Providers Library for Rust. (OpenAI, Gemini, Anthropic, xAI, Ollama, Groq, DeepSeek, Grok, GitHub Copilot)
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

use derive_more::From;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use value_ext::JsonValueExt;

/// Preferred response format for `ChatRequest` (structured output).
/// Only applied when the provider supports it.
///
/// > Note: Most providers currently ignore unsupported formats without error; this may change later.
#[derive(Debug, Clone, From, Serialize, Deserialize)]
pub enum ChatResponseFormat {
	/// Request JSON-mode output (primarily for OpenAI).
	/// Note: Include an instruction like "Reply in JSON format." in your system/prompt to improve reliability.
	JsonMode,

	/// Request structured output.
	#[from]
	JsonSpec(JsonSpec),
}

/// JSON specification used to enforce structured output.
#[derive(Debug, Clone, From, Serialize, Deserialize)]
pub struct JsonSpec {
	/// Specification name (primarily used by OpenAI).
	/// IMPORTANT: For OpenAI, only `-` and `_` are allowed; no spaces or other special characters.
	pub name: String,

	/// Human-readable description (used by some adapters in the future).
	/// NOTE: Currently ignored by the OpenAI adapter.
	pub description: Option<String>,

	/// Simplified JSON schema forwarded to the provider.
	pub schema: Value,
}

/// Constructors
impl JsonSpec {
	/// Create a `JsonSpec` with a name and schema.
	pub fn new(name: impl Into<String>, schema: impl Into<Value>) -> Self {
		Self {
			name: name.into(),
			description: None,
			schema: schema.into(),
		}
	}
}

/// Setters
impl JsonSpec {
	/// Set an optional description (builder-style).
	pub fn with_description(mut self, description: impl Into<String>) -> Self {
		self.description = Some(description.into());
		self
	}
}

/// Helpers
impl JsonSpec {
	/// Returns a clone of the schema with `"additionalProperties": false` injected into every
	/// object node. Required by several providers (Anthropic, OpenAI) whose structured-output
	/// APIs reject schemas that omit this constraint.
	pub fn schema_with_additional_properties_false(&self) -> Value {
		let mut schema = self.schema.clone();
		schema.x_walk(|parent_map, name| {
			if name == "type" {
				let typ = parent_map.get("type").and_then(|v| v.as_str()).unwrap_or("");
				if typ == "object" {
					parent_map.insert("additionalProperties".to_string(), false.into());
				}
			}
			true
		});
		schema
	}
}