@arbidocs/client 0.3.134 → 0.3.135

package/dist/index.d.cts

@@ -4024,7 +4024,7 @@ interface components {
              *       "IMAGE": "arbi-sandbox:bookworm-slim",
              *       "TIMEOUT_SECONDS": 60,
              *       "MEMORY_LIMIT": "512m",
-             *       "NETWORK": "arbi-sandbox-net"
+             *       "NETWORK": "bridge"
              *     }
              */
             RunCode: components['schemas']['RunCodeConfig'];
@@ -4186,6 +4186,80 @@ interface components {
              */
             project_ext_id?: string | null;
         };
+        /**
+         * ArbiItemMeta
+         * @description ARBI's agent-trace extension carried on a Responses output_item.
+         *
+         *     Standard Responses items are `message` / `function_call` / `reasoning`; none
+         *     of them model the trace UI's needs — a human label ("Searching documents"),
+         *     the agent's focus narration, a result summary ("15 passages retrieved"),
+         *     per-item token cost, sub-agent lane grouping. Those ride here, under a single
+         *     namespaced `arbi` field, so a standard Responses client ignores it (unknown
+         *     field) while ours reads it. The item itself stays byte-for-byte standard.
+         */
+        ArbiItemMeta: {
+            /**
+             * Label
+             * @description Human display label. Backend-owned.
+             */
+            label?: string | null;
+            /**
+             * Focus
+             * @description The agent's own words for what this item is doing.
+             */
+            focus?: string | null;
+            /**
+             * Detail
+             * @description Enriched tool-call display shape (resolved summary, page ranges, digest flags) — richer than the raw `arguments` JSON, for the trace UI. One entry per call on a function_call item.
+             */
+            detail?: {
+                [key: string]: unknown;
+            }[] | null;
+            /**
+             * Outcome
+             * @description Result summary, e.g. '15 passages retrieved'.
+             */
+            outcome?: string | null;
+            /** @description Token usage for the LLM call behind this item. */
+            usage?: components['schemas']['StepUsage'] | null;
+            /**
+             * Step Tokens
+             * @description Per-item token cost.
+             */
+            step_tokens?: number | null;
+            /**
+             * Total Tokens
+             * @description Cumulative tokens across the response so far.
+             */
+            total_tokens?: number | null;
+            /** @description Token budget snapshot. */
+            context?: components['schemas']['TokenBudgetContext'] | null;
+            /**
+             * Parent Id
+             * @description Output-item id this nests under (sub-agent steps).
+             */
+            parent_id?: string | null;
+            /**
+             * Subagent
+             * @description Sub-agent handle for live-lane grouping.
+             */
+            subagent?: string | null;
+            /**
+             * Subagent Status
+             * @description Sub-agent lane lifecycle marker.
+             */
+            subagent_status?: ('running' | 'done' | 'failed') | null;
+            /**
+             * Model Recommendation
+             * @description FilterPlan model tier (goal item, auto mode).
+             */
+            model_recommendation?: string | null;
+            /**
+             * Selected Model
+             * @description Resolved model (goal item, auto mode).
+             */
+            selected_model?: string | null;
+        };
         /**
          * ArtifactEvent
          * @description A generated artifact (document/draft) for the artifact panel.
@@ -6305,6 +6379,51 @@ interface components {
             /** Count */
             count?: number | null;
         };
