Skip to main content

ResponseFormat

Enum ResponseFormat 

Source
#[non_exhaustive]
pub enum ResponseFormat { Free, JsonObject, JsonSchema { name: String, schema: Value, }, }
Expand description

Constrain the model’s terminal (non-tool-call) reply shape. Default = Free.

Each model adapter translates this to the provider’s native format on the wire:

  • OpenAI / DeepSeek: response_format: {type: "json_object"} for JsonObject; {type: "json_schema", json_schema: {name, schema, strict}} for JsonSchema. Providers that only support json_object (DeepSeek as of Dec 2025) degrade gracefully by injecting the schema into the system prompt instead.
  • Gemini: generationConfig.responseMimeType = "application/json" plus generationConfig.responseSchema = <schema> for JsonSchema.
  • Anthropic: no native field — adapters synthesise a “structured_output” tool with the schema, force tool_choice to it, and surface the tool’s args as the assistant text on response.

JsonSchema.schema is a serde_json::Value so callers can build it however they like — hand-rolled, via schemars::schema_for!(T), or pulled from a harness_loop::AgentLoop::run_typed<T>() derivation.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Free

Free-form text. The framework adds nothing to the request body.

§

JsonObject

“Reply with valid JSON of any shape.” Useful when the caller will run its own validation and doesn’t want to commit to a schema yet.

§

JsonSchema

“Reply with JSON matching this schema.” Adapters may need to sanitise dialect-specific keys before emitting (Gemini rejects $ref, OpenAI strict mode demands additionalProperties: false everywhere, …).

Fields

§name: String

Short identifier — providers that require one (OpenAI) use it as the json_schema.name field.

§schema: Value

JSON Schema, as a serde_json::Value.

Trait Implementations§

Source§

impl Clone for ResponseFormat

Source§

fn clone(&self) -> ResponseFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResponseFormat

Source§

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

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

impl Default for ResponseFormat

Source§

fn default() -> ResponseFormat

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ResponseFormat

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ResponseFormat, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ResponseFormat

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.