ChatEventData

All wire models

Model aliases: ChatEventData.

Type: object.

Fields

Required means the key must be present. Nullable means its value may be null; it does not make a required key optional. “Not specified” means the schema declares no default.

Field	Type	Required	Default
chunk_index	integer or null	No	null
chunk_count	integer or null	No	null
text_offset	integer or null	No	null
proposal_update	ProposalUpdate or null	No	null
tool_activity	ToolActivity or null	No	null
answer_policy	AnswerPolicy or null	No	null
presentation	Presentation or null	No	null
text	string or null	No	null
stage	string or null	No	null
message	string or null	No	null
status	string or null	No	null
code	string or null	No	null
message_id	string or null	No	null
artifact	OpenUIArtifact or null	No	null
citation	Citation or null	No	null

Model constraints

• Additional properties: permitted

Field constraints

status

• anyOf branch 1 (string): Allowed values: "queued", "running", "completed", "failed", "cancelled"

Exact JSON Schema

This is a schema definition, not an example request. It preserves all declared keywords, including constraints not summarized above.

Complete JSON Schema

JSON

{
  "additionalProperties": true,
  "properties": {
    "chunk_index": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Chunk Index"
    },
    "chunk_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Chunk Count"
    },
    "text_offset": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Text Offset"
    },
    "proposal_update": {
      "anyOf": [
        {
          "$ref": "#/$defs/ProposalUpdate"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "tool_activity": {
      "anyOf": [
        {
          "$ref": "#/$defs/ToolActivity"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "answer_policy": {
      "anyOf": [
        {
          "$ref": "#/$defs/AnswerPolicy"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "presentation": {
      "anyOf": [
        {
          "$ref": "#/$defs/Presentation"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Text"
    },
    "stage": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Stage"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    },
    "status": {
      "anyOf": [
        {
          "enum": [
            "queued",
            "running",
            "completed",
            "failed",
            "cancelled"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Code"
    },
    "message_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message Id"
    },
    "artifact": {
      "anyOf": [
        {
          "$ref": "#/$defs/OpenUIArtifact"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "citation": {
      "anyOf": [
        {
          "$ref": "#/$defs/Citation"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "title": "ChatEventData",
  "type": "object"
}