+        /**
+         * FunctionCallItem
+         * @description A `function_call` output_item — one tool invocation (Responses-standard).
+         *
+         *     Replaces the v1 tool-call agent_step. Arguments may stream incrementally via
+         *     response.function_call_arguments.delta before the item completes.
+         */
+        FunctionCallItem: {
+            /**
+             * Type
+             * @default function_call
+             * @constant
+             */
+            type: 'function_call';
+            /**
+             * Id
+             * @description Output-item id
+             */
+            id: string;
+            /**
+             * Call Id
+             * @description Tool call id, correlates the call with its result.
+             */
+            call_id: string;
+            /**
+             * Name
+             * @description Tool name, e.g. 'search_inside_documents'.
+             */
+            name: string;
+            /**
+             * Arguments
+             * @description JSON-encoded arguments (may arrive via arguments.delta).
+             * @default
+             */
+            arguments: string;
+            /**
+             * Status
+             * @description Call status.
+             * @default in_progress
+             * @enum {string}
+             */
+            status: 'in_progress' | 'completed';
+            /** @description ARBI agent-trace extension (non-standard). */
+            arbi?: components['schemas']['ArbiItemMeta'] | null;
+        };
         /**
          * GenerateAgentAvatarRequest
          * @description Prompt for generating an agent avatar (usually composed from the persona).
@@ -7387,7 +7506,11 @@ interface components {
         };
         /**
          * OutputMessage
-         * @description A single output message entry in a response.
+         * @description A `message` output_item — assistant text (Responses-standard).
+         *
+         *     The terminal message of a response is the answer; an earlier message (one
+         *     followed by a function_call) is narration the model emitted alongside a tool
+         *     call. Which is which is an ordering fact the client reads, not a backend gate.
          */
         OutputMessage: {
             /**
@@ -7398,7 +7521,7 @@ interface components {
             type: 'message';
             /**
              * Id
-             * @description Message external ID
+             * @description Output-item id
              */
             id: string;
             /**
@@ -7418,6 +7541,8 @@ interface components {
              * @description Message content blocks
              */
             content?: components['schemas']['OutputTextContent'][];
+            /** @description ARBI agent-trace extension (non-standard). */
+            arbi?: components['schemas']['ArbiItemMeta'] | null;
         };
         /**
          * OutputTextContent
@@ -8094,6 +8219,40 @@ interface components {
              */
             url: string;
         };
+        /**
+         * ReasoningItem
+         * @description A `reasoning` output_item — the agent's non-answer thinking (Responses-standard).
+         *
+         *     Carries ARBI lifecycle steps that are neither a message nor a tool call: the
+         *     goal/plan step, evaluation, goal-progress. `arbi.label` names it for the UI.
+         */
+        ReasoningItem: {
+            /**
+             * Type
+             * @default reasoning
+             * @constant
+             */
+            type: 'reasoning';
+            /**
+             * Id
+             * @description Output-item id
+             */
+            id: string;
+            /**
+             * Status
+             * @description Reasoning status.
+             * @default in_progress
+             * @enum {string}
+             */
+            status: 'in_progress' | 'completed';
+            /**
+             * Summary
+             * @description Reasoning text blocks.
+             */
+            summary?: components['schemas']['OutputTextContent'][];
+            /** @description ARBI agent-trace extension (non-standard). */
+            arbi?: components['schemas']['ArbiItemMeta'] | null;
+        };
         /**
          * RegisterRequest
          * @description Unified user registration request (local and SSO).
@@ -8331,9 +8490,9 @@ interface components {
             model: string;
             /**
              * Output
-             * @description Final output messages with content
+             * @description Final output items (messages, function_calls, reasoning)
              */
-            output: components['schemas']['OutputMessage'][];
+            output: (components['schemas']['OutputMessage'] | components['schemas']['FunctionCallItem'] | components['schemas']['ReasoningItem'])[];
             /** @description Token usage summary */
             usage: components['schemas']['ResponseUsage'];
             /** @description Full MessageResponse plus context_usage, suggested_query */
@@ -8490,9 +8649,48 @@ interface components {
             /** @description Error details */
             error: components['schemas']['ResponseError'];
         };
