OpenAI · Schema

ChatCompletionMessage

AIArtificial IntelligenceLarge Language ModelsT1

Properties

Name	Type	Description
role	string	The role of the message author.
content	string	The contents of the message. Can be a string or an array of content parts for multimodal inputs (text and images).
name	string	An optional name for the participant. Provides the model information to differentiate between participants of the same role.
tool_calls	array	The tool calls generated by the model, such as function calls.
tool_call_id	string	Tool call that this message is responding to. Required for tool role messages.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ChatCompletionMessage",
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "description": "The role of the message author."
    },
    "content": {
      "type": "string",
      "description": "The contents of the message. Can be a string or an array of content parts for multimodal inputs (text and images)."
    },
    "name": {
      "type": "string",
      "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
    },
    "tool_calls": {
      "type": "array",
      "description": "The tool calls generated by the model, such as function calls."
    },
    "tool_call_id": {
      "type": "string",
      "description": "Tool call that this message is responding to. Required for tool role messages."
    }
  }
}