Struct AgentResponse 

pub struct AgentResponse {
    pub answer: String,
    pub questions: Vec<QuestionItem>,
    pub summary: Option<AgentResponseSummary>,
}

Wire-format protocol payload used for schema-driven provider output.

Providers that support output schemas (for example, Codex app-server) are asked to emit this object as the entire assistant response payload.

Fields

answer: String

Markdown answer text emitted for this turn.

questions: Vec<QuestionItem>

Ordered clarification questions emitted for this turn.

The canonical JSON Schema description for this field is produced by [questions_field_description] and injected at schema generation time by inject_dynamic_schema_guidance. The static schemars metadata here only sets the field title; the description is intentionally omitted so the helper is the single source of truth.

summary: Option<AgentResponseSummary>

Structured summary for session-discussion turns, or None for legacy payloads and one-shot prompts.

Implementations

impl AgentResponse

pub fn plain(text: impl Into<String>) -> AgentResponse

Creates a plain response from raw text as one answer string.

pub fn to_display_text(&self) -> String

Returns display text by joining non-empty answer and question text with blank lines.

pub fn to_answer_display_text(&self) -> String

Returns transcript text for session output by joining non-empty answer content with blank lines.

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

Returns the answer as one single-item vector when it is non-empty.

pub fn question_items(&self) -> Vec<QuestionItem>

Returns up to [MAX_QUESTIONS] clarification questions in response order.

Trait Implementations

impl Clone for AgentResponse

fn clone(&self) -> AgentResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentResponse

fn deserialize<__D>( __deserializer: __D, ) -> Result<AgentResponse, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AgentResponse

impl JsonSchema for AgentResponse

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for AgentResponse

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AgentResponse