+        /**
+         * ResponseFunctionCallArgumentsDeltaEvent
+         * @description OpenAI response.function_call_arguments.delta: streams a tool call's args.
+         *
+         *     Emitted between a function_call item's added and done events as the model
+         *     assembles the JSON arguments, so the client can show a call forming live.
+         */
+        ResponseFunctionCallArgumentsDeltaEvent: {
+            /**
+             * Type
+             * @default response.function_call_arguments.delta
+             * @constant
+             */
+            type: 'response.function_call_arguments.delta';
+            /**
+             * Sequence Number
+             * @description Monotonic sequence number for event ordering
+             */
+            sequence_number: number;
+            /**
+             * Item Id
+             * @description ID of the function_call output item
+             */
+            item_id: string;
+            /**
+             * Output Index
+             * @default 0
+             */
+            output_index: number;
+            /**
+             * Delta
+             * @description Incremental JSON-argument text to append.
+             */
+            delta: string;
+        };
         /**
          * ResponseOutputItemAddedEvent
-         * @description OpenAI response.output_item.added: announces a new output message.
+         * @description OpenAI response.output_item.added: announces a new output item.
+         *
+         *     In v3 (#2075) the item is any of message / function_call / reasoning — one is
+         *     emitted for every assistant message, tool call, and lifecycle step, replacing
+         *     the index-keyed arbi.agent_step.
          */
         ResponseOutputItemAddedEvent: {
             /**
@@ -8511,12 +8709,18 @@ interface components {
              * @default 0
              */
             output_index: number;
-            /** @description The output message skeleton */
-            item: components['schemas']['OutputMessage'];
+            /**
+             * Item
+             * @description The output item skeleton (message / function_call / reasoning)
+             */
+            item: components['schemas']['OutputMessage'] | components['schemas']['FunctionCallItem'] | components['schemas']['ReasoningItem'];
         };
         /**
          * ResponseOutputItemDoneEvent
-         * @description OpenAI response.output_item.done: completed output message with full content.
+         * @description OpenAI response.output_item.done: a completed output item.
+         *
+         *     The completed item carries its settled arbi extension (outcome, usage) for
+         *     function_call / reasoning items, and the full text for a message.
          */
         ResponseOutputItemDoneEvent: {
             /**
@@ -8535,8 +8739,11 @@ interface components {
              * @default 0
              */
             output_index: number;
-            /** @description The completed output message */
-            item: components['schemas']['OutputMessage'];
+            /**
+             * Item
+             * @description The completed output item
+             */
+            item: components['schemas']['OutputMessage'] | components['schemas']['FunctionCallItem'] | components['schemas']['ReasoningItem'];
         };
         /**
          * ResponseOutputTextDeltaEvent
@@ -9019,8 +9226,8 @@ interface components {
             MEMORY_LIMIT: string;
             /**
              * Network
-             * @description Container network mode. 'arbi-sandbox-net' is the dedicated bridge created at deploy time (outbound internet works; other sandboxes are unreachable). 'none' for full isolation. Do not use 'bridge' — on the shared default bridge, model-authored code sits alongside every other container on the host.
-             * @default arbi-sandbox-net
+             * @description Container network mode. 'bridge' allows internet (pip/npm install). 'none' for full isolation.
+             * @default bridge
              */
             NETWORK: string;
         };
