Struct CreateResponse 

pub struct CreateResponse {
    pub input: Value,
    pub model: Option<String>,
    pub metadata: Option<Map<String, Value>>,
    pub stream: bool,
    pub background: bool,
    pub previous_response_id: Option<String>,
    pub instructions: Option<String>,
    pub rest: Map<String, Value>,
}

What a client sends to run a task.

Fields

input: Value

A bare string is shorthand for one user message.

model: Option<String>

Canonical model id; absent means the harness default.

metadata: Option<Map<String, Value>>

Client metadata. harness_id selects the harness.

stream: bool

Whether to stream the result as server-sent events.

background: bool

Return immediately with an in_progress task and keep running it.

previous_response_id: Option<String>

Continue the session this response belongs to.

instructions: Option<String>

System instructions for the turn.

rest: Map<String, Value>

Everything the client sent that this struct does not name, kept so reserved fields can be reported rather than silently dropped.

Implementations

impl CreateResponse

pub fn prompt(&self) -> String

The prompt text, whether the client sent a string or an item array.

pub fn ignored_fields(&self) -> Vec<String>

Which reserved fields this request actually carried, in spec order.

Reports what was sent and dropped — not what the server would drop, and not what it happens to know about. A hardcoded list tells a client its request was altered when it was not.

pub fn harness_id(&self) -> Option<&str>

The harness the client asked for, if any.

Trait Implementations

impl Clone for CreateResponse

fn clone(&self) -> CreateResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.