Struct ResponseFormat 

pub struct ResponseFormat { /* private fields */ }

A transcript response format.

Implementations

impl ResponseFormat

pub fn json_schema(schema: GenerationSchema) -> Self

Create a response format from a generation schema.

pub fn generating<T>() -> Result<Self, FMError>

where T: Generable,

Create a response format from a Generable Rust type.

Errors

Returns an FMError if the type cannot produce a generation schema.

pub fn with_name(self, name: impl Into<String>) -> Self

Attach an explicit display name.

pub fn name(&self) -> String

Display name FoundationModels associates with this response format.

pub const fn schema(&self) -> &GenerationSchema

The underlying schema.

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 PartialEq for ResponseFormat

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ResponseFormat

impl StructuralPartialEq for ResponseFormat