Struct CreateMessageResult 

#[non_exhaustive]
pub struct CreateMessageResult {
    pub model: String,
    pub stop_reason: Option<String>,
    pub message: SamplingMessage,
}

Result of sampling/createMessage (SEP-1577). The result of a sampling/createMessage request containing the generated response.

This structure contains the generated message along with metadata about how the generation was performed and why it stopped.

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.

model: String

The identifier of the model that generated the response

stop_reason: Option<String>

The reason why generation stopped (e.g., “endTurn”, “maxTokens”)

message: SamplingMessage

The generated message with role and content

Implementations

impl CreateMessageResult

pub const STOP_REASON_END_TURN: &str = "endTurn"

pub const STOP_REASON_END_SEQUENCE: &str = "stopSequence"

pub const STOP_REASON_END_MAX_TOKEN: &str = "maxTokens"

pub const STOP_REASON_TOOL_USE: &str = "toolUse"

pub fn new(message: SamplingMessage, model: String) -> Self

Create a new CreateMessageResult with required fields.

pub fn with_stop_reason(self, stop_reason: impl Into<String>) -> Self

Set the stop reason.

pub fn with_model(self, model: impl Into<String>) -> Self

Set the model identifier.

pub fn validate(&self) -> Result<(), String>

Validate the result per SEP-1577: role must be “assistant”.

Trait Implementations

impl Clone for CreateMessageResult

fn clone(&self) -> CreateMessageResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateMessageResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateMessageResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateMessageResult> for ClientResult

fn from(value: CreateMessageResult) -> Self

Converts to this type from the input type.

impl JsonSchema for CreateMessageResult

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 CreateMessageResult

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

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 CreateMessageResult