Struct CreateMessageResult

Source
pub struct CreateMessageResult {
    pub content: CreateMessageResultContent,
    pub meta: Map<String, Value>,
    pub model: String,
    pub role: Role,
    pub stop_reason: Option<String>,
}
Expand 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.

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: 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§

Source§

impl Clone for CreateMessageResult

Source§

fn clone(&self) -> CreateMessageResult

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateMessageResult

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&CreateMessageResult> for ClientResult

Source§

fn from(value: &CreateMessageResult) -> Self

Converts to this type from the input type.
Source§

impl From<&CreateMessageResult> for CreateMessageResult

Source§

fn from(value: &CreateMessageResult) -> Self

Converts to this type from the input type.
Source§

impl From<CreateMessageResult> for ClientResult

Source§

fn from(value: CreateMessageResult) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for CreateMessageResult

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for CreateMessageResult

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CreateMessageResult

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,