Struct PromptResponse 

#[non_exhaustive]
pub struct PromptResponse {
    pub stop_reason: StopReason,
    pub usage: Option<Usage>,
    pub meta: Option<Map<String, Value>>,
}

Response from processing a user prompt.

See protocol docs: Check for Completion

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.

stop_reason: StopReason

Indicates why the agent stopped processing the turn.

usage: Option<Usage>

Available on crate feature unstable_end_turn_token_usage only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Token usage for this turn (optional).

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl PromptResponse

pub fn new(stop_reason: StopReason) -> PromptResponse

pub fn usage(self, usage: impl IntoOption<Usage>) -> PromptResponse

Available on crate feature unstable_end_turn_token_usage only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Token usage for this turn.

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> PromptResponse

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for PromptResponse

fn clone(&self) -> PromptResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PromptResponse

impl IntoV2 for PromptResponse

type Output = PromptResponse

The corresponding v2 draft type.

fn into_v2( self, ) -> Result<<PromptResponse as IntoV2>::Output, ProtocolConversionError>

Converts this value into the corresponding v2 draft type.

impl JsonRpcResponse for PromptResponse

fn into_json(self, _method: &str) -> Result<Value, Error>

Convert this message into a JSON value.

fn from_value(_method: &str, value: Value) -> Result<Self, Error>

Parse a JSON value into the response type.

impl JsonSchema for PromptResponse

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 PromptResponse

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

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 PromptResponse