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

parallel/_constants.py

@@ -5,6 +5,8 @@ import httpx
 RAW_RESPONSE_HEADER = "X-Stainless-Raw-Response"
 OVERRIDE_CAST_TO_HEADER = "____stainless_override_cast_to"
 
+# default timeout for execution requests which wait for results is 1 hour.
+DEFAULT_EXECUTE_TIMEOUT_SECONDS = 3600
 # default timeout for http requests is 10 minutes.
 DEFAULT_TIMEOUT_SECONDS = 600
 DEFAULT_TIMEOUT = httpx.Timeout(timeout=DEFAULT_TIMEOUT_SECONDS, connect=5.0)

parallel/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "parallel"
-__version__ = "0.1.2"  # x-release-please-version
+__version__ = "0.1.3"  # x-release-please-version

parallel/lib/_time.py

@@ -5,7 +5,7 @@ from typing import Union, Iterator, NoReturn
 import httpx
 
 from .._types import NotGiven
-from .._constants import DEFAULT_TIMEOUT_SECONDS
+from .._constants import DEFAULT_EXECUTE_TIMEOUT_SECONDS
 from .._exceptions import APIStatusError, APITimeoutError
 from .._utils._utils import is_given
 
@@ -19,7 +19,7 @@ def prepare_timeout_float(timeout: Union[float, httpx.Timeout, None, NotGiven])
         timeout = timeout.read
 
     if not is_given(timeout) or timeout is None:
-        return DEFAULT_TIMEOUT_SECONDS
+        return DEFAULT_EXECUTE_TIMEOUT_SECONDS
 
     return timeout
 

