Struct CreateElicitationRequest 

#[non_exhaustive]
pub struct CreateElicitationRequest {
    pub mode: ElicitationMode,
    pub message: String,
    pub meta: Option<Map<String, Value>>,
}

UNSTABLE

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

Request from the agent to elicit structured user input.

The agent sends this to the client to request information from the user, either via a form or by directing them to a URL. Elicitations are tied to a session (optionally a tool call) or a 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.

mode: ElicitationMode

The elicitation mode and its mode-specific fields.

message: String

A human-readable message describing what input is needed.

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 CreateElicitationRequest

pub fn new( mode: impl Into<ElicitationMode>, message: impl Into<String>, ) -> CreateElicitationRequest

pub fn scope(&self) -> &ElicitationScope

Returns the scope this elicitation is tied to.

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

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 CreateElicitationRequest

fn clone(&self) -> CreateElicitationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateElicitationRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateElicitationRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV2 for CreateElicitationRequest

Available on crate feature unstable_elicitation only.

type Output = CreateElicitationRequest

The corresponding v2 draft type.

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

Converts this value into the corresponding v2 draft type.

impl JsonRpcMessage for CreateElicitationRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &impl Serialize) -> Result<Self, Error>

Parse this type from a method name and parameters.

impl JsonRpcRequest for CreateElicitationRequest

type Response = CreateElicitationResponse

The type of data expected in response.

impl JsonSchema for CreateElicitationRequest

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 CreateElicitationRequest

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

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 CreateElicitationRequest