parallel-web 0.5.0 → 1.0.0

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

@@ -1,276 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../core/resource';
-import * as Shared from '../shared';
-import * as TaskRunAPI from '../task-run';
-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';
-
-/**
- * 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
- *
- * 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 Run instead
- */
-export class TaskRun extends APIResource {
-  /**
-   * Initiates a task run.
-   *
-   * Returns immediately with a run object in status 'queued'.
-   *
-   * Beta features can be enabled by setting the 'parallel-beta' header.
-   *
-   * @deprecated Use GA Task Run instead
-   */
-  create(params: TaskRunCreateParams, options?: RequestOptions): APIPromise<TaskRunAPI.TaskRun> {
-    const { betas, ...body } = params;
-    return this._client.post('/v1/tasks/runs', {
-      body,
-      ...options,
-      headers: buildHeaders([
-        { 'parallel-beta': [...(betas ?? []), 'search-extract-2025-10-10'].toString() },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Streams events for a task run.
-   *
-   * Returns a stream of events showing progress updates and state changes for the
-   * task run.
-   *
-   * For task runs that did not have enable_events set to true during creation, the
-   * frequency of events will be reduced.
-   *
-   * @deprecated Use GA Task Run instead
-   */
-  events(runID: string, options?: RequestOptions): APIPromise<Stream<TaskRunEventsResponse>> {
-    return this._client.get(path`/v1beta/tasks/runs/${runID}/events`, {
-      ...options,
-      headers: buildHeaders([
-        { 'parallel-beta': 'search-extract-2025-10-10', Accept: 'text/event-stream' },
-        options?.headers,
-      ]),
-      stream: true,
-    }) as APIPromise<Stream<TaskRunEventsResponse>>;
-  }
-
-  /**
-   * Retrieves a run result by run_id, blocking until the run is completed.
-   *
-   * @deprecated Use GA Task Run instead
-   */
-  result(
-    runID: string,
-    params: TaskRunResultParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<TaskRunAPI.TaskRunResult> {
-    const { betas, ...query } = params ?? {};
-    return this._client.get(path`/v1/tasks/runs/${runID}/result`, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        { 'parallel-beta': [...(betas ?? []), 'search-extract-2025-10-10'].toString() },
-        options?.headers,
-      ]),
-    });
-  }
-}
-
-/**
- * Model for the parallel-beta header.
- */
-export type ParallelBeta =
-  | 'mcp-server-2025-07-17'
-  | 'events-sse-2025-07-24'
-  | 'webhook-2025-08-12'
-  | 'findall-2025-09-15'
-  | 'search-extract-2025-10-10'
-  | 'field-basis-2025-11-25'
-  | (string & {});
-
-/**
- * A progress update for a task run.
- */
-export type TaskRunEventsResponse =
-  | TaskRunAPI.TaskRunProgressStatsEvent
-  | TaskRunAPI.TaskRunProgressMessageEvent
-  | TaskRunAPI.TaskRunEvent
-  | TaskRunAPI.ErrorEvent;
-
-/**
- * @deprecated Use parallel.types.task_run.TaskRunInput instead
- */
-export type BetaRunInput = TaskRunAPI.RunInput;
-
-/**
- * @deprecated Use parallel.types.task_run.TaskRunResult instead
- */
-export type BetaTaskRunResult = TaskRunAPI.TaskRunResult;
-
-/**
- * Backwards-compatible namespace for `BetaTaskRunResult`.
- * @deprecated Use `TaskRunJsonOutput` and `TaskRunTextOutput` from `task-run` instead.
- */
-export namespace BetaTaskRunResult {
-  /** @deprecated Use `TaskRunAPI.TaskRunTextOutput` instead */
-  export type BetaTaskRunTextOutput = TaskRunAPI.TaskRunTextOutput;
-  /** @deprecated Use `TaskRunAPI.TaskRunJsonOutput` instead */
-  export type BetaTaskRunJsonOutput = TaskRunAPI.TaskRunJsonOutput;
-}
-
-/**
- * @deprecated Use parallel.types.task_run.Webhook instead
- */
-export type Webhook = TaskRunAPI.Webhook;
-
-/**
- * @deprecated Use parallel.types.task_run.McpServer instead
- */
-export type McpServer = TaskRunAPI.McpServer;
-
-/**
- * @deprecated Use parallel.types.task_run.McpToolCall instead
- */
-export type McpToolCall = TaskRunAPI.McpToolCall;
-
-/**
- * @deprecated Use parallel.types.task_run.TaskRunEvent instead
- */
-export type TaskRunEvent = TaskRunAPI.TaskRunEvent;
-
-/**
- * @deprecated Use parallel.types.task_run.ErrorEvent instead
- */
-export type ErrorEvent = TaskRunAPI.ErrorEvent;
-
-export interface TaskRunCreateParams {
-  /**
-   * Body param: Input to the task, either text or a JSON object.
-   */
-  input: string | { [key: string]: unknown };
-
-  /**
-   * Body param: Processor to use for the task.
-   */
-  processor: string;
-
-  /**
-   * Body param: Advanced search configuration for a task run.
-   */
-  advanced_settings?: TaskRunAPI.TaskAdvancedSettings | null;
-
-  /**
-   * Body param: Controls tracking of task run execution progress. When set to true,
-   * progress events are recorded and can be accessed via the
-   * [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false,
-   * no progress events are tracked. Note that progress tracking cannot be enabled
-   * after a run has been created. The flag is set to true by default for premium
-   * processors (pro and above).
-   */
-  enable_events?: boolean | null;
-
-  /**
-   * Body param: Optional list of MCP servers to use for the run.
-   */
-  mcp_servers?: Array<TaskRunAPI.McpServer> | null;
-
-  /**
-   * Body param: User-provided metadata stored with the run. Keys and values must be
-   * strings with a maximum length of 16 and 512 characters respectively.
-   */
-  metadata?: { [key: string]: string | number | boolean } | null;
-
-  /**
-   * Body param: Interaction ID to use as context for this request.
-   */
-  previous_interaction_id?: string | null;
-
-  /**
-   * Body param: Source policy for web search results.
-   *
-   * This policy governs which sources are allowed/disallowed in results.
-   */
-  source_policy?: Shared.SourcePolicy | null;
-
-  /**
-   * Body param: Specification for a task.
-   *
-   * Auto output schemas can be specified by setting `output_schema={"type":"auto"}`.
-   * Not specifying a TaskSpec is the same as setting an auto output schema.
-   *
-   * For convenience bare strings are also accepted as input or output schemas.
-   */
-  task_spec?: TaskRunAPI.TaskSpec | null;
-
-  /**
-   * Body param: Webhooks for Task Runs.
-   */
-  webhook?: TaskRunAPI.Webhook | null;
-
-  /**
-   * Header param: Optional header to specify the beta version(s) to enable.
-   */
-  betas?: Array<ParallelBeta>;
-}
-
-export interface TaskRunResultParams {
-  /**
-   * Query param
-   */
-  timeout?: number;
-
-  /**
-   * Header param: Optional header to specify the beta version(s) to enable.
-   */
-  betas?: Array<ParallelBeta>;
-}
-
-export declare namespace TaskRun {
-  export {
-    type ParallelBeta as ParallelBeta,
-    type TaskRunEventsResponse as TaskRunEventsResponse,
-    type BetaRunInput as BetaRunInput,
-    type BetaTaskRunResult as BetaTaskRunResult,
-    type Webhook as Webhook,
-    type McpServer as McpServer,
-    type McpToolCall as McpToolCall,
-    type TaskRunEvent as TaskRunEvent,
-    type ErrorEvent as ErrorEvent,
-    type TaskRunCreateParams as TaskRunCreateParams,
-    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;
-  }
-}