objectiveai-sdk 2.0.7

ObjectiveAI SDK, definitions, and utilities
Documentation
{
  "title": "functions.executions.response.streaming.InnerError",
  "description": "An inner error from a [`FunctionExecutionChunk`](super::FunctionExecutionChunk).\n\nEach variant carries `task_path` — the full hierarchical path from the\nroot execution down to the failing task (or, for the reasoning variant,\nto the execution whose reasoning agent failed). Empty `task_path` means\nthe error is at the root execution itself.\n\nWire shape (internally tagged on `\"type\"`):\n```json\n{\"type\":\"function_task_error\",\"task_path\":[0],\n \"swiss_pool_index\":1,\"swiss_round\":0,\"error\":{}}\n{\"type\":\"vector_completion_task_error\",\"task_path\":[0,1],\"error\":{}}\n{\"type\":\"vector_completion_task_error\",\"task_path\":[0,1],\n \"agent_completion_index\":2,\"error\":{}}\n{\"type\":\"reasoning_agent_completion_error\",\"task_path\":[],\"error\":{}}\n```\n\nDoes NOT include:\n- The chunk's own top-level `.error` — reachable directly via\n  [`FunctionExecutionChunk::error`](super::FunctionExecutionChunk::error).\n- The reasoning summary's own `.error`; only the inner agent\n  completion's failure surfaces as a reasoning error.",
  "anyOf": [
    {
      "title": "FunctionTaskError",
      "description": "A nested function execution task failed at its top level.\nYielded when a\n[`FunctionExecutionTaskChunk`](super::FunctionExecutionTaskChunk)'s\nwrapped inner `FunctionExecutionChunk` has its own `.error` set.\n\n`task_path` locates the failing task; `swiss_pool_index` /\n`swiss_round` / `split_index` carry the tournament/split context\nfrom the wrapper when set.",
      "type": "object",
      "properties": {
        "error": {
          "$ref": "error.ResponseError"
        },
        "split_index": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 18446744073709551615
            },
            {
              "type": "null"
            }
          ],
          "omitempty": true
        },
        "swiss_pool_index": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 18446744073709551615
            },
            {
              "type": "null"
            }
          ],
          "omitempty": true
        },
        "swiss_round": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 18446744073709551615
            },
            {
              "type": "null"
            }
          ],
          "omitempty": true
        },
        "task_path": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 18446744073709551615
          }
        },
        "type": {
          "type": "string",
          "enum": [
            "function_task_error"
          ]
        }
      }
    },
    {
      "title": "VectorCompletionTaskError",
      "description": "A vector completion task failed. The optional `agent_completion_index`\nis the discriminator:\n- `None` → the task itself failed (the wrapper's own `.error`).\n- `Some(N)` → agent completion `N` inside the task's vector\n  completion failed.\n\n`task_path` locates the vector completion task.",
      "type": "object",
      "properties": {
        "agent_completion_index": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 18446744073709551615
            },
            {
              "type": "null"
            }
          ],
          "omitempty": true
        },
        "error": {
          "$ref": "error.ResponseError"
        },
        "task_path": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 18446744073709551615
          }
        },
        "type": {
          "type": "string",
          "enum": [
            "vector_completion_task_error"
          ]
        }
      }
    },
    {
      "title": "ReasoningAgentCompletionError",
      "description": "The inner agent completion of a reasoning summary failed\n(`ReasoningSummaryChunk.inner.error`).\n\n`task_path` identifies whose reasoning — empty for the root\nexecution; non-empty for a nested execution at that path.",
      "type": "object",
      "properties": {
        "error": {
          "$ref": "error.ResponseError"
        },
        "task_path": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 18446744073709551615
          }
        },
        "type": {
          "type": "string",
          "enum": [
            "reasoning_agent_completion_error"
          ]
        }
      }
    }
  ]
}