Struct ChatCompletionRequestSystemMessage

pub struct ChatCompletionRequestSystemMessage {
    pub content: ChatCompletionRequestSystemMessageContent,
    pub name: Option<String>,
}

on openapi.yaml

ChatCompletionRequestSystemMessage:
  type: object
  title: System message
  description: >
    Developer-provided instructions that the model should follow, regardless
    of

    messages sent by the user. With o1 models and newer, use `developer`
    messages

    for this purpose instead.
  properties:
    content:
      description: The contents of the system message.
      oneOf:
        - type: string
          description: The contents of the system message.
          title: Text content
        - type: array
          description:
            An array of content parts with a defined type. For system messages,
            only type `text` is supported.
          title: Array of content parts
          items:
            $ref: "#/components/schemas/ChatCompletionRequestSystemMessageContentPart"
          minItems: 1
    role:
      type: string
      enum:
        - system
      description: The role of the messages author, in this case `system`.
      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: ChatCompletionRequestSystemMessageContent

The contents of the system 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 ChatCompletionRequestSystemMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionRequestSystemMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionRequestSystemMessage

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

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 ChatCompletionRequestSystemMessage