@nimble-way/nimble-js 1.1.0 → 1.3.0

package/src/resources/agents/runs.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { Stream } from '../../core/streaming';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -60,12 +61,17 @@ export class Runs extends APIResource {
    * (`text/event-stream`). Create the run with `enable_events: true` to have events
    * published. A keep-alive comment is sent every 15 seconds.
    */
-  streamEvents(runID: string, params: RunStreamEventsParams, options?: RequestOptions): APIPromise<void> {
+  streamEvents(
+    runID: string,
+    params: RunStreamEventsParams,
+    options?: RequestOptions,
+  ): APIPromise<Stream<RunStreamEventsResponse>> {
     const { agent_id } = params;
     return this._client.get(path`/v2/agents/${agent_id}/runs/${runID}/events`, {
       ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+      headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
+      stream: true,
+    }) as APIPromise<Stream<RunStreamEventsResponse>>;
   }
 }
 
@@ -83,7 +89,7 @@ export interface RunCreateResponse {
   /**
    * Effort level used for the run.
    */
-  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+  effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
   /**
    * Interaction ID.
@@ -180,7 +186,7 @@ export namespace RunListResponse {
     /**
      * Effort level used for the run.
      */
-    effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+    effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
     /**
      * Interaction ID.
@@ -255,7 +261,7 @@ export interface RunGetResponse {
   /**
    * Effort level used for the run.
    */
-  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+  effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
   /**
    * Interaction ID.
@@ -702,7 +708,7 @@ export namespace RunResultResponse {
       /**
        * Effort level used for the run.
        */
-      effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+      effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
       /**
        * Interaction ID.
@@ -808,7 +814,7 @@ export namespace RunResultResponse {
       /**
        * Effort level used for the run.
        */
-      effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+      effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
       /**
        * Interaction ID.
@@ -870,16 +876,24 @@ export namespace RunResultResponse {
   }
 }
 
+export type RunStreamEventsResponse = unknown;
+
 export interface RunCreateParams {
   /**
    * User prompt or task instructions for the run.
    */
   input: string;
 
+  /**
+   * Stable agent name. On this no-agent-id route, an unseen name creates a new
+   * agent; an existing name reuses it. Ignored on the /{agent_id}/runs route.
+   */
+  agent_name?: string | null;
+
   /**
    * Canonical effort tier names for the research graph.
    */
-  effort?: 'low' | 'medium' | 'high' | 'x-high' | 'max' | null;
+  effort?: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max' | null;
 
   /**
    * Whether to stream run events when supported.
@@ -892,6 +906,11 @@ export interface RunCreateParams {
    */
   input_data?: Array<{ [key: string]: unknown }> | { [key: string]: unknown } | null;
 
+  /**
+   * Origin of public API runs. Public requests are always API-originated.
+   */
+  origin?: 'api';
+
   /**
    * JSON schema overriding the agent's default structured output for this run.
    */
@@ -902,10 +921,24 @@ export interface RunCreateParams {
    */
   previous_interaction_id?: string | null;
 
+  /**
+   * Skill override for this run. One-time only, except when this run creates a new
+   * agent via agent_name, in which case it becomes the new agent's stored skill.
+   */
+  skill?: string | null;
+
   /**
    * Source guidance overriding the agent default.
    */
   sources?: RunCreateParams.Sources | null;
+
+  /**
+   * Only settable when this run creates a new agent (via agent_name, or when no
+   * agent is resolved), in which case it becomes the new agent's stored use_case.
+   * For a run against an existing agent, this must match the agent's own use_case —
+   * passing the same value is accepted as a no-op, a different value is rejected.
+   */
+  use_case?: 'research' | 'enrichment' | 'dataset_building' | null;
 }
 
 export namespace RunCreateParams {
@@ -995,6 +1028,7 @@ export declare namespace Runs {
     type RunListResponse as RunListResponse,
     type RunGetResponse as RunGetResponse,
     type RunResultResponse as RunResultResponse,
+    type RunStreamEventsResponse as RunStreamEventsResponse,
     type RunCreateParams as RunCreateParams,
     type RunListParams as RunListParams,
     type RunGetParams as RunGetParams,

package/src/resources/agents/templates.ts

@@ -72,7 +72,7 @@ export namespace TemplateListResponse {
     /**
      * Default effort level for runs created from this template.
      */
-    effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+    effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
     /**
      * Ordered goals for the template.
@@ -203,7 +203,7 @@ export interface TemplateGetResponse {
   /**
    * Default effort level for runs created from this template.
    */
-  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
+  effort: 'low' | 'medium' | 'high' | 'x-high' | '5x-high' | 'max';
 
   /**
    * Ordered goals for the template.

package/src/resources/crawl.ts

@@ -1352,6 +1352,13 @@ export namespace CrawlRunParams {
      */
     parser?: { [key: string]: unknown } | string;
 
+    /**
+     * Overall deadline in milliseconds for a realtime request. Clamped to the account
+     * total timeout — it can shorten the deadline but never extend it. Has no effect
+     * on async requests.
+     */
+    realtime_total_timeout?: number;
+
     /**
      * Referrer policy for the request
      */

package/src/resources/extract/extract.ts

@@ -1556,6 +1556,13 @@ export interface ExtractAsyncParams {
    */
   parser?: { [key: string]: unknown } | string;
 
+  /**
+   * Overall deadline in milliseconds for a realtime request. Clamped to the account
+   * total timeout — it can shorten the deadline but never extend it. Has no effect
+   * on async requests.
+   */
+  realtime_total_timeout?: number;
+
   /**
    * Referrer policy for the request
    */
@@ -2700,6 +2707,13 @@ export namespace ExtractBatchParams {
      */
     parser?: { [key: string]: unknown } | string;
 
+    /**
+     * Overall deadline in milliseconds for a realtime request. Clamped to the account
+     * total timeout — it can shorten the deadline but never extend it. Has no effect
+     * on async requests.
+     */
+    realtime_total_timeout?: number;
+
     /**
      * Referrer policy for the request
      */
@@ -3839,6 +3853,13 @@ export namespace ExtractBatchParams {
      */
     parser?: { [key: string]: unknown } | string;
 
+    /**
+     * Overall deadline in milliseconds for a realtime request. Clamped to the account
+     * total timeout — it can shorten the deadline but never extend it. Has no effect
+     * on async requests.
+     */
+    realtime_total_timeout?: number;
+
     /**
      * Referrer policy for the request
      */
@@ -4974,6 +4995,13 @@ export interface ExtractRunParams {
    */
   parser?: { [key: string]: unknown } | string;
 
+  /**
+   * Overall deadline in milliseconds for a realtime request. Clamped to the account
+   * total timeout — it can shorten the deadline but never extend it. Has no effect
+   * on async requests.
+   */
+  realtime_total_timeout?: number;
+
   /**
    * Referrer policy for the request
    */

package/src/resources/jobs/jobs.ts

@@ -163,6 +163,13 @@ export namespace JobCreateResponse {
      * types.
      */
     file_path?: string | null;
+
+    /**
+     * Inline input records keyed by source node id, e.g. {'source_a': [{...}]}. Used
+     * when type is 'inline' on a dynamic-workflow job, which has one source node per
+     * input file. Mutually exclusive with 'data'.
+     */
+    node_data?: { [key: string]: Array<{ [key: string]: unknown }> } | null;
   }
 
   /**
@@ -287,6 +294,13 @@ export namespace JobUpdateResponse {
      * types.
      */
     file_path?: string | null;
+
+    /**
+     * Inline input records keyed by source node id, e.g. {'source_a': [{...}]}. Used
+     * when type is 'inline' on a dynamic-workflow job, which has one source node per
+     * input file. Mutually exclusive with 'data'.
+     */
+    node_data?: { [key: string]: Array<{ [key: string]: unknown }> } | null;
   }
 
   /**
@@ -442,6 +456,13 @@ export namespace JobListResponse {
        * types.
        */
       file_path?: string | null;
+
+      /**
+       * Inline input records keyed by source node id, e.g. {'source_a': [{...}]}. Used
+       * when type is 'inline' on a dynamic-workflow job, which has one source node per
+       * input file. Mutually exclusive with 'data'.
+       */
+      node_data?: { [key: string]: Array<{ [key: string]: unknown }> } | null;
     }
 
     /**
@@ -567,6 +588,13 @@ export namespace JobGetResponse {
      * types.
      */
     file_path?: string | null;
+
+    /**
+     * Inline input records keyed by source node id, e.g. {'source_a': [{...}]}. Used
+     * when type is 'inline' on a dynamic-workflow job, which has one source node per
+     * input file. Mutually exclusive with 'data'.
+     */
+    node_data?: { [key: string]: Array<{ [key: string]: unknown }> } | null;
   }
 
   /**
@@ -663,6 +691,13 @@ export namespace JobCreateParams {
      * types.
      */
     file_path?: string | null;
+
+    /**
+     * Inline input records keyed by source node id, e.g. {'source_a': [{...}]}. Used
+     * when type is 'inline' on a dynamic-workflow job, which has one source node per
+     * input file. Mutually exclusive with 'data'.
+     */
+    node_data?: { [key: string]: Array<{ [key: string]: unknown }> } | null;
   }
 
   /**
@@ -749,6 +784,13 @@ export namespace JobUpdateParams {
      * types.
      */
     file_path?: string | null;
+
+    /**
+     * Inline input records keyed by source node id, e.g. {'source_a': [{...}]}. Used
+     * when type is 'inline' on a dynamic-workflow job, which has one source node per
+     * input file. Mutually exclusive with 'data'.
+     */
+    node_data?: { [key: string]: Array<{ [key: string]: unknown }> } | null;
   }
 
   /**

package/src/resources/top-level.ts

@@ -985,6 +985,14 @@ export interface SearchParams {
    */
   focus?: string | Array<string>;
 
+  /**
+   * Return richer per-result content on the fast path. With search_depth='fast',
+   * enables live crawling of both web and news sources so results carry full
+   * markdown content instead of snippets only. Higher recall and cost. Ignored for
+   * other search_depth values.
+   */
+  full_content?: boolean;
+
   /**
    * Generate an LLM-powered answer summary based on search result snippets.
    */

package/src/streaming.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from './core/streaming';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.1.0'; // x-release-please-version
+export const VERSION = '1.3.0'; // x-release-please-version

package/streaming.d.mts

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from "./core/streaming.mjs";
+//# sourceMappingURL=streaming.d.mts.map

package/streaming.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.mts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qCAAiC"}

package/streaming.d.ts

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from "./core/streaming.js";
+//# sourceMappingURL=streaming.d.ts.map

package/streaming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,oCAAiC"}

package/streaming.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/streaming instead */
+tslib_1.__exportStar(require("./core/streaming.js"), exports);
+//# sourceMappingURL=streaming.js.map

package/streaming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.js","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,8DAAiC"}

package/streaming.mjs

@@ -0,0 +1,3 @@
+/** @deprecated Import from ./core/streaming instead */
+export * from "./core/streaming.mjs";
+//# sourceMappingURL=streaming.mjs.map

package/streaming.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.mjs","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qCAAiC"}

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.1.0";
+export declare const VERSION = "1.3.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.1.0";
+export declare const VERSION = "1.3.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.1.0'; // x-release-please-version
+exports.VERSION = '1.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.1.0'; // x-release-please-version
+export const VERSION = '1.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map