Struct StructuredPart 

pub struct StructuredPart {
    pub value: Value,
    pub schema: Option<Value>,
    pub metadata: MetadataMap,
}

Structured JSON content, optionally paired with a JSON Schema for validation.

Providers that support structured output (e.g. function-calling mode) may return a StructuredPart instead of free-form text.

Fields

value: Value

The structured data as a JSON Value.

schema: Option<Value>

An optional JSON Schema that value conforms to.

metadata: MetadataMap

Arbitrary key-value metadata.

Implementations

impl StructuredPart

pub fn new(value: Value) -> Self

Builds a structured part with empty metadata and no schema.

pub fn with_schema(self, schema: Value) -> Self

Sets the optional schema.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Replaces the structured-part metadata.

Trait Implementations

impl Clone for StructuredPart

fn clone(&self) -> StructuredPart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredPart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredPart

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StructuredPart

fn eq(&self, other: &StructuredPart) -> 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 Serialize for StructuredPart

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StructuredPart