Skip to main content

Format

Enum Format 

Source
pub enum Format {
    Numerical(NumericalFormat),
    Vector(VectorFormat),
    Categorical(CategoricalFormat),
    Selection(SelectionFormat),
    Utterance(UtteranceFormat),
}
Expand description

A question’s answer shape. from_json returns whichever kind the JSON names.

Variants§

Implementations§

Source§

impl Format

Source

pub fn instruction(&self) -> &str

Source

pub fn usage(&self) -> &str

How to answer with the format’s tool, read after the instruction.

Source

pub fn tool(&self) -> &Tool

Source

pub fn clone(&self) -> Format

A fresh format with the same question and no answer.

Source

pub fn answer(&mut self, response: Value)

Sets the answer from its JSON; a value of the wrong shape clears it.

Source

pub fn to_json(&self) -> Value

Source

pub fn to_vector(&self) -> Vec<f64>

Returns a unit-length numerical representation of the format’s current response. Used by the research agent’s per-scope rank-dedup matrix to detect linearly-dependent rows (duplicates). Concatenated across an entity’s atomic fields, the resulting vector is the row’s identifier.

Contract: all implementations return a vector with L2 norm == 1 when a response is present. If the response is missing or empty, an implementation may return a zero-length array; callers MUST skip such fields when concatenating (they correspond to optional / unfilled fields and are excluded from the rank check).

Source

pub async fn llm( &mut self, authorization: &CredentialsOrApiKey, model: Text, options: LlmOptions, ) -> Result<TextResponse>

Source

pub fn get_response(&self) -> Option<Value>

Source

pub fn optional(format: &Format) -> Format

Source

pub fn calculate_distance(a: &Format, b: &Format) -> Result<f64>

Source

pub fn from_json(json: &Value) -> Result<Format>

Auto Trait Implementations§

§

impl !RefUnwindSafe for Format

§

impl !UnwindSafe for Format

§

impl Forget for Format

§

impl Freeze for Format

§

impl Move for Format

§

impl Send for Format

§

impl Sync for Format

§

impl Unpin for Format

§

impl UnsafeUnpin for Format

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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