Struct ChatCompletionRequestUserMessage

pub struct ChatCompletionRequestUserMessage {
    pub content: ChatCompletionRequestUserMessageContent,
    pub name: Option<String>,
}

on openapi.yaml

ChatCompletionRequestUserMessage:
  type: object
  title: User message
  description: |
    Messages sent by an end user, containing prompts or additional context
    information.
  properties:
    content:
      description: |
        The contents of the user message.
      oneOf:
        - type: string
          description: The text contents of the message.
          title: Text content
        - type: array
          description:
            An array of content parts with a defined type. Supported options
            differ based on the [model](/docs/models) being used to generate
            the response. Can contain text, image, or audio inputs.
          title: Array of content parts
          items:
            $ref: "#/components/schemas/ChatCompletionRequestUserMessageContentPart"
          minItems: 1
    role:
      type: string
      enum:
        - user
      description: The role of the messages author, in this case `user`.
      x-stainless-const: true
    name:
      type: string
      description: An optional name for the participant. Provides the model
        information to differentiate between participants of the same role.
  required:
    - content
    - role

Fields

content: ChatCompletionRequestUserMessageContent

The contents of the user message.

name: Option<String>

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Trait Implementations

impl Debug for ChatCompletionRequestUserMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionRequestUserMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionRequestUserMessage

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

Tests for self and other values to be equal, and is used by ==.

const 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 ChatCompletionRequestUserMessage

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 ChatCompletionRequestUserMessage