Share feedback
Answers are generated based on the documentation.

Experimental

Schema

ProcessOutput

Type: object

Output is one server frame on an interaction stream. At most one of chunk, exited, heartbeat is set.
chunk

Schema: ProcessChunk

chunk carries ordered process output.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ProcessChunk",
  "description": "chunk carries ordered process output."
}
exited

Schema: ProcessExited

exited reports process completion.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ProcessExited",
  "description": "exited reports process completion."
}
heartbeat

Schema: ProcessHeartbeat

heartbeat keeps an idle stream alive and carries no resume position.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ProcessHeartbeat",
  "description": "heartbeat keeps an idle stream alive and carries no resume position."
}
All schema constraints and annotations
{
  "dependentSchemas": {
    "chunk": {
      "not": {
        "anyOf": [
          {
            "required": [
              "exited"
            ]
          },
          {
            "required": [
              "heartbeat"
            ]
          }
        ]
      }
    },
    "exited": {
      "not": {
        "anyOf": [
          {
            "required": [
              "chunk"
            ]
          },
          {
            "required": [
              "heartbeat"
            ]
          }
        ]
      }
    },
    "heartbeat": {
      "not": {
        "anyOf": [
          {
            "required": [
              "chunk"
            ]
          },
          {
            "required": [
              "exited"
            ]
          }
        ]
      }
    }
  },
  "description": "Output is one server frame on an interaction stream. At most one of chunk, exited, heartbeat is set.",
  "properties": {
    "chunk": {
      "$ref": "#/components/schemas/ProcessChunk",
      "description": "chunk carries ordered process output."
    },
    "exited": {
      "$ref": "#/components/schemas/ProcessExited",
      "description": "exited reports process completion."
    },
    "heartbeat": {
      "$ref": "#/components/schemas/ProcessHeartbeat",
      "description": "heartbeat keeps an idle stream alive and carries no resume position."
    }
  },
  "title": "Output",
  "type": "object",
  "unevaluatedProperties": false
}