Enum ResponseFormat 

pub enum ResponseFormat {
    Text,
    JsonObject,
    JsonSchema {
        json_schema: JsonSchema,
    },
}

Response format configuration

Variants

Text

Text response format (default)

JsonObject

JSON object response format

JsonSchema

JSON schema response format (Structured Outputs)

Fields

json_schema: JsonSchema

JSON schema configuration

Implementations

impl ResponseFormat

pub fn json_schema<T>() -> JsonSchema

where T: JsonSchema,

Available on crate feature schema only.

Creates a JSON schema from a type implementing schemars::JsonSchema.

Returns a JsonSchema that can be used directly or customized with builder methods. To use with ResponseFormat, wrap in ResponseFormat::JsonSchema { json_schema: ... }.

Example

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use portkey_sdk::model::ResponseFormat;

#[derive(Serialize, Deserialize, JsonSchema)]
struct MyResponse {
    message: String,
    count: i32,
}

let response_format = ResponseFormat::JsonSchema {
    json_schema: ResponseFormat::json_schema::<MyResponse>()
        .with_description("A custom response structure")
        .with_strict(true),
};

Trait Implementations

impl Clone for ResponseFormat

fn clone(&self) -> ResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseFormat

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.