c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python 0.1.0a4__tar.gz → 0.1.0a5__tar.gz

c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a5/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.5"
+}

{c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4 → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a5}/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.1.0-alpha.5 (2025-06-27)
+
+Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/digitalocean/gradientai-python/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
+
+### Features
+
+* **api:** define api links and meta as shared models ([8d87001](https://github.com/digitalocean/gradientai-python/commit/8d87001b51de17dd1a36419c0e926cef119f20b8))
+* **api:** update OpenAI spec and add endpoint/smodels ([e92c54b](https://github.com/digitalocean/gradientai-python/commit/e92c54b05f1025b6173945524724143fdafc7728))
+* **api:** update via SDK Studio ([1ae76f7](https://github.com/digitalocean/gradientai-python/commit/1ae76f78ce9e74f8fd555e3497299127e9aa6889))
+* **api:** update via SDK Studio ([98424f4](https://github.com/digitalocean/gradientai-python/commit/98424f4a2c7e00138fb5eecf94ca72e2ffcc1212))
+* **api:** update via SDK Studio ([299fd1b](https://github.com/digitalocean/gradientai-python/commit/299fd1b29b42f6f2581150e52dcf65fc73270862))
+* **api:** update via SDK Studio ([9a45427](https://github.com/digitalocean/gradientai-python/commit/9a45427678644c34afe9792a2561f394718e64ff))
+* **api:** update via SDK Studio ([abe573f](https://github.com/digitalocean/gradientai-python/commit/abe573fcc2233c7d71f0a925eea8fa9dd4d0fb91))
+* **api:** update via SDK Studio ([e5ce590](https://github.com/digitalocean/gradientai-python/commit/e5ce59057792968892317215078ac2c11e811812))
+* **api:** update via SDK Studio ([1daa3f5](https://github.com/digitalocean/gradientai-python/commit/1daa3f55a49b5411d1b378fce30aea3ccbccb6d7))
+* **api:** update via SDK Studio ([1c702b3](https://github.com/digitalocean/gradientai-python/commit/1c702b340e4fd723393c0f02df2a87d03ca8c9bb))
+* **api:** update via SDK Studio ([891d6b3](https://github.com/digitalocean/gradientai-python/commit/891d6b32e5bdb07d23abf898cec17a60ee64f99d))
+* **api:** update via SDK Studio ([dcbe442](https://github.com/digitalocean/gradientai-python/commit/dcbe442efc67554e60b3b28360a4d9f7dcbb313a))
+* use inference key for chat.completions.create() ([5d38e2e](https://github.com/digitalocean/gradientai-python/commit/5d38e2eb8604a0a4065d146ba71aa4a5a0e93d85))
+
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([4d2b3dc](https://github.com/digitalocean/gradientai-python/commit/4d2b3dcefdefc3830d631c5ac27b58778a299983))
+
+
+### Chores
+
+* clean up pyproject ([78637e9](https://github.com/digitalocean/gradientai-python/commit/78637e99816d459c27b4f2fd2f6d79c8d32ecfbe))
+* **internal:** codegen related update ([58d7319](https://github.com/digitalocean/gradientai-python/commit/58d7319ce68c639c2151a3e96a5d522ec06ff96f))
+
 ## 0.1.0-alpha.4 (2025-06-25)
 
 Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/digitalocean/gradientai-python/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)

{c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4 → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a5}/CONTRIBUTING.md

@@ -36,7 +36,7 @@ $ pip install -r requirements-dev.lock
 
 Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
 result in merge conflicts between manual patches and changes from the generator. The generator will never
-modify the contents of the `src/gradientai/lib/` and `examples/` directories.
+modify the contents of the `src/do_gradientai/lib/` and `examples/` directories.
 
 ## Adding and running examples
 

{c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4 → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python
-Version: 0.1.0a4
-Summary: The official Python library for the GradientAI API
+Version: 0.1.0a5
+Summary: The official Python library for GradientAI
 Project-URL: Homepage, https://github.com/digitalocean/gradientai-python
 Project-URL: Repository, https://github.com/digitalocean/gradientai-python
 Author: Gradient AI
@@ -32,11 +32,11 @@ Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.6; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
-# Gradient AI Python API library
+# GradientAI Python API library
 
 [![PyPI version](https://github.com/digitalocean/gradientai-python/tree/main/<https://img.shields.io/pypi/v/c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python.svg?label=pypi%20(stable)>)](https://pypi.org/project/c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python/)
 
-The Gradient AI Python library provides convenient access to the Gradient AI REST API from any Python 3.8+
+The GradientAI Python library provides convenient access to the GradientAI REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -59,16 +59,22 @@ The full API of this library can be found in [api.md](https://github.com/digital
 
 ```python
 import os
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 client = GradientAI(
     api_key=os.environ.get("GRADIENTAI_API_KEY"),  # This is the default and can be omitted
 )
 
-versions = client.agents.versions.list(
-    uuid="REPLACE_ME",
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="llama3-8b-instruct",
 )
-print(versions.agent_versions)
+print(completion.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -83,7 +89,7 @@ Simply import `AsyncGradientAI` instead of `GradientAI` and use `await` with eac
 ```python
 import os
 import asyncio
-from gradientai import AsyncGradientAI
+from do_gradientai import AsyncGradientAI
 
 client = AsyncGradientAI(
     api_key=os.environ.get("GRADIENTAI_API_KEY"),  # This is the default and can be omitted
@@ -91,10 +97,16 @@ client = AsyncGradientAI(
 
 
 async def main() -> None:
-    versions = await client.agents.versions.list(
-        uuid="REPLACE_ME",
+    completion = await client.chat.completions.create(
+        messages=[
+            {
+                "content": "string",
+                "role": "system",
+            }
+        ],
+        model="llama3-8b-instruct",
     )
-    print(versions.agent_versions)
+    print(completion.id)
 
 
 asyncio.run(main())
@@ -118,8 +130,8 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
 ```python
 import os
 import asyncio
-from gradientai import DefaultAioHttpClient
-from gradientai import AsyncGradientAI
+from do_gradientai import DefaultAioHttpClient
+from do_gradientai import AsyncGradientAI
 
 
 async def main() -> None:
@@ -127,10 +139,16 @@ async def main() -> None:
         api_key=os.environ.get("GRADIENTAI_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
-        versions = await client.agents.versions.list(
-            uuid="REPLACE_ME",
+        completion = await client.chat.completions.create(
+            messages=[
+                {
+                    "content": "string",
+                    "role": "system",
+                }
+            ],
+            model="llama3-8b-instruct",
         )
-        print(versions.agent_versions)
+        print(completion.id)
 
 
 asyncio.run(main())
@@ -150,28 +168,35 @@ Typed requests and responses provide autocomplete and documentation within your
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
 ```python
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 client = GradientAI()
 
-evaluation_test_case = client.regions.evaluation_test_cases.create(
-    star_metric={},
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="llama3-8b-instruct",
+    stream_options={},
 )
-print(evaluation_test_case.star_metric)
+print(completion.stream_options)
 ```
 
 ## Handling errors
 
-When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `gradientai.APIConnectionError` is raised.
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `do_gradientai.APIConnectionError` is raised.
 
 When the API returns a non-success status code (that is, 4xx or 5xx
-response), a subclass of `gradientai.APIStatusError` is raised, containing `status_code` and `response` properties.
+response), a subclass of `do_gradientai.APIStatusError` is raised, containing `status_code` and `response` properties.
 
-All errors inherit from `gradientai.APIError`.
+All errors inherit from `do_gradientai.APIError`.
 
 ```python
-import gradientai
-from gradientai import GradientAI
+import do_gradientai
+from do_gradientai import GradientAI
 
 client = GradientAI()
 
@@ -179,12 +204,12 @@ try:
     client.agents.versions.list(
         uuid="REPLACE_ME",
     )
-except gradientai.APIConnectionError as e:
+except do_gradientai.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
-except gradientai.RateLimitError as e:
+except do_gradientai.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
-except gradientai.APIStatusError as e:
+except do_gradientai.APIStatusError as e:
     print("Another non-200-range status code was received")
     print(e.status_code)
     print(e.response)
@@ -212,7 +237,7 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 # Configure the default for all requests:
 client = GradientAI(
@@ -232,7 +257,7 @@ By default requests time out after 1 minute. You can configure this with a `time
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 # Configure the default for all requests:
 client = GradientAI(
@@ -286,7 +311,7 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 client = GradientAI()
 response = client.agents.versions.with_raw_response.list(
@@ -298,9 +323,9 @@ version = response.parse()  # get the object that `agents.versions.list()` would
 print(version.agent_versions)
 ```
 
-These methods return an [`APIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/gradientai/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/do_gradientai/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/gradientai/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/do_gradientai/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -364,7 +389,7 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 
 ```python
 import httpx
-from gradientai import GradientAI, DefaultHttpxClient
+from do_gradientai import GradientAI, DefaultHttpxClient
 
 client = GradientAI(
     # Or use the `GRADIENT_AI_BASE_URL` env var
@@ -387,7 +412,7 @@ client.with_options(http_client=DefaultHttpxClient(...))
 By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
 
 ```py
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 with GradientAI() as client:
   # make requests here
@@ -415,8 +440,8 @@ If you've upgraded to the latest version but aren't seeing any new features you
 You can determine the version that is being used at runtime with:
 
 ```py
-import gradientai
-print(gradientai.__version__)
+import do_gradientai
+print(do_gradientai.__version__)
 ```
 
 ## Requirements

{c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4 → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a5}/README.md

@@ -1,8 +1,8 @@
-# Gradient AI Python API library
+# GradientAI Python API library
 
 [![PyPI version](<https://img.shields.io/pypi/v/c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python.svg?label=pypi%20(stable)>)](https://pypi.org/project/c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python/)
 
-The Gradient AI Python library provides convenient access to the Gradient AI REST API from any Python 3.8+
+The GradientAI Python library provides convenient access to the GradientAI REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -25,16 +25,22 @@ The full API of this library can be found in [api.md](api.md).
 
 ```python
 import os
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 client = GradientAI(
     api_key=os.environ.get("GRADIENTAI_API_KEY"),  # This is the default and can be omitted
 )
 
-versions = client.agents.versions.list(
-    uuid="REPLACE_ME",
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="llama3-8b-instruct",
 )
-print(versions.agent_versions)
+print(completion.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -49,7 +55,7 @@ Simply import `AsyncGradientAI` instead of `GradientAI` and use `await` with eac
 ```python
 import os
 import asyncio
-from gradientai import AsyncGradientAI
+from do_gradientai import AsyncGradientAI
 
 client = AsyncGradientAI(
     api_key=os.environ.get("GRADIENTAI_API_KEY"),  # This is the default and can be omitted
@@ -57,10 +63,16 @@ client = AsyncGradientAI(
 
 
 async def main() -> None:
-    versions = await client.agents.versions.list(
-        uuid="REPLACE_ME",
+    completion = await client.chat.completions.create(
+        messages=[
+            {
+                "content": "string",
+                "role": "system",
+            }
+        ],
+        model="llama3-8b-instruct",
     )
-    print(versions.agent_versions)
+    print(completion.id)
 
 
 asyncio.run(main())
@@ -84,8 +96,8 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
 ```python
 import os
 import asyncio
-from gradientai import DefaultAioHttpClient
-from gradientai import AsyncGradientAI
+from do_gradientai import DefaultAioHttpClient
+from do_gradientai import AsyncGradientAI
 
 
 async def main() -> None:
@@ -93,10 +105,16 @@ async def main() -> None:
         api_key=os.environ.get("GRADIENTAI_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
-        versions = await client.agents.versions.list(
-            uuid="REPLACE_ME",
+        completion = await client.chat.completions.create(
+            messages=[
+                {
+                    "content": "string",
+                    "role": "system",
+                }
+            ],
+            model="llama3-8b-instruct",
         )
-        print(versions.agent_versions)
+        print(completion.id)
 
 
 asyncio.run(main())
@@ -116,28 +134,35 @@ Typed requests and responses provide autocomplete and documentation within your
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
 ```python
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 client = GradientAI()
 
-evaluation_test_case = client.regions.evaluation_test_cases.create(
-    star_metric={},
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="llama3-8b-instruct",
+    stream_options={},
 )
-print(evaluation_test_case.star_metric)
+print(completion.stream_options)
 ```
 
 ## Handling errors
 
-When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `gradientai.APIConnectionError` is raised.
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `do_gradientai.APIConnectionError` is raised.
 
 When the API returns a non-success status code (that is, 4xx or 5xx
-response), a subclass of `gradientai.APIStatusError` is raised, containing `status_code` and `response` properties.
+response), a subclass of `do_gradientai.APIStatusError` is raised, containing `status_code` and `response` properties.
 
-All errors inherit from `gradientai.APIError`.
+All errors inherit from `do_gradientai.APIError`.
 
 ```python
-import gradientai
-from gradientai import GradientAI
+import do_gradientai
+from do_gradientai import GradientAI
 
 client = GradientAI()
 
@@ -145,12 +170,12 @@ try:
     client.agents.versions.list(
         uuid="REPLACE_ME",
     )
-except gradientai.APIConnectionError as e:
+except do_gradientai.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
-except gradientai.RateLimitError as e:
+except do_gradientai.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
-except gradientai.APIStatusError as e:
+except do_gradientai.APIStatusError as e:
     print("Another non-200-range status code was received")
     print(e.status_code)
     print(e.response)
@@ -178,7 +203,7 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 # Configure the default for all requests:
 client = GradientAI(
@@ -198,7 +223,7 @@ By default requests time out after 1 minute. You can configure this with a `time
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 # Configure the default for all requests:
 client = GradientAI(
@@ -252,7 +277,7 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 client = GradientAI()
 response = client.agents.versions.with_raw_response.list(
@@ -264,9 +289,9 @@ version = response.parse()  # get the object that `agents.versions.list()` would
 print(version.agent_versions)
 ```
 
-These methods return an [`APIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/gradientai/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/do_gradientai/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/gradientai/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/digitalocean/gradientai-python/tree/main/src/do_gradientai/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -330,7 +355,7 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 
 ```python
 import httpx
-from gradientai import GradientAI, DefaultHttpxClient
+from do_gradientai import GradientAI, DefaultHttpxClient
 
 client = GradientAI(
     # Or use the `GRADIENT_AI_BASE_URL` env var
@@ -353,7 +378,7 @@ client.with_options(http_client=DefaultHttpxClient(...))
 By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
 
 ```py
-from gradientai import GradientAI
+from do_gradientai import GradientAI
 
 with GradientAI() as client:
   # make requests here
@@ -381,8 +406,8 @@ If you've upgraded to the latest version but aren't seeing any new features you
 You can determine the version that is being used at runtime with:
 
 ```py
-import gradientai
-print(gradientai.__version__)
+import do_gradientai
+print(do_gradientai.__version__)
 ```
 
 ## Requirements