parallel-web 0.4.1 → 0.5.0

package/src/resources/beta/task-group.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as TaskGroupAPI from './task-group';
+import * as TaskGroupAPI from '../task-group';
 import * as TaskRunAPI from '../task-run';
 import * as BetaTaskRunAPI from './task-run';
 import { APIPromise } from '../../core/api-promise';
@@ -11,26 +11,17 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 /**
- * The Task API executes web research and extraction tasks. Clients submit a natural-language objective with an optional input schema; the service plans retrieval, fetches relevant URLs, and returns outputs that conform to a provided or inferred JSON schema. Supports deep research style queries and can return rich structured JSON outputs. Processors trade-off between cost, latency, and quality. Each processor supports calibrated confidences.
- * - Output metadata: citations, excerpts, reasoning, and confidence per field
+ * Tasks (Beta)
  *
- * Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
- *  - Submit hundreds or thousands of Tasks as a single group
- * - Observe group progress and receive results as they complete
- * - Real-time updates via Server-Sent Events (SSE)
- * - Add tasks to an existing group while it is running
- * - Group-level retry and error aggregation
+ * @deprecated Use GA Task Group instead
  */
 export class TaskGroup extends APIResource {
   /**
    * Initiates a TaskGroup to group and track multiple runs.
    *
-   * @example
-   * ```ts
-   * const taskGroup = await client.beta.taskGroup.create();
-   * ```
+   * @deprecated Use GA Task Group instead
    */
-  create(body: TaskGroupCreateParams, options?: RequestOptions): APIPromise<TaskGroup> {
+  create(body: TaskGroupCreateParams, options?: RequestOptions): APIPromise<TaskGroupAPI.TaskGroup> {
     return this._client.post('/v1beta/tasks/groups', {
       body,
       ...options,
@@ -41,14 +32,9 @@ export class TaskGroup extends APIResource {
   /**
    * Retrieves aggregated status across runs in a TaskGroup.
    *
-   * @example
-   * ```ts
-   * const taskGroup = await client.beta.taskGroup.retrieve(
-   *   'taskgroup_id',
-   * );
-   * ```
+   * @deprecated Use GA Task Group instead
    */
-  retrieve(taskGroupID: string, options?: RequestOptions): APIPromise<TaskGroup> {
+  retrieve(taskGroupID: string, options?: RequestOptions): APIPromise<TaskGroupAPI.TaskGroup> {
     return this._client.get(path`/v1beta/tasks/groups/${taskGroupID}`, {
       ...options,
       headers: buildHeaders([{ 'parallel-beta': 'search-extract-2025-10-10' }, options?.headers]),
@@ -58,24 +44,13 @@ export class TaskGroup extends APIResource {
   /**
    * Initiates multiple task runs within a TaskGroup.
    *
-   * @example
-   * ```ts
-   * const taskGroupRunResponse =
-   *   await client.beta.taskGroup.addRuns('taskgroup_id', {
-   *     inputs: [
-   *       {
-   *         input: 'What was the GDP of France in 2023?',
-   *         processor: 'base',
-   *       },
-   *     ],
-   *   });
-   * ```
+   * @deprecated Use GA Task Group instead
    */
   addRuns(
     taskGroupID: string,
     params: TaskGroupAddRunsParams,
     options?: RequestOptions,
-  ): APIPromise<TaskGroupRunResponse> {
+  ): APIPromise<TaskGroupAPI.TaskGroupRunResponse> {
     const { refresh_status, betas, ...body } = params;
     return this._client.post(path`/v1beta/tasks/groups/${taskGroupID}/runs`, {
       query: { refresh_status },
@@ -94,12 +69,7 @@ export class TaskGroup extends APIResource {
    * The connection will remain open for up to an hour as long as at least one run in
    * the group is still active.
    *
-   * @example
-   * ```ts
-   * const response = await client.beta.taskGroup.events(
-   *   'taskgroup_id',
-   * );
-   * ```
+   * @deprecated Use GA Task Group instead
    */
   events(
     taskGroupID: string,
@@ -129,12 +99,7 @@ export class TaskGroup extends APIResource {
    * the stream. The stream will resume from the next event after the
    * `last_event_id`.
    *
-   * @example
-   * ```ts
-   * const response = await client.beta.taskGroup.getRuns(
-   *   'taskgroup_id',
-   * );
-   * ```
+   * @deprecated Use GA Task Group instead
    */
   getRuns(
     taskGroupID: string,
@@ -153,121 +118,14 @@ export class TaskGroup extends APIResource {
   }
 }
 
-/**
- * Response object for a task group, including its status and metadata.
- */
-export interface TaskGroup {
-  /**
-   * Timestamp of the creation of the group, as an RFC 3339 string.
-   */
-  created_at: string | null;
-
-  /**
-   * Status of the group.
-   */
-  status: TaskGroupStatus;
-
-  /**
-   * ID of the group.
-   */
-  taskgroup_id: string;
-
-  /**
-   * User-provided metadata stored with the group.
-   */
-  metadata?: { [key: string]: string | number | boolean } | null;
-}
-
-/**
- * Response from adding new task runs to a task group.
- */
-export interface TaskGroupRunResponse {
-  /**
-   * Cursor for these runs in the event stream at
-   * taskgroup/events?last_event_id=<event_cursor>. Empty for the first runs in the
-   * group.
-   */
-  event_cursor: string | null;
-
-  /**
-   * Cursor for these runs in the run stream at
-   * taskgroup/runs?last_event_id=<run_cursor>. Empty for the first runs in the
-   * group.
-   */
-  run_cursor: string | null;
-
-  /**
-   * IDs of the newly created runs.
-   */
-  run_ids: Array<string>;
-
-  /**
-   * Status of the group.
-   */
-  status: TaskGroupStatus;
-}
-
-/**
- * Status of a task group.
- */
-export interface TaskGroupStatus {
-  /**
-   * True if at least one run in the group is currently active, i.e. status is one of
-   * {'cancelling', 'queued', 'running'}.
-   */
-  is_active: boolean;
-
-  /**
-   * Timestamp of the last status update to the group, as an RFC 3339 string.
-   */
-  modified_at: string | null;
-
-  /**
-   * Number of task runs in the group.
-   */
-  num_task_runs: number;
-
-  /**
-   * Human-readable status message for the group.
-   */
-  status_message: string | null;
-
-  /**
-   * Number of task runs with each status.
-   */
-  task_run_status_counts: { [key: string]: number };
-}
-
 /**
  * Event indicating an update to group status.
  */
 export type TaskGroupEventsResponse =
-  | TaskGroupEventsResponse.TaskGroupStatusEvent
+  | TaskGroupAPI.TaskGroupStatusEvent
   | TaskRunAPI.TaskRunEvent
   | TaskRunAPI.ErrorEvent;
 
-export namespace TaskGroupEventsResponse {
-  /**
-   * Event indicating an update to group status.
-   */
-  export interface TaskGroupStatusEvent {
-    /**
-     * Cursor to resume the event stream.
-     */
-    event_id: string;
-
-    /**
-     * Task group status object.
-     */
-    status: TaskGroupAPI.TaskGroupStatus;
-
-    /**
-     * Event type; always 'task_group_status'.
-     */
-    type: 'task_group_status';
-  }
-}
-
 /**
  * Event when a task run transitions to a non-active status.
  *
@@ -275,6 +133,12 @@ export namespace TaskGroupEventsResponse {
  */
 export type TaskGroupGetRunsResponse = TaskRunAPI.TaskRunEvent | TaskRunAPI.ErrorEvent;
 
+export type TaskGroupStatus = TaskGroupAPI.TaskGroupStatus;
+
+export type TaskGroupStatusEvent = TaskGroupAPI.TaskGroupStatusEvent;
+
+export type TaskGroupRunResponse = TaskGroupAPI.TaskGroupRunResponse;
+
 export interface TaskGroupCreateParams {
   /**
    * User-provided metadata stored with the task group.
@@ -337,14 +201,23 @@ export interface TaskGroupGetRunsParams {
 
 export declare namespace TaskGroup {
   export {
-    type TaskGroup as TaskGroup,
-    type TaskGroupRunResponse as TaskGroupRunResponse,
-    type TaskGroupStatus as TaskGroupStatus,
     type TaskGroupEventsResponse as TaskGroupEventsResponse,
     type TaskGroupGetRunsResponse as TaskGroupGetRunsResponse,
+    type TaskGroupStatus as TaskGroupStatus,
+    type TaskGroupStatusEvent as TaskGroupStatusEvent,
+    type TaskGroupRunResponse as TaskGroupRunResponse,
     type TaskGroupCreateParams as TaskGroupCreateParams,
     type TaskGroupAddRunsParams as TaskGroupAddRunsParams,
     type TaskGroupEventsParams as TaskGroupEventsParams,
     type TaskGroupGetRunsParams as TaskGroupGetRunsParams,
   };
 }
+
+// Backwards-compat namespace member (deprecated). `TaskGroupEventsResponse.TaskGroupStatusEvent`
+// was previously a nested interface; the type now lives at the file's top
+// level (re-exported from GA `TaskGroupAPI.TaskGroupStatusEvent`).
+type _TaskGroupStatusEvent = TaskGroupStatusEvent;
+export namespace TaskGroupEventsResponse {
+  /** @deprecated Use `Beta.TaskGroupStatusEvent` instead. */
+  export type TaskGroupStatusEvent = _TaskGroupStatusEvent;
+}

package/src/resources/beta/task-run.ts

@@ -14,7 +14,7 @@ import { path } from '../../internal/utils/path';
  * - Output metadata: citations, excerpts, reasoning, and confidence per field
  *
  * Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
- *  - Submit hundreds or thousands of Tasks as a single group
+ * - Submit hundreds or thousands of Tasks as a single group
  * - Observe group progress and receive results as they complete
  * - Real-time updates via Server-Sent Events (SSE)
  * - Add tasks to an existing group while it is running
@@ -104,81 +104,11 @@ export type ParallelBeta =
  * A progress update for a task run.
  */
 export type TaskRunEventsResponse =
-  | TaskRunEventsResponse.TaskRunProgressStatsEvent
-  | TaskRunEventsResponse.TaskRunProgressMessageEvent
+  | TaskRunAPI.TaskRunProgressStatsEvent
+  | TaskRunAPI.TaskRunProgressMessageEvent
   | TaskRunAPI.TaskRunEvent
   | TaskRunAPI.ErrorEvent;
 
-export namespace TaskRunEventsResponse {
-  /**
-   * A progress update for a task run.
-   */
-  export interface TaskRunProgressStatsEvent {
-    /**
-     * Completion percentage of the task run. Ranges from 0 to 100 where 0 indicates no
-     * progress and 100 indicates completion.
-     */
-    progress_meter: number;
-
-    /**
-     * Source stats describing progress so far.
-     */
-    source_stats: TaskRunProgressStatsEvent.SourceStats;
-
-    /**
-     * Event type; always 'task_run.progress_stats'.
-     */
-    type: 'task_run.progress_stats';
-  }
-
-  export namespace TaskRunProgressStatsEvent {
-    /**
-     * Source stats describing progress so far.
-     */
-    export interface SourceStats {
-      /**
-       * Number of sources considered in processing the task.
-       */
-      num_sources_considered: number | null;
-
-      /**
-       * Number of sources read in processing the task.
-       */
-      num_sources_read: number | null;
-
-      /**
-       * A sample of URLs of sources read in processing the task.
-       */
-      sources_read_sample: Array<string> | null;
-    }
-  }
-
-  /**
-   * A message for a task run progress update.
-   */
-  export interface TaskRunProgressMessageEvent {
-    /**
-     * Progress update message.
-     */
-    message: string;
-
-    /**
-     * Timestamp of the message.
-     */
-    timestamp: string | null;
-
-    /**
-     * Event type; always starts with 'task_run.progress_msg'.
-     */
-    type:
-      | 'task_run.progress_msg.plan'
-      | 'task_run.progress_msg.search'
-      | 'task_run.progress_msg.result'
-      | 'task_run.progress_msg.tool_call'
-      | 'task_run.progress_msg.exec_status';
-  }
-}
-
 /**
  * @deprecated Use parallel.types.task_run.TaskRunInput instead
  */
@@ -239,7 +169,7 @@ export interface TaskRunCreateParams {
   /**
    * Body param: Advanced search configuration for a task run.
    */
-  advanced_settings?: TaskRunCreateParams.AdvancedSettings | null;
+  advanced_settings?: TaskRunAPI.TaskAdvancedSettings | null;
 
   /**
    * Body param: Controls tracking of task run execution progress. When set to true,
@@ -295,18 +225,6 @@ export interface TaskRunCreateParams {
   betas?: Array<ParallelBeta>;
 }
 
-export namespace TaskRunCreateParams {
-  /**
-   * Advanced search configuration for a task run.
-   */
-  export interface AdvancedSettings {
-    /**
-     * ISO 3166-1 alpha-2 country code for geo-targeted search results.
-     */
-    location?: string | null;
-  }
-}
-
 export interface TaskRunResultParams {
   /**
    * Query param
@@ -334,3 +252,25 @@ export declare namespace TaskRun {
     type TaskRunResultParams as TaskRunResultParams,
   };
 }
+
+// Backwards-compat namespace members (deprecated). Previously these types
+// existed as nested interfaces under their parent's namespace; they've since
+// moved to top-level model types in the GA `task-run` module.
+type _TaskAdvancedSettings = TaskRunAPI.TaskAdvancedSettings;
+type _TaskRunProgressMessageEvent = TaskRunAPI.TaskRunProgressMessageEvent;
+type _TaskRunProgressStatsEvent = TaskRunAPI.TaskRunProgressStatsEvent;
+type _TaskRunSourceStats = TaskRunAPI.TaskRunSourceStats;
+export namespace TaskRunCreateParams {
+  /** @deprecated Use `Parallel.TaskAdvancedSettings` instead. */
+  export type AdvancedSettings = _TaskAdvancedSettings;
+}
+export namespace TaskRunEventsResponse {
+  /** @deprecated Use `Parallel.TaskRunProgressMessageEvent` instead. */
+  export type TaskRunProgressMessageEvent = _TaskRunProgressMessageEvent;
+  /** @deprecated Use `Parallel.TaskRunProgressStatsEvent` instead. */
+  export type TaskRunProgressStatsEvent = _TaskRunProgressStatsEvent;
+  export namespace TaskRunProgressStatsEvent {
+    /** @deprecated Use `Parallel.TaskRunSourceStats` instead. */
+    export type SourceStats = _TaskRunSourceStats;
+  }
+}

package/src/resources/index.ts

@@ -2,6 +2,43 @@
 
 export * from './shared';
 export { Beta } from './beta/beta';
+export {
+  MonitorResource,
+  type AdvancedMonitorSettings,
+  type CreateMonitorRequest,
+  type Monitor,
+  type MonitorCompletionEvent,
+  type MonitorErrorEvent,
+  type MonitorEventStreamEvent,
+  type MonitorEventStreamResponseSettings,
+  type MonitorEventStreamSettings,
+  type MonitorSnapshotEvent,
+  type MonitorSnapshotOutput,
+  type MonitorSnapshotResponseSettings,
+  type MonitorSnapshotSettings,
+  type MonitorWebhook,
+  type PaginatedMonitorEvents,
+  type PaginatedMonitorResponse,
+  type UpdateMonitorEventStreamSettings,
+  type UpdateMonitorRequest,
+  type MonitorCreateParams,
+  type MonitorUpdateParams,
+  type MonitorListParams,
+  type MonitorEventsParams,
+} from './monitor';
+export {
+  TaskGroup,
+  type TaskGroupRunResponse,
+  type TaskGroupStatus,
+  type TaskGroupStatusEvent,
+  type TaskGroupEventsResponse,
+  type TaskGroupGetRunsResponse,
+  type TaskGroupCreateParams,
+  type TaskGroupAddRunsParams,
+  type TaskGroupEventsParams,
+  type TaskGroupGetRunsParams,
+  type TaskGroupRetrieveRunParams,
+} from './task-group';
 export {
   TaskRun,
   type AutoSchema,
@@ -12,9 +49,13 @@ export {
   type McpServer,
   type McpToolCall,
   type RunInput,
+  type TaskAdvancedSettings,
   type TaskRunEvent,
   type TaskRunJsonOutput,
+  type TaskRunProgressMessageEvent,
+  type TaskRunProgressStatsEvent,
   type TaskRunResult,
+  type TaskRunSourceStats,
   type TaskRunTextOutput,
   type TaskSpec,
   type TextSchema,
@@ -31,6 +72,7 @@ export {
   type ExtractResponse,
   type ExtractResult,
   type FetchPolicy,
+  type FullContentSettings,
   type SearchResult,
   type UsageItem,
   type WebSearchResult,