parallel-web 0.1.3__py3-none-any.whl → 0.2.0__py3-none-any.whl

parallel/types/shared_params/source_policy.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypedDict
+
+__all__ = ["SourcePolicy"]
+
+
+class SourcePolicy(TypedDict, total=False):
+    exclude_domains: List[str]
+    """List of domains to exclude from results.
+
+    If specified, sources from these domains will be excluded.
+    """
+
+    include_domains: List[str]
+    """List of domains to restrict the results to.
+
+    If specified, only sources from these domains will be included.
+    """

parallel/types/task_run.py

@@ -3,23 +3,16 @@
 from typing import Dict, List, Union, Optional
 from typing_extensions import Literal
 
-from .._models import BaseModel
-
-__all__ = ["TaskRun", "Warning"]
-
-
-class Warning(BaseModel):
-    message: str
-    """Human-readable message."""
-
-    type: str
-    """Type of warning.
+from pydantic import Field as FieldInfo
 
-    Note that adding new warning types is considered a backward-compatible change.
-    """
+from .._models import BaseModel
+from .shared.warning import Warning
+from .shared.error_object import ErrorObject
 
-    detail: Optional[object] = None
-    """Optional detail supporting the warning."""
+__all__ = [
+    "TaskRun",
+    "Warning",  # for backwards compatibility with v0.1.3
+]
 
 
 class TaskRun(BaseModel):
@@ -27,9 +20,9 @@ class TaskRun(BaseModel):
     """Timestamp of the creation of the task, as an RFC 3339 string."""
 
     is_active: bool
-    """Whether the run is currently active; i.e.
+    """Whether the run is currently active, i.e.
 
-    status is one of {'running', 'queued', 'cancelling'}.
+    status is one of {'cancelling', 'queued', 'running'}.
     """
 
     modified_at: Optional[str] = None
@@ -44,8 +37,14 @@ class TaskRun(BaseModel):
     status: Literal["queued", "action_required", "running", "completed", "failed", "cancelling", "cancelled"]
     """Status of the run."""
 
+    error: Optional[ErrorObject] = None
+    """An error message."""
+
     metadata: Optional[Dict[str, Union[str, float, bool]]] = None
     """User-provided metadata stored with the run."""
 
+    task_group_id: Optional[str] = FieldInfo(alias="taskgroup_id", default=None)
+    """ID of the taskgroup to which the run belongs."""
+
     warnings: Optional[List[Warning]] = None
-    """Warnings for the run."""
+    """Warnings for the run, if any."""

parallel/types/task_run_create_params.py

@@ -6,12 +6,13 @@ from typing import Dict, Union, Optional
 from typing_extensions import Required, TypedDict
 
 from .task_spec_param import TaskSpecParam
+from .shared_params.source_policy import SourcePolicy
 
 __all__ = ["TaskRunCreateParams"]
 
 
 class TaskRunCreateParams(TypedDict, total=False):
-    input: Required[Union[str, object]]
+    input: Required[Union[str, Dict[str, object]]]
     """Input to the task, either text or a JSON object."""
 
     processor: Required[str]
@@ -24,9 +25,17 @@ class TaskRunCreateParams(TypedDict, total=False):
     respectively.
     """
 
+    source_policy: Optional[SourcePolicy]
+    """Source policy for web search results.
+
+    This policy governs which sources are allowed/disallowed in results.
+    """
+
     task_spec: Optional[TaskSpecParam]
     """Specification for a task.
 
-    For convenience we allow bare strings as input or output schemas, which is
-    equivalent to a text schema with the same description.
+    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.
     """

parallel/types/task_run_json_output.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .field_basis import FieldBasis
+
+__all__ = ["TaskRunJsonOutput"]
+
+
+class TaskRunJsonOutput(BaseModel):
+    basis: List[FieldBasis]
+    """Basis for each top-level field in the JSON output."""
+
+    content: Dict[str, object]
+    """
+    Output from the task as a native JSON object, as determined by the output schema
+    of the task spec.
+    """
+
+    type: Literal["json"]
+    """
+    The type of output being returned, as determined by the output schema of the
+    task spec.
+    """
+
+    beta_fields: Optional[Dict[str, object]] = None
+    """Additional fields from beta features used in this task run.
+
+    When beta features are specified during both task run creation and result
+    retrieval, this field will be empty and instead the relevant beta attributes
+    will be directly included in the `BetaTaskRunJsonOutput` or corresponding output
+    type. However, if beta features were specified during task run creation but not
+    during result retrieval, this field will contain the dump of fields from those
+    beta features. Each key represents the beta feature version (one amongst
+    parallel-beta headers) and the values correspond to the beta feature attributes,
+    if any. For now, only MCP server beta features have attributes. For example,
+    `{mcp-server-2025-07-17: [{'server_name':'mcp_server', 'tool_call_id': 'tc_123', ...}]}}`
+    """
+
+    output_schema: Optional[Dict[str, object]] = None
+    """Output schema for the Task Run.
+
+    Populated only if the task was executed with an auto schema.
+    """

