Struct CreateMessageResult 

pub struct CreateMessageResult {
    pub content: CreateMessageContent,
    pub meta: Option<MetaObject>,
    pub model: String,
    pub role: Role,
    pub stop_reason: Option<String>,
}

The result returned by the client for a {@link CreateMessageRequestsampling/createMessage} request. The client should inform the user before returning the sampled message, to allow them to inspect the response (human in the loop) and decide whether to allow the server to see it.

JSON schema

{
 "description": "The result returned by the client for a {@link CreateMessageRequestsampling/createMessage} request.\nThe client should inform the user before returning the sampled message, to allow them\nto inspect the response (human in the loop) and decide whether to allow the server to see it.",
 "type": "object",
 "required": [
   "content",
   "model",
   "role"
 ],
 "properties": {
   "_meta": {
     "$ref": "#/$defs/MetaObject"
   },
   "content": {
     "anyOf": [
       {
         "$ref": "#/$defs/TextContent"
       },
       {
         "$ref": "#/$defs/ImageContent"
       },
       {
         "$ref": "#/$defs/AudioContent"
       },
       {
         "$ref": "#/$defs/ToolUseContent"
       },
       {
         "$ref": "#/$defs/ToolResultContent"
       },
       {
         "type": "array",
         "items": {
           "$ref": "#/$defs/SamplingMessageContentBlock"
         }
       }
     ]
   },
   "model": {
     "description": "The name of the model that generated the message.",
     "type": "string"
   },
   "role": {
     "$ref": "#/$defs/Role"
   },
   "stopReason": {
     "description": "The reason why sampling stopped, if known.\n\nStandard values:\n- \"endTurn\": Natural end of the assistant's turn\n- \"stopSequence\": A stop sequence was encountered\n- \"maxTokens\": Maximum token limit was reached\n- \"toolUse\": The model wants to use one or more tools\n\nThis field is an open string to allow for provider-specific stop reasons.",
     "type": "string"
   }
 }
}

Fields

content: CreateMessageContent

meta: Option<MetaObject>

model: String

The name of the model that generated the message.

role: Role

stop_reason: Option<String>

The reason why sampling stopped, if known. Standard values: - “endTurn”: Natural end of the assistant’s turn - “stopSequence”: A stop sequence was encountered - “maxTokens”: Maximum token limit was reached - “toolUse”: The model wants to use one or more tools This field is an open string to allow for provider-specific stop reasons.

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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateMessageResult> for InputResponse

fn from(value: CreateMessageResult) -> InputResponse

Converts to this type from the input type.

impl From<CreateMessageResult> for ResultFromClient

BEGIN AUTO GENERATED

fn from(value: CreateMessageResult) -> ResultFromClient

Converts to this type from the input type.

impl From<CreateMessageResult> for MessageFromClient

fn from(value: CreateMessageResult) -> MessageFromClient

Converts to this type from the input type.

impl Serialize for CreateMessageResult

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 TryFrom<ResultFromClient> for CreateMessageResult

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from( value: ResultFromClient, ) -> Result<CreateMessageResult, <CreateMessageResult as TryFrom<ResultFromClient>>::Error>

Performs the conversion.