Struct CreateMessageResult

pub struct CreateMessageResult {
    pub content: CreateMessageResultContent,
    pub meta: Option<Map<String, Value>>,
    pub model: String,
    pub role: Role,
    pub stop_reason: Option<String>,
}

The client’s response to a sampling/create_message request from the server. 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 client's response to a sampling/create_message request from the server. 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.",
 "type": "object",
 "required": [
   "content",
   "model",
   "role"
 ],
 "properties": {
   "_meta": {
     "description": "This result property is reserved by the protocol to allow clients and servers to attach additional metadata to their responses.",
     "type": "object",
     "additionalProperties": {}
   },
   "content": {
     "anyOf": [
       {
         "$ref": "#/definitions/TextContent"
       },
       {
         "$ref": "#/definitions/ImageContent"
       },
       {
         "$ref": "#/definitions/AudioContent"
       }
     ]
   },
   "model": {
     "description": "The name of the model that generated the message.",
     "type": "string"
   },
   "role": {
     "$ref": "#/definitions/Role"
   },
   "stopReason": {
     "description": "The reason why sampling stopped, if known.",
     "type": "string"
   }
 }
}

Fields

content: CreateMessageResultContent

meta: Option<Map<String, Value>>

This result property is reserved by the protocol to allow clients and servers to attach additional metadata to their responses.

model: String

The name of the model that generated the message.

role: Role

stop_reason: Option<String>

The reason why sampling stopped, if known.

Trait Implementations

impl Clone for CreateMessageResult

fn clone(&self) -> CreateMessageResult

Returns a copy 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 From<CreateMessageResult> for MessageFromClient

fn from(value: CreateMessageResult) -> Self

Converts to this type from the input type.

impl From<CreateMessageResult> for ResultFromClient

fn from(value: CreateMessageResult) -> Self

Converts to this type from the input type.

impl FromMessage<CreateMessageResult> for ClientMessage

fn from_message( message: CreateMessageResult, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

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 ToMessage<ClientMessage> for CreateMessageResult

fn to_message( self, request_id: Option<RequestId>, ) -> Result<ClientMessage, RpcError>

impl TryFrom<ResultFromClient> for CreateMessageResult

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from(value: ResultFromClient) -> Result<Self, Self::Error>

Performs the conversion.