parallel/types/task_run_result.py

@@ -1,117 +1,47 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Union, Optional
-from typing_extensions import Literal, TypeAlias
+from typing import Union
+from typing_extensions import Annotated, TypeAlias
 
+from .._utils import PropertyInfo
 from .._models import BaseModel
+from .citation import Citation
 from .task_run import TaskRun
+from .field_basis import FieldBasis
+from .task_run_json_output import TaskRunJsonOutput
+from .task_run_text_output import TaskRunTextOutput
 
 __all__ = [
     "TaskRunResult",
     "Output",
-    "OutputTaskRunTextOutput",
-    "OutputTaskRunTextOutputBasis",
-    "OutputTaskRunTextOutputBasisCitation",
     "OutputTaskRunJsonOutput",
     "OutputTaskRunJsonOutputBasis",
     "OutputTaskRunJsonOutputBasisCitation",
+    "OutputTaskRunTextOutput",
+    "OutputTaskRunTextOutputBasis",
+    "OutputTaskRunTextOutputBasisCitation",
 ]
 
+OutputTaskRunJsonOutput = TaskRunJsonOutput  # for backwards compatibility with v0.1.3
+"""This is deprecated, `TaskRunJsonOutput` should be used instead"""
 
-class OutputTaskRunTextOutputBasisCitation(BaseModel):
-    url: str
-    """URL of the citation."""
-
-    excerpts: Optional[List[str]] = None
-    """Excerpts from the citation supporting the output.
-
-    Only certain processors provide excerpts.
-    """
-
-    title: Optional[str] = None
-    """Title of the citation."""
-
-
-class OutputTaskRunTextOutputBasis(BaseModel):
-    field: str
-    """Name of the output field."""
-
-    reasoning: str
-    """Reasoning for the output field."""
-
-    citations: Optional[List[OutputTaskRunTextOutputBasisCitation]] = None
-    """List of citations supporting the output field."""
-
-    confidence: Optional[str] = None
-    """Confidence level for the output field.
-
-    Only certain processors provide confidence levels.
-    """
-
-
-class OutputTaskRunTextOutput(BaseModel):
-    basis: List[OutputTaskRunTextOutputBasis]
-    """Basis for the output. The basis has a single field 'output'."""
-
-    content: str
-    """Text output from the task."""
-
-    type: Literal["text"]
-    """
-    The type of output being returned, as determined by the output schema of the
-    task spec.
-    """
-
-
-class OutputTaskRunJsonOutputBasisCitation(BaseModel):
-    url: str
-    """URL of the citation."""
-
-    excerpts: Optional[List[str]] = None
-    """Excerpts from the citation supporting the output.
-
-    Only certain processors provide excerpts.
-    """
-
-    title: Optional[str] = None
-    """Title of the citation."""
-
-
-class OutputTaskRunJsonOutputBasis(BaseModel):
-    field: str
-    """Name of the output field."""
-
-    reasoning: str
-    """Reasoning for the output field."""
-
-    citations: Optional[List[OutputTaskRunJsonOutputBasisCitation]] = None
-    """List of citations supporting the output field."""
-
-    confidence: Optional[str] = None
-    """Confidence level for the output field.
-
-    Only certain processors provide confidence levels.
-    """
+OutputTaskRunJsonOutputBasis = FieldBasis  # for backwards compatibility with v0.1.3
+"""This is deprecated, `FieldBasis` should be used instead"""
 
+OutputTaskRunJsonOutputBasisCitation = Citation  # for backwards compatibility with v0.1.3
+"""This is deprecated, `Citation` should be used instead"""
 
-class OutputTaskRunJsonOutput(BaseModel):
-    basis: List[OutputTaskRunJsonOutputBasis]
-    """Basis for each top-level field in the JSON output."""
+OutputTaskRunTextOutput = TaskRunTextOutput  # for backwards compatibility with v0.1.3
+"""This is deprecated, `TaskRunTextOutput` should be used instead"""
 
