api.md

Shared Types

from parallel.types import ErrorObject, ErrorResponse, SourcePolicy, Warning

Parallel

Types:

from parallel.types import (
    AdvancedExtractSettings,
    AdvancedSearchSettings,
    ExcerptSettings,
    ExtractError,
    ExtractResponse,
    ExtractResult,
    FetchPolicy,
    FullContentSettings,
    SearchResult,
    UsageItem,
    WebSearchResult,
)

Methods:

• client.extract(**params) -> ExtractResponse
• client.search(**params) -> SearchResult

TaskRun

Types:

from parallel.types import (
    AutoSchema,
    Citation,
    FieldBasis,
    JsonSchema,
    ParsedTaskRunResult,
    RunInput,
    TaskAdvancedSettings,
    TaskRun,
    TaskRunJsonOutput,
    TaskRunProgressMessageEvent,
    TaskRunProgressStatsEvent,
    TaskRunResult,
    TaskRunSourceStats,
    TaskRunTextOutput,
    TaskSpec,
    TextSchema,
)

Methods:

• client.task_run.create(**params) -> TaskRun
• client.task_run.retrieve(run_id) -> TaskRun
• client.task_run.result(run_id, **params) -> TaskRunResult
• client.task_run.retrieve_input(run_id) -> RunInput

Convenience methods:

• client.task_run.execute(input, processor, output: OutputSchema) -> TaskRunResult
• client.task_run.execute(input, processor, output: Type[OutputT]) -> ParsedTaskRunResult[OutputT]

TaskGroup

Types:

from parallel.types import (
    TaskGroup,
    TaskGroupRunResponse,
    TaskGroupStatus,
    TaskGroupStatusEvent,
    TaskGroupEventsResponse,
    TaskGroupGetRunsResponse,
)

Methods:

• client.task_group.create(**params) -> TaskGroup
• client.task_group.retrieve(task_group_id) -> TaskGroup
• client.task_group.add_runs(task_group_id, **params) -> TaskGroupRunResponse
• client.task_group.events(task_group_id, **params) -> TaskGroupEventsResponse
• client.task_group.get_runs(task_group_id, **params) -> TaskGroupGetRunsResponse
• client.task_group.retrieve_run(run_id, *, task_group_id) -> TaskRun

Monitor

Types:

from parallel.types import (
    AdvancedMonitorSettings,
    CreateMonitorRequest,
    Monitor,
    MonitorCompletionEvent,
    MonitorErrorEvent,
    MonitorEventStreamEvent,
    MonitorEventStreamResponseSettings,
    MonitorEventStreamSettings,
    MonitorSnapshotEvent,
    MonitorSnapshotOutput,
    MonitorSnapshotResponseSettings,
    MonitorSnapshotSettings,
    MonitorWebhook,
    PaginatedMonitorEvents,
    PaginatedMonitorResponse,
    UpdateMonitorEventStreamSettings,
    UpdateMonitorRequest,
)

Methods:

• client.monitor.create(**params) -> Monitor
• client.monitor.retrieve(monitor_id) -> Monitor
• client.monitor.update(monitor_id, **params) -> Monitor
• client.monitor.list(**params) -> PaginatedMonitorResponse
• client.monitor.cancel(monitor_id) -> Monitor
• client.monitor.events(monitor_id, **params) -> PaginatedMonitorEvents
• client.monitor.trigger(monitor_id) -> None

Beta