Struct TurnInput 

pub struct TurnInput {
    pub turn_id: TurnId,
    pub conversation_id: ConversationId,
    pub actor: ActorContext,
    pub text: Option<String>,
    pub interaction_response: Option<InteractionResponse>,
    pub attachments: Vec<AttachmentRef>,
    pub origin: Option<OriginRef>,
    pub locale: Locale,
    pub effort: Option<Effort>,
}

One user turn as accepted by the runtime (spec §9).

Fields

turn_id: TurnId

Identifier of this turn.

conversation_id: ConversationId

Conversation the turn belongs to.

actor: ActorContext

Authenticated actor.

text: Option<String>

Free text, if any.

interaction_response: Option<InteractionResponse>

Structured card reply, if any. May coexist with text.

attachments: Vec<AttachmentRef>

Attachments supplied with the turn.

origin: Option<OriginRef>

Server-validated origin, if the UI supplied one.

locale: Locale

Locale of the user.

effort: Option<Effort>

The effort this turn runs at, forced by the application; None takes the configured default.

Implementations

impl TurnInput

pub fn validate_shape(&self) -> Result<(), InvalidInputError>

Checks the structural rules of a turn against TurnLimits::conservative.

See Self::validate_shape_within.

pub fn validate_shape_within( &self, limits: &TurnLimits, ) -> Result<(), InvalidInputError>

Checks the structural rules of a turn: at least one of text, interaction response or attachment must be present, the locale and the account must be non-empty, and the text and attachments must fit limits.

Text and interaction response may coexist; this never rejects that.

pub fn has_text(&self) -> bool

Returns true when the turn carries non-blank text.

pub fn is_button_only(&self) -> bool

Returns true when the turn is a pure card click: an interaction response with no text and no attachments. Such turns need no model call (spec §9).

pub fn account_id(&self) -> &AccountId

Convenience accessor for the account.

Trait Implementations

impl Clone for TurnInput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurnInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TurnInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TurnInput

impl PartialEq for TurnInput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TurnInput

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 TurnInput