-    content: object
-    """
-    Output from the task as a native JSON object, as determined by the output schema
-    of the task spec.
-    """
+OutputTaskRunTextOutputBasis = FieldBasis  # for backwards compatibility with v0.1.3
+"""This is deprecated, `FieldBasis` should be used instead"""
 
-    type: Literal["json"]
-    """
-    The type of output being returned, as determined by the output schema of the
-    task spec.
-    """
+OutputTaskRunTextOutputBasisCitation = Citation  # for backwards compatibility with v0.1.3
+"""This is deprecated, `Citation` should be used instead"""
 
 
-Output: TypeAlias = Union[OutputTaskRunTextOutput, OutputTaskRunJsonOutput]
+Output: TypeAlias = Annotated[Union[TaskRunTextOutput, TaskRunJsonOutput], PropertyInfo(discriminator="type")]
 
 
 class TaskRunResult(BaseModel):
@@ -119,4 +49,4 @@ class TaskRunResult(BaseModel):
     """Output from the task conforming to the output schema."""
 
     run: TaskRun
-    """Status of a task."""
+    """Status of a task run."""

parallel/types/task_run_text_output.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .field_basis import FieldBasis
+
+__all__ = ["TaskRunTextOutput"]
+
+
+class TaskRunTextOutput(BaseModel):
+    basis: List[FieldBasis]
+    """Basis for the output. The basis has a single field 'output'."""
+
+    content: str
+    """Text output from the task."""
+
+    type: Literal["text"]
+    """
+    The type of output being returned, as determined by the output schema of the
+    task spec.
+    """
+
+    beta_fields: Optional[Dict[str, object]] = None
+    """Additional fields from beta features used in this task run.
+
+    When beta features are specified during both task run creation and result
+    retrieval, this field will be empty and instead the relevant beta attributes
+    will be directly included in the `BetaTaskRunJsonOutput` or corresponding output
+    type. However, if beta features were specified during task run creation but not
+    during result retrieval, this field will contain the dump of fields from those
+    beta features. Each key represents the beta feature version (one amongst
+    parallel-beta headers) and the values correspond to the beta feature attributes,
+    if any. For now, only MCP server beta features have attributes. For example,
+    `{mcp-server-2025-07-17: [{'server_name':'mcp_server', 'tool_call_id': 'tc_123', ...}]}}`
+    """

parallel/types/task_spec.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union, Optional
+from typing_extensions import TypeAlias
+
+from .._models import BaseModel
+from .auto_schema import AutoSchema
+from .json_schema import JsonSchema
+from .text_schema import TextSchema
+
+__all__ = ["TaskSpec", "OutputSchema", "InputSchema"]
+
+OutputSchema: TypeAlias = Union[JsonSchema, TextSchema, AutoSchema, str]
+
+InputSchema: TypeAlias = Union[str, JsonSchema, TextSchema, None]
+
+
+class TaskSpec(BaseModel):
+    output_schema: OutputSchema
+    """JSON schema or text fully describing the desired output from the task.
+
+    Descriptions of output fields will determine the form and content of the
+    response. A bare string is equivalent to a text schema with the same
+    description.
+    """
+
+    input_schema: Optional[InputSchema] = None
+    """Optional JSON schema or text description of expected input to the task.
+
+    A bare string is equivalent to a text schema with the same description.
+    """

parallel/types/task_spec_param.py

@@ -7,14 +7,15 @@ from typing_extensions import TypeVar, Required, TypeAlias, TypedDict, NotRequir
 
 from pydantic import BaseModel
 
+from .auto_schema_param import AutoSchemaParam
 from .json_schema_param import JsonSchemaParam
 from .text_schema_param import TextSchemaParam
 
 __all__ = ["TaskSpecParam", "OutputSchema", "InputSchema"]
 
-OutputSchema: TypeAlias = Union[JsonSchemaParam, TextSchemaParam, str]
+OutputSchema: TypeAlias = Union[JsonSchemaParam, TextSchemaParam, AutoSchemaParam, str]
 
-InputSchema: TypeAlias = Union[JsonSchemaParam, TextSchemaParam, str]
+InputSchema: TypeAlias = Union[str, JsonSchemaParam, TextSchemaParam]
 
 OutputT = TypeVar("OutputT", bound=BaseModel)
 

parallel/types/text_schema.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["TextSchema"]
+
+
+class TextSchema(BaseModel):
+    description: str
+    """A text description of the desired output from the task."""
+
+    type: Optional[Literal["text"]] = None
+    """The type of schema being defined. Always `text`."""