{parallel_web-0.1.2.dist-info → parallel_web-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: parallel-web
-Version: 0.1.2
+Version: 0.1.3
 Summary: The official Python library for the Parallel API
 Project-URL: Homepage, https://github.com/parallel-web/parallel-sdk-python
 Project-URL: Repository, https://github.com/parallel-web/parallel-sdk-python
@@ -42,7 +42,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on our [docs](https://docs.parallel.ai).
+The REST API documentation can be found in our [docs](https://docs.parallel.ai).
 The full API of this Python library can be found in [api.md](https://github.com/parallel-web/parallel-sdk-python/tree/main/api.md).
 
 ## Installation
@@ -69,7 +69,7 @@ run_result = client.task_run.execute(
     processor="core",
     output="GDP"
 )
-print(run_result.output)
+print(run_result.output.parsed)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -77,6 +77,11 @@ we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
 to add `PARALLEL_API_KEY="My API Key"` to your `.env` file
 so that your API Key is not stored in source control.
 
+The API also supports typed inputs and outputs via Pydantic objects. See the relevant
+section on [convenience methods](https://github.com/parallel-web/parallel-sdk-python/tree/main/#convenience-methods).
+
+For information on what tasks are and how to specify them, see [our docs](https://docs.parallel.ai/task-api/core-concepts/specify-a-task).
+
 ## Async usage
 
 Simply import `AsyncParallel` instead of `Parallel` and use `await` with each API call:
@@ -97,7 +102,7 @@ async def main() -> None:
         processor="core",
         output="GDP"
     )
-    print(run_result.output)
+    print(run_result.output.parsed)
 
 
 if __name__ == "__main__":
@@ -106,16 +111,17 @@ if __name__ == "__main__":
 
 To get the best performance out of Parallel's API, we recommend
 using the asynchronous client, especially for executing multiple Task Runs concurrently.
-Functionality between the synchronous and asynchronous clients is identical.
+Functionality between the synchronous and asynchronous clients is identical, including
+the convenience methods.
 
 ## Convenience methods
 
 ### Execute
 
-The `execute` method provides a single call which combines creating a task run,
-polling until it is completed, and parsing structured outputs (if specified).
+The `execute` method provides a single call that combines creating a task run,
+polling until completion, and parsing structured outputs (if specified).
 
-If an output type which inherits from `BaseModel` is
+If an output type that inherits from `BaseModel` is
 specified in the call to `.execute()`, the response content will be parsed into an
 instance of the provided output type. The parsed output can be accessed via the
 `parsed` property on the output field of the response.
@@ -146,15 +152,15 @@ async def main() -> None:
         processor="core",
         output="GDP"
     )
-    print(run_result.output)
+    print(run_result.output.parsed)
 
 
 if __name__ == "__main__":
     asyncio.run(main())
 ```
 
-The async client allows creating several task runs without blocking.
-To create multiple task runs in one go, call execute and then gather the results at the end.
+The async client lets you create multiple task runs without blocking.
+To submit several at once, call `execute()` and gather the results at the end.
 
 ```python
 import asyncio
@@ -212,9 +218,51 @@ if __name__ == "__main__":
     asyncio.run(main())
 ```
 
-## Low level API Access
+#### `execute()` vs `create()`
+
+The `execute` and `create` methods differ slightly in their signatures and
+behavior — `create` requires a Task Spec object that contains the output schema,
+while `execute` accepts an output schema as a top‑level parameter. `execute` is
+also a one‑shot method that combines creation, polling, and parsing for you.
+
+Use `create` when you want a run ID immediately and prefer to control polling
+yourself. `execute` is best for one‑shot task execution and for typed inputs and
+outputs — note that no outputs are available until the call finishes. Finally, for
+the output of `execute`, parsed content is available via `run_result.output.parsed`.
+
+Both `execute` and `create` validate inputs when appropriate input types are
+provided. For `execute`, validation happens when a pydantic input is provided. For
+`create`, validation occurs when the input schema is specified inside the task spec
+parameter. Additionally, in both calls, the un-parsed result content is accessible via
+the `run_result.output.content`.
+
+## Frequently Asked Questions
+
+**Does the Task API accept prompts or objectives?**
+
+No, there are no `objective` or `prompt` parameters that can be specified for calls to
+the Task API. Instead, provide any directives or instructions via the schemas. For
+more information, check [our docs](https://docs.parallel.ai/task-api/core-concepts/specify-a-task).
+
+**Can I access beta parameters or endpoints via the SDK?**
+
+The SDK currently does not support beta parameters in the Task API. You can consider
+using [custom requests](https://github.com/parallel-web/parallel-sdk-python/tree/main/#making-customundocumented-requests) in conjunction with
+[low level APIs](https://github.com/parallel-web/parallel-sdk-python/tree/main/#lowlevel-api-access).
+
+**Can I specify a timeout for API calls?**
+
+Yes, all methods support a timeout. For more information, see [Timeouts](https://github.com/parallel-web/parallel-sdk-python/tree/main/#timeouts).
+
+**Can I specify retries via the SDK?**
+
+Yes, errors can be retried via the SDK — the default retry count is 2. The maximum number
+of retries can be configured at the client level. For information on which errors
+are automatically retried and how to configure retry settings, see [Retries](https://github.com/parallel-web/parallel-sdk-python/tree/main/#retries).
+
+## Low‑level API access
 
-The library also provides access to the low level API for accessing the Parallel API.
+The library also provides low‑level access to the Parallel API.
 
 ```python
 from parallel import Parallel
@@ -262,13 +310,13 @@ task_run = client.task_run.create(
 )
 
 run_result = client.task_run.result(task_run.run_id)
-print(run_result.output)
+print(run_result.output.content)
 ```
 
 For more information, please check out the relevant section in our docs:
 
-- [Task Spec](https://docs.parallel.ai/core-concepts/task-spec)
-- [Task Runs](https://docs.parallel.ai/core-concepts/task-runs)
+- [Task Spec](https://docs.parallel.ai/task-api/core-concepts/specify-a-task)
+- [Task Runs](https://docs.parallel.ai/task-api/core-concepts/execute-task-run)
 
 ## Handling errors
 

{parallel_web-0.1.2.dist-info → parallel_web-0.1.3.dist-info}/RECORD

@@ -2,7 +2,7 @@ parallel/__init__.py,sha256=DLcZySDPIMWxygZrS91n0h7XUblDa7R2CKSqJCeBD-U,2587
 parallel/_base_client.py,sha256=CvhCKe_bvHxjG_KkjU7MN8epnRjDAoZercR16F7hKXo,65886
 parallel/_client.py,sha256=-33nTbpzQe0MaMSXkPisZdlPG_phXweSGfssI4UXIKQ,15024
 parallel/_compat.py,sha256=Bdw3skNpgAyCAWXJRUwTLiM0lOD1sLHEFKtw7peWp5U,6981
-parallel/_constants.py,sha256=NJrT2b4m0CuDGEVBF1xwsrHOWLGPupleFrL9jGAlLwk,567
+parallel/_constants.py,sha256=B00HbROOxQXqSFOIFQjSmdePfscyYNuXyY__j2qBljg,681
 parallel/_exceptions.py,sha256=lP7_D_HALN-Nt5bfw4AefEB7tYkrQ8ZcjCRdxm_HrsQ,3224
 parallel/_files.py,sha256=mf4dOgL4b0ryyZlbqLhggD3GVgDf6XxdGFAgce01ugE,3549
 parallel/_models.py,sha256=G1vczEodX0vUySeVKbF-mbzlaObNL1oVAYH4c65agRk,29131
@@ -11,7 +11,7 @@ parallel/_resource.py,sha256=QvY8l_r03hNBsFTTn3g7Pkx8OrDwIwROHaSEViWcYLA,1112
 parallel/_response.py,sha256=zJKnQ9YzrMZCTPWis4CdyGCAH0kzT4m1OHE74jiF0jA,28800
 parallel/_streaming.py,sha256=vH45vK3-83ruFalbvSgpE70zfwy8fjW9UwrO1TwjIfE,10108
 parallel/_types.py,sha256=gdnumvz_C0ka1W865rehBsLCOgZyyHpKRedjJg7uRPY,6199
-parallel/_version.py,sha256=WUXkK8O3I2gOafOqu7g-L_9WsH2ZQxqi0tbVT_oXd8k,160
+parallel/_version.py,sha256=KMXAJ_Bhy6F94HtkIbgFS_dFgeIsvbC6RKi-WdhkV28,160
 parallel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 parallel/_utils/__init__.py,sha256=Z5F2puD-cRsBEwlAuuuXDuIuKuJyLhtg0667MRHeBj4,2084
 parallel/_utils/_logs.py,sha256=5tqZJRHHRqxJfftED6vN1CHcwhRZDSvzy9SaxozEAe4,780
@@ -26,7 +26,7 @@ parallel/_utils/_utils.py,sha256=nJWF6GJgM2imb1AYa1nZoE1f-Alo1EI0Y8L_q3a1gkw,123
 parallel/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 parallel/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 parallel/lib/_pydantic.py,sha256=B_-msp3_jrPP09s-f73Xv4WEG212ECDfc0a_Gf-YZGE,1115
-parallel/lib/_time.py,sha256=SAf1AP__EqprIPCqpe8JqfaB_rqv10uzhNBJbD_THSY,2542
+parallel/lib/_time.py,sha256=54M_YhwW8WUa2KEUjYNdt3GkyQC9s_3u36-IH5hZr2U,2558
 parallel/lib/_parsing/__init__.py,sha256=aEM9F2sU4s-CFpQgjydjfCAdxpusJ81jXI6KCoB8VPs,150
 parallel/lib/_parsing/_task_run_result.py,sha256=9o95RcH4bX0UbI7ow5bnECrXMS6Ll0SEQR4leTK3VQU,3608
 parallel/lib/_parsing/_task_spec.py,sha256=XkNWo2Ovu-anld8PAOIsi722vOXbDf2ex4p9rwWW51I,3067
@@ -41,7 +41,7 @@ parallel/types/task_run_result.py,sha256=yd3Lz_YzCQGe5ynK5iI6J17tAs5nSG7FUJ3fSLO
 parallel/types/task_run_result_params.py,sha256=tL4CK5c0-Wo21O1pmT4pDvwzG-svtEwYujyCp0ZgATs,360
 parallel/types/task_spec_param.py,sha256=qTENHBp7vRg-VDzK8HsLpTn3EJWIV0UVQaf45r9SfCs,1179
 parallel/types/text_schema_param.py,sha256=M9WEl2aOh4_hNSdGm2BOmtm1VGqxxTh3f-Hs4OB4aCQ,445
-parallel_web-0.1.2.dist-info/METADATA,sha256=f0gLsNP4XHVGgWeL88tVMkLzsd_Yw4e0I9as2DR5o0Y,17626
-parallel_web-0.1.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-parallel_web-0.1.2.dist-info/licenses/LICENSE,sha256=1rFsV0HhxaZBP55JM8Cu2w0Bw-uxTFtyTja_DE94oEM,1048
-parallel_web-0.1.2.dist-info/RECORD,,
+parallel_web-0.1.3.dist-info/METADATA,sha256=fuS5BSxEaWrVTBlSb0OCUkUIgxCVP13QEqpqc9YR2TM,20379
+parallel_web-0.1.3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+parallel_web-0.1.3.dist-info/licenses/LICENSE,sha256=1rFsV0HhxaZBP55JM8Cu2w0Bw-uxTFtyTja_DE94oEM,1048
+parallel_web-0.1.3.dist-info/RECORD,,