@@ -9070,6 +9277,7 @@ interface components {
             response_output_text_delta?: components['schemas']['ResponseOutputTextDeltaEvent'] | null;
             response_output_text_done?: components['schemas']['ResponseOutputTextDoneEvent'] | null;
             response_output_item_done?: components['schemas']['ResponseOutputItemDoneEvent'] | null;
+            response_function_call_arguments_delta?: components['schemas']['ResponseFunctionCallArgumentsDeltaEvent'] | null;
             response_completed?: components['schemas']['ResponseCompletedEvent'] | null;
             response_failed?: components['schemas']['ResponseFailedEvent'] | null;
             artifact?: components['schemas']['ArtifactEvent'] | null;
@@ -9079,6 +9287,10 @@ interface components {
             output_tokens_details?: components['schemas']['OutputTokensDetails'] | null;
             context_usage?: components['schemas']['ContextUsage'] | null;
             message_metadata?: components['schemas']['MessageMetadataPayload'] | null;
+            output_message?: components['schemas']['OutputMessage'] | null;
+            function_call_item?: components['schemas']['FunctionCallItem'] | null;
+            reasoning_item?: components['schemas']['ReasoningItem'] | null;
+            arbi_item_meta?: components['schemas']['ArbiItemMeta'] | null;
             detail_search_inside_documents?: components['schemas']['SearchInsideDocumentsDetail'] | null;
             detail_read_document?: components['schemas']['ReadDocumentDetail'] | null;
             detail_get_table_of_contents?: components['schemas']['GetTableOfContentsDetail'] | null;

package/dist/index.d.ts

@@ -4024,7 +4024,7 @@ interface components {
              *       "IMAGE": "arbi-sandbox:bookworm-slim",
              *       "TIMEOUT_SECONDS": 60,
              *       "MEMORY_LIMIT": "512m",
-             *       "NETWORK": "arbi-sandbox-net"
+             *       "NETWORK": "bridge"
              *     }
              */
             RunCode: components['schemas']['RunCodeConfig'];
@@ -4186,6 +4186,80 @@ interface components {
              */
             project_ext_id?: string | null;
         };
+        /**
+         * ArbiItemMeta
+         * @description ARBI's agent-trace extension carried on a Responses output_item.
+         *
+         *     Standard Responses items are `message` / `function_call` / `reasoning`; none
+         *     of them model the trace UI's needs — a human label ("Searching documents"),
+         *     the agent's focus narration, a result summary ("15 passages retrieved"),
+         *     per-item token cost, sub-agent lane grouping. Those ride here, under a single
+         *     namespaced `arbi` field, so a standard Responses client ignores it (unknown
+         *     field) while ours reads it. The item itself stays byte-for-byte standard.
+         */
+        ArbiItemMeta: {
+            /**
+             * Label
+             * @description Human display label. Backend-owned.
+             */
+            label?: string | null;
+            /**
+             * Focus
+             * @description The agent's own words for what this item is doing.
+             */
+            focus?: string | null;
+            /**
+             * Detail
+             * @description Enriched tool-call display shape (resolved summary, page ranges, digest flags) — richer than the raw `arguments` JSON, for the trace UI. One entry per call on a function_call item.
+             */
+            detail?: {
+                [key: string]: unknown;
+            }[] | null;
+            /**
+             * Outcome
+             * @description Result summary, e.g. '15 passages retrieved'.
+             */
+            outcome?: string | null;
+            /** @description Token usage for the LLM call behind this item. */
+            usage?: components['schemas']['StepUsage'] | null;
+            /**
+             * Step Tokens
+             * @description Per-item token cost.
+             */
+            step_tokens?: number | null;
+            /**
+             * Total Tokens
+             * @description Cumulative tokens across the response so far.
+             */
+            total_tokens?: number | null;
+            /** @description Token budget snapshot. */
+            context?: components['schemas']['TokenBudgetContext'] | null;
+            /**
+             * Parent Id
+             * @description Output-item id this nests under (sub-agent steps).
+             */
+            parent_id?: string | null;
+            /**
+             * Subagent
+             * @description Sub-agent handle for live-lane grouping.
+             */
+            subagent?: string | null;
+            /**
+             * Subagent Status
+             * @description Sub-agent lane lifecycle marker.
+             */
+            subagent_status?: ('running' | 'done' | 'failed') | null;
+            /**
+             * Model Recommendation
+             * @description FilterPlan model tier (goal item, auto mode).
+             */
+            model_recommendation?: string | null;
+            /**
+             * Selected Model
+             * @description Resolved model (goal item, auto mode).
+             */
+            selected_model?: string | null;
+        };
         /**
          * ArtifactEvent
          * @description A generated artifact (document/draft) for the artifact panel.
@@ -6305,6 +6379,51 @@ interface components {
             /** Count */
             count?: number | null;
         };
+        /**
+         * FunctionCallItem
+         * @description A `function_call` output_item — one tool invocation (Responses-standard).
+         *
+         *     Replaces the v1 tool-call agent_step. Arguments may stream incrementally via
+         *     response.function_call_arguments.delta before the item completes.
+         */
+        FunctionCallItem: {
+            /**
+             * Type
+             * @default function_call
+             * @constant
+             */
+            type: 'function_call';
+            /**
+             * Id
+             * @description Output-item id
+             */
+            id: string;
+            /**
+             * Call Id
+             * @description Tool call id, correlates the call with its result.
+             */
+            call_id: string;
+            /**
+             * Name
+             * @description Tool name, e.g. 'search_inside_documents'.
+             */
+            name: string;
+            /**
+             * Arguments
+             * @description JSON-encoded arguments (may arrive via arguments.delta).
+             * @default
+             */
+            arguments: string;
+            /**
+             * Status
+             * @description Call status.
+             * @default in_progress
+             * @enum {string}
+             */
+            status: 'in_progress' | 'completed';
+            /** @description ARBI agent-trace extension (non-standard). */
+            arbi?: components['schemas']['ArbiItemMeta'] | null;
+        };
         /**
          * GenerateAgentAvatarRequest
          * @description Prompt for generating an agent avatar (usually composed from the persona).
@@ -7387,7 +7506,11 @@ interface components {
         };
         /**
          * OutputMessage
-         * @description A single output message entry in a response.
+         * @description A `message` output_item — assistant text (Responses-standard).
+         *
+         *     The terminal message of a response is the answer; an earlier message (one
+         *     followed by a function_call) is narration the model emitted alongside a tool
+         *     call. Which is which is an ordering fact the client reads, not a backend gate.
          */
         OutputMessage: {
             /**
@@ -7398,7 +7521,7 @@ interface components {
             type: 'message';
             /**
              * Id
-             * @description Message external ID
+             * @description Output-item id
              */
             id: string;
             /**
@@ -7418,6 +7541,8 @@ interface components {
              * @description Message content blocks
              */
             content?: components['schemas']['OutputTextContent'][];
+            /** @description ARBI agent-trace extension (non-standard). */
+            arbi?: components['schemas']['ArbiItemMeta'] | null;
         };
         /**
          * OutputTextContent
@@ -8094,6 +8219,40 @@ interface components {
              */
             url: string;
         };
