Merge pull request #3 from Not-Diamond/release-please--branches--main--changes--next

release: 0.3.0

Author: dragos199993

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.0"
+  ".": "0.3.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 20
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/not-diamond-dragos199993%2Fnot-diamond-16cbc3880d2b786cefa8c80a6dd1129791483c0b487955104c68a5c13f00a69b.yml
-openapi_spec_hash: 4c16e5753f4b9e0a20dd01706c5d07d7
-config_hash: 36de232224f15ed78970b28252ccf625
+configured_endpoints: 17
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/not-diamond-dragos199993%2Fnot-diamond-76d84ad8b4d68f7470a24f0f938d10318ecc1f16b86ca654c1644065c13e413a.yml
+openapi_spec_hash: 92030c9eb965278da586919e9c7375b3
+config_hash: 0dbf3c6b30eede76ffb01f86b59ac672

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.3.0 (2025-10-24)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/Not-Diamond/not-diamond-python/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([d403264](https://github.com/Not-Diamond/not-diamond-python/commit/d4032647605736f1c51d04023d3adb24f448737f))
+* **api:** api update ([c7a1198](https://github.com/Not-Diamond/not-diamond-python/commit/c7a1198c1432e833b740f92df9996379f941228f))
+* **api:** api update ([9265a0a](https://github.com/Not-Diamond/not-diamond-python/commit/9265a0a3959818b06f157726e68d3c73f7f5d9c9))
+* **api:** api update ([880c195](https://github.com/Not-Diamond/not-diamond-python/commit/880c195dc41ac5e500cae9b9a71b0840f97e7556))
+* **api:** exclude non sdk endpoints ([fb04bc4](https://github.com/Not-Diamond/not-diamond-python/commit/fb04bc460d7f9f7f191cffcb56868d09fa45edc1))
+* **api:** fix missing endpoint ([427d1d3](https://github.com/Not-Diamond/not-diamond-python/commit/427d1d3bdd7be290e66897aa35daba984931e4a4))
+* **api:** manual updates ([603c1b7](https://github.com/Not-Diamond/not-diamond-python/commit/603c1b74c64850e1fd8a89e08b1d66d0665188e0))
+* **api:** manual updates ([42fb39e](https://github.com/Not-Diamond/not-diamond-python/commit/42fb39e0978aa329f4b5171ff54aaab257558135))
+* **api:** report group ([4312188](https://github.com/Not-Diamond/not-diamond-python/commit/43121880104978fa2b88a3ad0e85070a2b322787))
+
+
+### Chores
+
+* bump `httpx-aiohttp` version to 0.1.9 ([37d5de2](https://github.com/Not-Diamond/not-diamond-python/commit/37d5de2162ece6024539d9e546dd2679ba5e1882))
+* **internal:** detect missing future annotations with ruff ([316a749](https://github.com/Not-Diamond/not-diamond-python/commit/316a7493d166e631eafcc888d377dbe340178b24))
+
 ## 0.2.0 (2025-10-09)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/Not-Diamond/not-diamond-python/compare/v0.1.0...v0.2.0)

README.md

@@ -28,18 +28,20 @@ pip install git+ssh://git@github.com/Not-Diamond/not-diamond-python.git
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from not_diamond import NotDiamond
 
-client = NotDiamond()
+client = NotDiamond(
+    api_key=os.environ.get("NOT_DIAMOND_API_KEY"),  # This is the default and can be omitted
+)
 
-response = client.model_router.select_model(
-    llm_providers=[
-        {
-            "model": "model",
-            "provider": "provider",
-        }
-    ],
-    messages=[{"foo": "string"}],
+response = client.router.create_survey_response(
+    constraint_priorities="constraint_priorities",
+    email="email",
+    llm_providers="llm_providers",
+    use_case_desc="use_case_desc",
+    user_id="user_id",
+    x_token="x-token",
 )
 ```
 
@@ -53,21 +55,23 @@ so that your API Key is not stored in source control.
 Simply import `AsyncNotDiamond` instead of `NotDiamond` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from not_diamond import AsyncNotDiamond
 
-client = AsyncNotDiamond()
+client = AsyncNotDiamond(
+    api_key=os.environ.get("NOT_DIAMOND_API_KEY"),  # This is the default and can be omitted
+)
 
 
 async def main() -> None:
-    response = await client.model_router.select_model(
-        llm_providers=[
-            {
-                "model": "model",
-                "provider": "provider",
-            }
-        ],
-        messages=[{"foo": "string"}],
+    response = await client.router.create_survey_response(
+        constraint_priorities="constraint_priorities",
+        email="email",
+        llm_providers="llm_providers",
+        use_case_desc="use_case_desc",
+        user_id="user_id",
+        x_token="x-token",
     )
 
 
@@ -97,16 +101,16 @@ from not_diamond import AsyncNotDiamond
 
 async def main() -> None:
     async with AsyncNotDiamond(
+        api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.model_router.select_model(
-            llm_providers=[
-                {
-                    "model": "model",
-                    "provider": "provider",
-                }
-            ],
-            messages=[{"foo": "string"}],
+        response = await client.router.create_survey_response(
+            constraint_priorities="constraint_priorities",
+            email="email",
+            llm_providers="llm_providers",
+            use_case_desc="use_case_desc",
+            user_id="user_id",
+            x_token="x-token",
         )
 
 
@@ -131,21 +135,24 @@ from not_diamond import NotDiamond
 
 client = NotDiamond()
 
-response = client.prompt.adapt(
-    fields=["string"],
-    goldens=[{"fields": {"foo": "string"}}],
+response = client.prompt_adaptation.adapt(
+    fields=["question"],
     origin_model={
-        "model": "model",
-        "provider": "provider",
+        "model": "gpt-4o",
+        "provider": "openai",
     },
-    system_prompt="system_prompt",
+    system_prompt="You are a helpful assistant that answers questions accurately.",
     target_models=[
         {
-            "model": "model",
-            "provider": "provider",
-        }
+            "model": "claude-3-5-sonnet-20241022",
+            "provider": "anthropic",
+        },
+        {
+            "model": "gemini-1.5-pro",
+            "provider": "google",
+        },
     ],
-    template="template",
+    template="Question: {question}\nAnswer:",
 )
 print(response.origin_model)
 ```
@@ -160,7 +167,7 @@ from not_diamond import NotDiamond
 
 client = NotDiamond()
 
-client.pzn.create_survey_response(
+client.router.create_survey_response(
     constraint_priorities="constraint_priorities",
     email="email",
     llm_providers="llm_providers",
@@ -189,14 +196,13 @@ from not_diamond import NotDiamond
 client = NotDiamond()
 
 try:
-    client.model_router.select_model(
-        llm_providers=[
-            {
-                "model": "model",
-                "provider": "provider",
-            }
-        ],
-        messages=[{"foo": "string"}],
+    client.router.create_survey_response(
+        constraint_priorities="constraint_priorities",
+        email="email",
+        llm_providers="llm_providers",
+        use_case_desc="use_case_desc",
+        user_id="user_id",
+        x_token="x-token",
     )
 except not_diamond.APIConnectionError as e:
     print("The server could not be reached")
@@ -240,14 +246,13 @@ client = NotDiamond(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).model_router.select_model(
-    llm_providers=[
-        {
-            "model": "model",
-            "provider": "provider",
-        }
-    ],
-    messages=[{"foo": "string"}],
+client.with_options(max_retries=5).router.create_survey_response(
+    constraint_priorities="constraint_priorities",
+    email="email",
+    llm_providers="llm_providers",
+    use_case_desc="use_case_desc",
+    user_id="user_id",
+    x_token="x-token",
 )
 ```
 
@@ -271,14 +276,13 @@ client = NotDiamond(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).model_router.select_model(
-    llm_providers=[
-        {
-            "model": "model",
-            "provider": "provider",
-        }
-    ],
-    messages=[{"foo": "string"}],
+client.with_options(timeout=5.0).router.create_survey_response(
+    constraint_priorities="constraint_priorities",
+    email="email",
+    llm_providers="llm_providers",
+    use_case_desc="use_case_desc",
+    user_id="user_id",
+    x_token="x-token",
 )
 ```
 
@@ -320,19 +324,18 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from not_diamond import NotDiamond
 
 client = NotDiamond()
-response = client.model_router.with_raw_response.select_model(
-    llm_providers=[{
-        "model": "model",
-        "provider": "provider",
-    }],
-    messages=[{
-        "foo": "string"
-    }],
+response = client.router.with_raw_response.create_survey_response(
+    constraint_priorities="constraint_priorities",
+    email="email",
+    llm_providers="llm_providers",
+    use_case_desc="use_case_desc",
+    user_id="user_id",
+    x_token="x-token",
 )
 print(response.headers.get('X-My-Header'))
 
-model_router = response.parse()  # get the object that `model_router.select_model()` would have returned
-print(model_router)
+router = response.parse()  # get the object that `router.create_survey_response()` would have returned
+print(router)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Not-Diamond/not-diamond-python/tree/main/src/not_diamond/_response.py) object.
@@ -346,14 +349,13 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.model_router.with_streaming_response.select_model(
-    llm_providers=[
-        {
-            "model": "model",
-            "provider": "provider",
-        }
-    ],
-    messages=[{"foo": "string"}],
+with client.router.with_streaming_response.create_survey_response(
+    constraint_priorities="constraint_priorities",
+    email="email",
+    llm_providers="llm_providers",
+    use_case_desc="use_case_desc",
+    user_id="user_id",
+    x_token="x-token",
 ) as response:
     print(response.headers.get("X-My-Header"))