Skip to main content

JsonModeConfig

Struct JsonModeConfig 

Source
pub struct JsonModeConfig {
    pub mode: JsonMode,
    pub schema: Option<Value>,
    pub schema_name: String,
    pub strict: bool,
}
Expand description

Configuration for JSON mode.

Defines how structured output should be formatted and validated.

Fields§

§mode: JsonMode

JSON mode to use

§schema: Option<Value>

JSON schema for validation (only used for JsonSchema mode)

§schema_name: String

Name for the schema (used in OpenAI format)

§strict: bool

Whether to enforce strict schema compliance

Implementations§

Source§

impl JsonModeConfig

Source

pub fn json_object() -> Self

Create a config for simple JSON object mode.

Example:

use ai_lib_rust::structured::JsonModeConfig;

let config = JsonModeConfig::json_object();
let openai_format = config.to_openai_format();
assert_eq!(openai_format["response_format"]["type"], "json_object");
Source

pub fn from_schema(schema: Value, name: impl Into<String>, strict: bool) -> Self

Create a config from a JSON schema.

§Arguments
  • schema - JSON schema dictionary
  • name - Schema name (default: “response”)
  • strict - Whether to enforce strict compliance (default: true)

Example:

use ai_lib_rust::structured::{JsonMode, JsonModeConfig};
use serde_json::json;

let schema = json!({
    "type": "object",
    "properties": {
        "name": {"type": "string"}
    },
    "required": ["name"]
});

let config = JsonModeConfig::from_schema(schema, "test", true);
assert_eq!(config.mode, JsonMode::JsonSchema);
Source

pub fn to_openai_format(&self) -> Value

Convert to OpenAI API format.

Returns a value suitable for the response_format parameter in OpenAI’s Chat Completions API.

Example output for JSON mode:

{
  "response_format": {
    "type": "json_object"
  }
}

Example output for JSON Schema mode:

{
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "response",
      "strict": true,
      "schema": { ... }
    }
  }
}
Source

pub fn to_anthropic_format(&self) -> Value

Convert to Anthropic API format.

Note: Anthropic doesn’t have native JSON mode support. This returns an empty placeholder, and JSON enforcement must be done through system prompt instructions.

Example:

use ai_lib_rust::structured::JsonModeConfig;
use serde_json::json;

let config = JsonModeConfig::json_object();
let anthropic_format = config.to_anthropic_format();
assert_eq!(anthropic_format, json!({}));

Trait Implementations§

Source§

impl Clone for JsonModeConfig

Source§

fn clone(&self) -> JsonModeConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for JsonModeConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for JsonModeConfig

Source§

fn eq(&self, other: &JsonModeConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for JsonModeConfig

Source§

impl StructuralPartialEq for JsonModeConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more