arkruntime 0.1.0__tar.gz

arkruntime-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

arkruntime-0.1.0/PKG-INFO

@@ -0,0 +1,347 @@
+Metadata-Version: 2.4
+Name: arkruntime
+Version: 0.1.0
+Summary: Ark runtime SDK for Python
+Author: Volcengine
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/volcengine/ark-runtime-python
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: anyio<5,>=3.5.0
+Requires-Dist: sniffio
+Requires-Dist: typing-extensions>=4.7
+Requires-Dist: distro>=1.7.0
+Requires-Dist: volcengine-python-sdk>=5.0.20
+Dynamic: license-file
+
+# Ark Runtime Python SDK
+
+The official Python library for the Volcengine Ark runtime API. It provides convenient access to the Ark REST API from any Python 3.8+ application, with both synchronous and asynchronous clients.
+
+## Installation
+
+```bash
+pip install arkruntime
+```
+
+## Usage
+
+Create a client by setting the `ARK_API_KEY` environment variable:
+
+```python
+from arkruntime import Ark
+
+client = Ark()
+# or explicitly: Ark(api_key="your-api-key")
+```
+
+### Responses API
+
+```python
+import os
+from arkruntime import Ark
+
+client = Ark()
+
+response = client.responses.create(
+    model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+    input="Explain how large language models work in three sentences.",
+)
+print(response.output_text)
+```
+
+### Chat Completions
+
+```python
+import os
+from arkruntime import Ark
+
+client = Ark()
+
+completion = client.chat.completions.create(
+    model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Write a haiku about programming."},
+    ],
+)
+print(completion.choices[0].message.content)
+```
+
+## Streaming
+
+Both the Responses and Chat Completions APIs support streaming via `stream=True`.
+
+### Streaming responses
+
+```python
+import os
+from arkruntime import Ark
+
+client = Ark()
+
+stream = client.responses.create(
+    model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+    input="Count from 1 to 10 slowly.",
+    stream=True,
+)
+for event in stream:
+    print(event)
+```
+
+### Streaming chat completions
+
+```python
+import os
+from arkruntime import Ark
+
+client = Ark()
+
+stream = client.chat.completions.create(
+    model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+    messages=[{"role": "user", "content": "Count from 1 to 10 slowly."}],
+    stream=True,
+)
+for chunk in stream:
+    if chunk.choices[0].delta.content:
+        print(chunk.choices[0].delta.content, end="", flush=True)
+```
+
+## Async usage
+
+Every synchronous method has an async counterpart on `AsyncArk`.
+
+```python
+import asyncio
+import os
+from arkruntime import AsyncArk
+
+client = AsyncArk()
+
+async def main():
+    response = await client.responses.create(
+        model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+        input="Explain quantum computing briefly.",
+    )
+    print(response.output_text)
+
+asyncio.run(main())
+```
+
+## Vision
+
+Pass images alongside text using multimodal content blocks.
+
+```python
+import os
+from arkruntime import Ark
+
+client = Ark()
+
+completion = client.chat.completions.create(
+    model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+    messages=[
+        {
+            "role": "user",
+            "content": [
+                {"type": "text", "text": "What is in this image?"},
+                {"type": "image_url", "image_url": {"url": "https://example.com/photo.jpg"}},
+            ],
+        }
+    ],
+)
+print(completion.choices[0].message.content)
+```
+
+## Function calling
+
+```python
+import json
+import os
+from arkruntime import Ark
+
+client = Ark()
+
+tools = [
+    {
+        "type": "function",
+        "function": {
+            "name": "get_weather",
+            "description": "Get the current weather for a location.",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "location": {"type": "string", "description": "City name"},
+                },
+                "required": ["location"],
+            },
+        },
+    }
+]
+
+completion = client.chat.completions.create(
+    model=os.environ.get("ARK_MODEL", "doubao-seed-2-1-pro-260628"),
+    messages=[{"role": "user", "content": "What is the weather in Beijing?"}],
+    tools=tools,
+)
+
+tool_call = completion.choices[0].message.tool_calls[0]
+print(f"Function: {tool_call.function.name}")
+print(f"Arguments: {tool_call.function.arguments}")
+```
+
+## File uploads
+
+```python
+from arkruntime import Ark
+
+client = Ark()
+
+# Upload a file
+file = client.files.create(file=open("data.jsonl", "rb"), purpose="batch")
+print(file.id)
+
+# List files
+for f in client.files.list():
+    print(f.id, f.filename)
+
+# Delete a file
+client.files.delete(file.id)
+```
+
+## Error handling
+
+The SDK raises typed exceptions for API errors.
+
+```python
+from arkruntime import Ark
+from arkruntime._exceptions import ArkAPIError, ArkRateLimitError, ArkAuthenticationError
+
+client = Ark()
+
+try:
+    client.chat.completions.create(
+        model="doubao-seed-2-1-pro-260628",
+        messages=[{"role": "user", "content": "Hello"}],
+    )
+except ArkRateLimitError:
+    print("Rate limited — back off and retry.")
+except ArkAuthenticationError:
+    print("Invalid API key.")
+except ArkAPIError as e:
+    print(f"API error {e.status_code}: {e}")
+```
+
+The exception hierarchy:
+
+```
+ArkError
+ +-- ArkAPIError
+      +-- ArkAPIStatusError
+      |    +-- ArkBadRequestError          (400)
+      |    +-- ArkAuthenticationError       (401)
+      |    +-- ArkPermissionDeniedError     (403)
+      |    +-- ArkNotFoundError             (404)
+      |    +-- ArkConflictError             (409)
+      |    +-- ArkUnprocessableEntityError  (422)
+      |    +-- ArkRateLimitError            (429)
+      |    +-- ArkInternalServerError       (500)
+      +-- ArkAPIConnectionError
+      |    +-- ArkAPITimeoutError
+      +-- ArkAPIResponseValidationError
+```
+
+## Retries and timeouts
+
+The client automatically retries failed requests (default: 2 retries) with backoff for transient errors.
+
+```python
+from arkruntime import Ark
+
+# Customize retries and timeout
+client = Ark(
+    max_retries=5,
+    timeout=120.0,  # seconds
+)
+```
+
+Per-request overrides are also supported:
+
+```python
+client.chat.completions.create(
+    model="doubao-seed-2-1-pro-260628",
+    messages=[{"role": "user", "content": "Hello"}],
+    timeout=30.0,
+)
+```
+
+## Batch inference
+
+`client.batch.*` provides a synchronous high-throughput path with per-model concurrency control and automatic retry on `408`/`409`/`429`/`5xx`. See the [batch examples](./examples/batch) for thread-pool and async fan-out patterns.
+
+```python
+from arkruntime import Ark
+
+client = Ark(timeout=24 * 3600)
+
+result = client.batch.chat.completions.create(
+    model="doubao-seed-2-1-pro-260628",
+    messages=[{"role": "user", "content": "Hello"}],
+)
+print(result)
+```
+
+## API coverage
+
+| API | Client path |
+|---|---|
+| Responses | `client.responses.create()` |
+| Chat Completions | `client.chat.completions.create()` |
+| Embeddings | `client.embeddings.create()` |
+| Multimodal Embeddings | `client.multimodal_embeddings.create()` |
+| Content Generation | `client.content_generation.tasks.create()` |
+| Images | `client.images.generate()` |
+| Files | `client.files.create()` / `.list()` / `.delete()` |
+| Tokenization | `client.tokenization.create()` |
+| Batch | `client.batch.chat.completions.create()` etc. |
+
+## Examples
+
+See the [examples/](./examples) directory for runnable scripts:
+
+- `responses/` -- Responses API: multi-turn chat, function calling, structured output, video streaming
+- `chat/` -- Chat Completions: basic, function calling, reasoning, structured output, vision
+- `batch/` -- Batch inference: chat completions, embeddings, multimodal embeddings (sync + async)
+- `files/` -- Files API: upload, wait for processing, list, delete
+- `embeddings.py` -- Text embeddings
+- `multimodal_embeddings.py` -- Multimodal embeddings with image input
+- `content_generation_tasks.py` -- Video generation task lifecycle
+- `image_generations.py` -- Image generation
+- `tokenization.py` -- Tokenization API
+
+## Development
+
+This repo uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+uv sync                       # create venv + install runtime + dev deps
+uv run pytest                 # run tests
+uv run ruff check src/        # lint
+uv run ruff format src/       # format
+```
+
+A pre-commit hook runs the same linting as CI:
+
+```bash
+uv run pre-commit install     # one-time setup
+```
+
+## Requirements
+
+- Python >= 3.8
+- httpx >= 0.23.0
+- pydantic >= 2.0
+- typing-extensions >= 4.7