+        /**
+         * ReasoningItem
+         * @description A `reasoning` output_item — the agent's non-answer thinking (Responses-standard).
+         *
+         *     Carries ARBI lifecycle steps that are neither a message nor a tool call: the
+         *     goal/plan step, evaluation, goal-progress. `arbi.label` names it for the UI.
+         */
+        ReasoningItem: {
+            /**
+             * Type
+             * @default reasoning
+             * @constant
+             */
+            type: 'reasoning';
+            /**
+             * Id
+             * @description Output-item id
+             */
+            id: string;
+            /**
+             * Status
+             * @description Reasoning status.
+             * @default in_progress
+             * @enum {string}
+             */
+            status: 'in_progress' | 'completed';
+            /**
+             * Summary
+             * @description Reasoning text blocks.
+             */
+            summary?: components['schemas']['OutputTextContent'][];
+            /** @description ARBI agent-trace extension (non-standard). */
+            arbi?: components['schemas']['ArbiItemMeta'] | null;
+        };
         /**
          * RegisterRequest
          * @description Unified user registration request (local and SSO).
@@ -8331,9 +8490,9 @@ interface components {
             model: string;
             /**
              * Output
-             * @description Final output messages with content
+             * @description Final output items (messages, function_calls, reasoning)
              */
-            output: components['schemas']['OutputMessage'][];
+            output: (components['schemas']['OutputMessage'] | components['schemas']['FunctionCallItem'] | components['schemas']['ReasoningItem'])[];
             /** @description Token usage summary */
             usage: components['schemas']['ResponseUsage'];
             /** @description Full MessageResponse plus context_usage, suggested_query */
@@ -8490,9 +8649,48 @@ interface components {
             /** @description Error details */
             error: components['schemas']['ResponseError'];
         };
