objectiveai-sdk 2.0.7

ObjectiveAI SDK, definitions, and utilities
Documentation
{
  "title": "functions.executions.response.streaming.VectorCompletionTaskChunk",
  "description": "A chunk in a streaming vector completion response.\n\nEach chunk contains incremental updates to the completion. Use the\n[`push`](Self::push) method to accumulate chunks into a complete response.",
  "type": "object",
  "properties": {
    "completions": {
      "description": "Incremental agent completion chunks from each agent.",
      "type": "array",
      "items": {
        "$ref": "vector.completions.response.streaming.AgentCompletionChunk"
      }
    },
    "created": {
      "description": "Unix timestamp when the completion was created.",
      "type": "integer",
      "minimum": 0,
      "maximum": 18446744073709551615
    },
    "error": {
      "anyOf": [
        {
          "$ref": "error.ResponseError"
        },
        {
          "type": "null"
        }
      ],
      "omitempty": true
    },
    "id": {
      "description": "Unique identifier for this vector completion.",
      "type": "string"
    },
    "index": {
      "type": "integer",
      "minimum": 0,
      "maximum": 18446744073709551615
    },
    "object": {
      "description": "Object type identifier (`\"vector.completion.chunk\"`).",
      "$ref": "vector.completions.response.streaming.Object"
    },
    "scores": {
      "description": "Current weighted scores. Updated as new votes arrive.",
      "type": "array",
      "items": {
        "type": "number",
        "minimum": -3.4028234663852886e+38,
        "maximum": 3.4028234663852886e+38
      }
    },
    "swarm": {
      "description": "ID of the swarm used for this completion.",
      "type": "string"
    },
    "task_index": {
      "type": "integer",
      "minimum": 0,
      "maximum": 18446744073709551615
    },
    "task_path": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 18446744073709551615
      }
    },
    "usage": {
      "description": "Aggregated usage statistics. Typically present only in the final chunk.",
      "anyOf": [
        {
          "$ref": "agent.completions.response.Usage"
        },
        {
          "type": "null"
        }
      ],
      "omitempty": true
    },
    "votes": {
      "description": "Votes received so far. New votes are appended in subsequent chunks.",
      "type": "array",
      "items": {
        "$ref": "vector.completions.response.Vote"
      }
    },
    "weights": {
      "description": "Current weight distribution across responses. Updated as new votes arrive.",
      "type": "array",
      "items": {
        "type": "number",
        "minimum": -3.4028234663852886e+38,
        "maximum": 3.4028234663852886e+38
      }
    }
  }
}