ChatCompletionMessage

A message in the chat conversation.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
role	string	The role of the messages author.
content	object	The contents of the message.
name	string	An optional name for the participant.
tool_calls	array	The tool calls generated by the model.
tool_call_id	string	Tool call that this message is responding to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatCompletionMessage",
  "title": "ChatCompletionMessage",
  "type": "object",
  "description": "A message in the chat conversation.",
  "properties": {
    "role": {
      "type": "string",
      "enum": [
        "system",
        "user",
        "assistant",
        "tool"
      ],
      "description": "The role of the messages author.",
      "example": "system"
    },
    "content": {
      "description": "The contents of the message.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "An optional name for the participant.",
      "example": "Example Title"
    },
    "tool_calls": {
      "type": "array",
      "description": "The tool calls generated by the model.",
      "items": {
        "$ref": "#/components/schemas/ChatCompletionToolCall"
      },
      "example": []
    },
    "tool_call_id": {
      "type": "string",
      "description": "Tool call that this message is responding to.",
      "example": "500123"
    }
  },
  "required": [
    "role"
  ]
}