Struct SystemOneResponse 

#[non_exhaustive]
pub struct SystemOneResponse {
    pub model: String,
    pub answers: IndexMap<String, Answer>,
    pub usage: Usage,
    pub request_id: Option<String>,
}

The response to a System One request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

model: String

The model that answered; may differ from the alias that was requested.

answers: IndexMap<String, Answer>

Answers keyed by question id.

usage: Usage

Token usage for the request.

request_id: Option<String>

The x-typesafe-request-id header, when the response was received over HTTP. Serialized only when present, so stored responses keep it.

Implementations

impl SystemOneResponse

pub fn new(model: impl Into<String>, usage: Usage) -> Self

An empty response from model, for fixtures and tests. Add answers with SystemOneResponse::with_answer.

use typesafe_client::{NoulAnswer, NoulQuestion, Questions, SystemOneResponse, Usage};

let mut questions = Questions::new();
let urgent = questions.add("is_urgent", NoulQuestion::new("Does this convey urgency?"));

let response = SystemOneResponse::new("jev-latest", Usage::new(312, 48))
    .with_answer(&urgent, NoulAnswer::new(0.92));
assert_eq!(response.answer(&urgent)?.noul, 0.92);

pub fn with_answer(self, id: impl AsRef<str>, answer: impl Into<Answer>) -> Self

Adds or replaces the answer for question id (an id string or a QuestionKey).

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Sets the request id, as a transport would from the response headers.

pub fn answer<A: ReadAnswer>( &self, key: &QuestionKey<A>, ) -> Result<A::Output<'_>, AnswerError>

Reads the answer for key with the type its question promises.

Noul answers are copied, Choice and Score answers are borrowed, and typed choices are parsed into their Rust type.

use typesafe_client::{NoulQuestion, Questions, SystemOneResponse};

let mut questions = Questions::new();
let urgent = questions.add("is_urgent", NoulQuestion::new("Does this convey urgency?"));

let response: SystemOneResponse = serde_json::from_str(
    r#"{"model":"jev-latest","answers":{"is_urgent":{"type":"noul","noul":0.92}},
       "usage":{"input_tokens":312,"output_tokens":48}}"#,
)?;
assert_eq!(response.answer(&urgent)?.noul, 0.92);

pub fn verify(&self, questions: &Questions) -> Result<(), AnswerError>

Checks that every question has an answer of its kind, naming only options and levels the question has. Transports run this before returning a response, so reading an answer can then only fail when a key belongs to a different request.

Trait Implementations

impl Clone for SystemOneResponse

fn clone(&self) -> SystemOneResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemOneResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemOneResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SystemOneResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SystemOneResponse

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 SystemOneResponse