+        /**
+         * ResponseFunctionCallArgumentsDeltaEvent
+         * @description OpenAI response.function_call_arguments.delta: streams a tool call's args.
+         *
+         *     Emitted between a function_call item's added and done events as the model
+         *     assembles the JSON arguments, so the client can show a call forming live.
+         */
+        ResponseFunctionCallArgumentsDeltaEvent: {
+            /**
+             * Type
+             * @default response.function_call_arguments.delta
+             * @constant
+             */
+            type: 'response.function_call_arguments.delta';
+            /**
+             * Sequence Number
+             * @description Monotonic sequence number for event ordering
+             */
+            sequence_number: number;
+            /**
+             * Item Id
+             * @description ID of the function_call output item
+             */
+            item_id: string;
+            /**
+             * Output Index
+             * @default 0
+             */
+            output_index: number;
+            /**
+             * Delta
+             * @description Incremental JSON-argument text to append.
+             */
+            delta: string;
+        };
         /**
          * ResponseOutputItemAddedEvent
-         * @description OpenAI response.output_item.added: announces a new output message.
+         * @description OpenAI response.output_item.added: announces a new output item.
+         *
+         *     In v3 (#2075) the item is any of message / function_call / reasoning — one is
+         *     emitted for every assistant message, tool call, and lifecycle step, replacing
+         *     the index-keyed arbi.agent_step.
          */
         ResponseOutputItemAddedEvent: {
             /**
@@ -8511,12 +8709,18 @@ interface components {
              * @default 0
              */
             output_index: number;
-            /** @description The output message skeleton */
-            item: components['schemas']['OutputMessage'];
+            /**
+             * Item
+             * @description The output item skeleton (message / function_call / reasoning)
+             */
+            item: components['schemas']['OutputMessage'] | components['schemas']['FunctionCallItem'] | components['schemas']['ReasoningItem'];
         };
         /**
          * ResponseOutputItemDoneEvent
-         * @description OpenAI response.output_item.done: completed output message with full content.
+         * @description OpenAI response.output_item.done: a completed output item.
+         *
+         *     The completed item carries its settled arbi extension (outcome, usage) for
+         *     function_call / reasoning items, and the full text for a message.
          */
         ResponseOutputItemDoneEvent: {
             /**
@@ -8535,8 +8739,11 @@ interface components {
              * @default 0
              */
             output_index: number;
-            /** @description The completed output message */
-            item: components['schemas']['OutputMessage'];
+            /**
+             * Item
+             * @description The completed output item
+             */
+            item: components['schemas']['OutputMessage'] | components['schemas']['FunctionCallItem'] | components['schemas']['ReasoningItem'];
         };
         /**
          * ResponseOutputTextDeltaEvent
@@ -9019,8 +9226,8 @@ interface components {
             MEMORY_LIMIT: string;
             /**
              * Network
-             * @description Container network mode. 'arbi-sandbox-net' is the dedicated bridge created at deploy time (outbound internet works; other sandboxes are unreachable). 'none' for full isolation. Do not use 'bridge' — on the shared default bridge, model-authored code sits alongside every other container on the host.
-             * @default arbi-sandbox-net
+             * @description Container network mode. 'bridge' allows internet (pip/npm install). 'none' for full isolation.
+             * @default bridge
              */
             NETWORK: string;
         };
@@ -9070,6 +9277,7 @@ interface components {
             response_output_text_delta?: components['schemas']['ResponseOutputTextDeltaEvent'] | null;
             response_output_text_done?: components['schemas']['ResponseOutputTextDoneEvent'] | null;
             response_output_item_done?: components['schemas']['ResponseOutputItemDoneEvent'] | null;
+            response_function_call_arguments_delta?: components['schemas']['ResponseFunctionCallArgumentsDeltaEvent'] | null;
             response_completed?: components['schemas']['ResponseCompletedEvent'] | null;
             response_failed?: components['schemas']['ResponseFailedEvent'] | null;
             artifact?: components['schemas']['ArtifactEvent'] | null;
@@ -9079,6 +9287,10 @@ interface components {
             output_tokens_details?: components['schemas']['OutputTokensDetails'] | null;
             context_usage?: components['schemas']['ContextUsage'] | null;
             message_metadata?: components['schemas']['MessageMetadataPayload'] | null;
+            output_message?: components['schemas']['OutputMessage'] | null;
+            function_call_item?: components['schemas']['FunctionCallItem'] | null;
+            reasoning_item?: components['schemas']['ReasoningItem'] | null;
+            arbi_item_meta?: components['schemas']['ArbiItemMeta'] | null;
             detail_search_inside_documents?: components['schemas']['SearchInsideDocumentsDetail'] | null;
             detail_read_document?: components['schemas']['ReadDocumentDetail'] | null;
             detail_get_table_of_contents?: components['schemas']['GetTableOfContentsDetail'] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbidocs/client",
-  "version": "0.3.134",
+  "version": "0.3.135",
   "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
   "type": "module",
   "main": "dist/index.cjs",