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

release: 1.0.0-rc3

Author: dragos199993

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.0.0-rc2"
+  ".": "1.0.0-rc3"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 17
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/not-diamond-dragos199993%2Fnot-diamond-8bcbee982c8824ec1768e681aafe64151b8c1790fda874599f7818c8e067099b.yml
-openapi_spec_hash: cf30014285209649e86e504008efb7d1
-config_hash: ebc053f864d961cd31bf34d651c7c04d
+configured_endpoints: 14
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/not-diamond-dragos199993%2Fnot-diamond-e24f2461df15a806e3208e5228ecdb9913e9c9d526cd68cf87fee4a2528b95c3.yml
+openapi_spec_hash: a7a8c716d5b412a6befc68091a7627ea
+config_hash: 9d158a3181fcb2291bf97047b2cbb7a0

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 1.0.0-rc3 (2025-11-05)
+
+Full Changelog: [v1.0.0-rc2...v1.0.0-rc3](https://github.com/Not-Diamond/not-diamond-python/compare/v1.0.0-rc2...v1.0.0-rc3)
+
+### Features
+
+* **api:** api update ([0cdedc2](https://github.com/Not-Diamond/not-diamond-python/commit/0cdedc27ef1bab63e433bdc0717c36cc48d60b55))
+* **api:** api update ([f717b91](https://github.com/Not-Diamond/not-diamond-python/commit/f717b91a37cd48a63e9ef9458cef6dd899383f2c))
+* **api:** api update ([24340ab](https://github.com/Not-Diamond/not-diamond-python/commit/24340ab121937a85e9c4bbc8b644c62b15f75d89))
+* **api:** enable tests ([64ccd03](https://github.com/Not-Diamond/not-diamond-python/commit/64ccd03281ae7b420b44cf64910568e3657f24db))
+* **api:** regen docs ([c80dbe1](https://github.com/Not-Diamond/not-diamond-python/commit/c80dbe1994cd73b549995b5e91ac86a62a77f5b7))
+* **api:** verify mock tests enabled ([638d79b](https://github.com/Not-Diamond/not-diamond-python/commit/638d79bdd90097d9823d02e3dac8b12ab2849d03))
+
+
+### Chores
+
+* **internal:** grammar fix (it's -> its) ([6d37a12](https://github.com/Not-Diamond/not-diamond-python/commit/6d37a125457223046183bcc8ee7159ed96b80424))
+* update SDK settings ([ba3968b](https://github.com/Not-Diamond/not-diamond-python/commit/ba3968b9ef7b2ec9e7b1b3983a6e2a8b31ccbc37))
+
 ## 1.0.0-rc2 (2025-10-31)
 
 Full Changelog: [v1.0.0-rc1...v1.0.0-rc2](https://github.com/Not-Diamond/not-diamond-python/compare/v1.0.0-rc1...v1.0.0-rc2)

README.md

@@ -1,7 +1,7 @@
 # Not Diamond Python API library
 
 <!-- prettier-ignore -->
-[![PyPI version](https://img.shields.io/pypi/v/notdiamond.svg?label=pypi%20(stable))](https://pypi.org/project/notdiamond/)
+[![PyPI version](https://img.shields.io/pypi/v/not_diamond.svg?label=pypi%20(stable))](https://pypi.org/project/not_diamond/)
 
 The Not Diamond Python library provides convenient access to the Not Diamond REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -11,15 +11,18 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [docs.notdiamond.ai](https://docs.notdiamond.ai). The full API of this library can be found in [api.md](api.md).
+The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
 ```sh
-# install from PyPI
-pip install --pre notdiamond
+# install from the production repo
+pip install git+ssh://git@github.com/Not-Diamond/not-diamond-python.git
 ```
 
+> [!NOTE]
+> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install --pre not_diamond`
+
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
@@ -30,11 +33,9 @@ from not_diamond import NotDiamond
 
 client = NotDiamond(
     api_key=os.environ.get("NOT_DIAMOND_API_KEY"),  # This is the default and can be omitted
-    # defaults to "production".
-    environment="staging",
 )
 
-response = client.routing.select_model(
+response = client.model_router.select_model(
     llm_providers=[
         {
             "model": "gpt-4o",
@@ -79,13 +80,11 @@ from not_diamond import AsyncNotDiamond
 
 client = AsyncNotDiamond(
     api_key=os.environ.get("NOT_DIAMOND_API_KEY"),  # This is the default and can be omitted
-    # defaults to "production".
-    environment="staging",
 )
 
 
 async def main() -> None:
-    response = await client.routing.select_model(
+    response = await client.model_router.select_model(
         llm_providers=[
             {
                 "model": "gpt-4o",
@@ -126,8 +125,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from PyPI
-pip install --pre notdiamond[aiohttp]
+# install from the production repo
+pip install 'not_diamond[aiohttp] @ git+ssh://git@github.com/Not-Diamond/not-diamond-python.git'
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -143,7 +142,7 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.routing.select_model(
+        response = await client.model_router.select_model(
             llm_providers=[
                 {
                     "model": "gpt-4o",
@@ -193,26 +192,15 @@ from not_diamond import NotDiamond
 
 client = NotDiamond()
 
-response = client.prompt_adaptation.adapt(
-    fields=["question"],
-    system_prompt="You are a helpful assistant that answers questions accurately.",
-    target_models=[
-        {
-            "model": "claude-sonnet-4-5-20250929",
-            "provider": "anthropic",
-        },
-        {
-            "model": "gemini-1.5-pro",
-            "provider": "google",
-        },
-    ],
-    template="Question: {question}\nAnswer:",
-    origin_model={
+response = client.report.metrics.submit_feedback(
+    feedback={"accuracy": "bar"},
+    provider={
         "model": "gpt-4o",
         "provider": "openai",
     },
+    session_id="550e8400-e29b-41d4-a716-446655440000",
 )
-print(response.origin_model)
+print(response.provider)
 ```
 
 ## File uploads
@@ -225,7 +213,7 @@ from not_diamond import NotDiamond
 
 client = NotDiamond()
 
-client.routing.create_survey_response(
+client.pzn.submit_survey_response(
     constraint_priorities="constraint_priorities",
     email="email",
     llm_providers="llm_providers",
@@ -254,7 +242,7 @@ from not_diamond import NotDiamond
 client = NotDiamond()
 
 try:
-    client.routing.select_model(
+    client.model_router.select_model(
         llm_providers=[
             {
                 "model": "gpt-4o",
@@ -322,7 +310,7 @@ client = NotDiamond(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).routing.select_model(
+client.with_options(max_retries=5).model_router.select_model(
     llm_providers=[
         {
             "model": "gpt-4o",
@@ -370,7 +358,7 @@ client = NotDiamond(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).routing.select_model(
+client.with_options(timeout=5.0).model_router.select_model(
     llm_providers=[
         {
             "model": "gpt-4o",
@@ -436,7 +424,7 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from not_diamond import NotDiamond
 
 client = NotDiamond()
-response = client.routing.with_raw_response.select_model(
+response = client.model_router.with_raw_response.select_model(
     llm_providers=[{
         "model": "gpt-4o",
         "provider": "openai",
@@ -457,8 +445,8 @@ response = client.routing.with_raw_response.select_model(
 )
 print(response.headers.get('X-My-Header'))
 
-routing = response.parse()  # get the object that `routing.select_model()` would have returned
-print(routing.providers)
+model_router = response.parse()  # get the object that `model_router.select_model()` would have returned
+print(model_router.providers)
 ```
 
 These methods return an [`APIResponse`](https://github.com/Not-Diamond/not-diamond-python/tree/main/src/not_diamond/_response.py) object.
@@ -472,7 +460,7 @@ 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.routing.with_streaming_response.select_model(
+with client.model_router.with_streaming_response.select_model(
     llm_providers=[
         {
             "model": "gpt-4o",

SECURITY.md

@@ -18,10 +18,6 @@ before making any information public.
 If you encounter security issues that are not directly related to SDKs but pertain to the services
 or products provided by Not Diamond, please follow the respective company's security reporting guidelines.
 
-### Not Diamond Terms and Policies
-
-Please contact d6@notdiamond.ai for any questions or concerns regarding the security of our services.
-
 ---
 
 Thank you for helping us keep the SDKs and systems they interact with secure.

api.md

@@ -1,76 +1,95 @@
-# Routing
+# ModelRouter
 
 Types:
 
 ```python
-from not_diamond.types import RoutingSelectModelResponse, RoutingTrainCustomRouterResponse
+from not_diamond.types import ModelRouterSelectModelResponse
 ```
 
 Methods:
 
-- <code title="post /v2/pzn/surveyResponse">client.routing.<a href="./src/not_diamond/resources/routing.py">create_survey_response</a>(\*\*<a href="src/not_diamond/types/routing_create_survey_response_params.py">params</a>) -> object</code>
-- <code title="post /v2/modelRouter/modelSelect">client.routing.<a href="./src/not_diamond/resources/routing.py">select_model</a>(\*\*<a href="src/not_diamond/types/routing_select_model_params.py">params</a>) -> <a href="./src/not_diamond/types/routing_select_model_response.py">RoutingSelectModelResponse</a></code>
-- <code title="post /v2/pzn/trainCustomRouter">client.routing.<a href="./src/not_diamond/resources/routing.py">train_custom_router</a>(\*\*<a href="src/not_diamond/types/routing_train_custom_router_params.py">params</a>) -> <a href="./src/not_diamond/types/routing_train_custom_router_response.py">RoutingTrainCustomRouterResponse</a></code>
+- <code title="post /v2/modelRouter/openHandsRouter">client.model_router.<a href="./src/not_diamond/resources/model_router.py">open_hands_select</a>(\*\*<a href="src/not_diamond/types/model_router_open_hands_select_params.py">params</a>) -> object</code>
+- <code title="post /v2/modelRouter/modelSelect">client.model_router.<a href="./src/not_diamond/resources/model_router.py">select_model</a>(\*\*<a href="src/not_diamond/types/model_router_select_model_params.py">params</a>) -> <a href="./src/not_diamond/types/model_router_select_model_response.py">ModelRouterSelectModelResponse</a></code>
+
+# Report
+
+## Metrics
+
+Types:
+
+```python
+from not_diamond.types.report import MetricSubmitFeedbackResponse
+```
+
+Methods:
+
+- <code title="post /v2/report/metrics/feedback">client.report.metrics.<a href="./src/not_diamond/resources/report/metrics.py">submit_feedback</a>(\*\*<a href="src/not_diamond/types/report/metric_submit_feedback_params.py">params</a>) -> <a href="./src/not_diamond/types/report/metric_submit_feedback_response.py">MetricSubmitFeedbackResponse</a></code>
 
 # Preferences
 
 Types:
 
 ```python
-from not_diamond.types import PreferenceCreateUserPreferenceResponse
+from not_diamond.types import PreferenceCreateResponse
 ```
 
 Methods:
 
-- <code title="get /v2/preferences/{user_id}/{preference_id}">client.preferences.<a href="./src/not_diamond/resources/preferences.py">retrieve</a>(preference_id, \*, user_id) -> object</code>
-- <code title="post /v2/preferences/userPreferenceCreate">client.preferences.<a href="./src/not_diamond/resources/preferences.py">create_user_preference</a>(\*\*<a href="src/not_diamond/types/preference_create_user_preference_params.py">params</a>) -> <a href="./src/not_diamond/types/preference_create_user_preference_response.py">PreferenceCreateUserPreferenceResponse</a></code>
-- <code title="delete /v2/preferences/userPreferenceDelete/{preference_id}">client.preferences.<a href="./src/not_diamond/resources/preferences.py">delete_user_preference</a>(preference_id) -> object</code>
-- <code title="put /v2/preferences/userPreferenceUpdate">client.preferences.<a href="./src/not_diamond/resources/preferences.py">update_user_preference</a>(\*\*<a href="src/not_diamond/types/preference_update_user_preference_params.py">params</a>) -> object</code>
+- <code title="post /v2/preferences/userPreferenceCreate">client.preferences.<a href="./src/not_diamond/resources/preferences.py">create</a>(\*\*<a href="src/not_diamond/types/preference_create_params.py">params</a>) -> <a href="./src/not_diamond/types/preference_create_response.py">PreferenceCreateResponse</a></code>
+- <code title="get /v2/preferences/{user_id}">client.preferences.<a href="./src/not_diamond/resources/preferences.py">retrieve</a>(user_id) -> object</code>
+- <code title="put /v2/preferences/userPreferenceUpdate">client.preferences.<a href="./src/not_diamond/resources/preferences.py">update</a>(\*\*<a href="src/not_diamond/types/preference_update_params.py">params</a>) -> object</code>
+- <code title="delete /v2/preferences/userPreferenceDelete/{preference_id}">client.preferences.<a href="./src/not_diamond/resources/preferences.py">delete</a>(preference_id) -> object</code>
 
-# PromptAdaptation
+# Prompt
 
 Types:
 
 ```python
-from not_diamond.types import (
-    AdaptationRunResults,
-    JobStatus,
-    PromptAdaptationAdaptResponse,
-    PromptAdaptationGetAdaptRunsResponse,
-    PromptAdaptationGetAdaptStatusResponse,
-    PromptAdaptationRetrieveCostsResponse,
+from not_diamond.types import JobStatus, PromptGetAdaptResultsResponse, PromptGetAdaptStatusResponse
+```
+
+Methods:
+
+- <code title="get /v2/prompt/adaptResults/{adaptation_run_id}">client.prompt.<a href="./src/not_diamond/resources/prompt/prompt.py">get_adapt_results</a>(adaptation_run_id) -> <a href="./src/not_diamond/types/prompt_get_adapt_results_response.py">PromptGetAdaptResultsResponse</a></code>
+- <code title="get /v2/prompt/adaptStatus/{adaptation_run_id}">client.prompt.<a href="./src/not_diamond/resources/prompt/prompt.py">get_adapt_status</a>(adaptation_run_id) -> <a href="./src/not_diamond/types/prompt_get_adapt_status_response.py">PromptGetAdaptStatusResponse</a></code>
+
+## Adapt
+
+Types:
+
+```python
+from not_diamond.types.prompt import (
+    GoldenRecord,
+    RequestProvider,
+    AdaptCreateResponse,
+    AdaptGetCostsResponse,
 )
 ```
 
 Methods:
 
-- <code title="post /v2/prompt/adapt">client.prompt_adaptation.<a href="./src/not_diamond/resources/prompt_adaptation.py">adapt</a>(\*\*<a href="src/not_diamond/types/prompt_adaptation_adapt_params.py">params</a>) -> <a href="./src/not_diamond/types/prompt_adaptation_adapt_response.py">PromptAdaptationAdaptResponse</a></code>
-- <code title="get /v2/prompt/adaptResults/{adaptation_run_id}">client.prompt_adaptation.<a href="./src/not_diamond/resources/prompt_adaptation.py">get_adapt_results</a>(adaptation_run_id) -> <a href="./src/not_diamond/types/adaptation_run_results.py">AdaptationRunResults</a></code>
-- <code title="get /v2/prompt/frontendAdaptRunResults/{user_id}/{adaptation_run_id}">client.prompt_adaptation.<a href="./src/not_diamond/resources/prompt_adaptation.py">get_adapt_run_results</a>(adaptation_run_id, \*, user_id) -> <a href="./src/not_diamond/types/adaptation_run_results.py">AdaptationRunResults</a></code>
-- <code title="get /v2/prompt/frontendAdaptRuns/{user_id}">client.prompt_adaptation.<a href="./src/not_diamond/resources/prompt_adaptation.py">get_adapt_runs</a>(user_id) -> <a href="./src/not_diamond/types/prompt_adaptation_get_adapt_runs_response.py">PromptAdaptationGetAdaptRunsResponse</a></code>
-- <code title="get /v2/prompt/adaptStatus/{adaptation_run_id}">client.prompt_adaptation.<a href="./src/not_diamond/resources/prompt_adaptation.py">get_adapt_status</a>(adaptation_run_id) -> <a href="./src/not_diamond/types/prompt_adaptation_get_adapt_status_response.py">PromptAdaptationGetAdaptStatusResponse</a></code>
-- <code title="get /v1/adaptation-runs/{adaptation_run_id}/costs">client.prompt_adaptation.<a href="./src/not_diamond/resources/prompt_adaptation.py">retrieve_costs</a>(adaptation_run_id) -> <a href="./src/not_diamond/types/prompt_adaptation_retrieve_costs_response.py">PromptAdaptationRetrieveCostsResponse</a></code>
+- <code title="post /v2/prompt/adapt">client.prompt.adapt.<a href="./src/not_diamond/resources/prompt/adapt.py">create</a>(\*\*<a href="src/not_diamond/types/prompt/adapt_create_params.py">params</a>) -> <a href="./src/not_diamond/types/prompt/adapt_create_response.py">AdaptCreateResponse</a></code>
+- <code title="get /v2/prompt/adapt/{adaptation_run_id}/costs">client.prompt.adapt.<a href="./src/not_diamond/resources/prompt/adapt.py">get_costs</a>(adaptation_run_id) -> <a href="./src/not_diamond/types/prompt/adapt_get_costs_response.py">AdaptGetCostsResponse</a></code>
 
-# Report
+# Pzn
 
 Types:
 
 ```python
-from not_diamond.types import ReportSubmitFeedbackResponse
+from not_diamond.types import PznTrainCustomRouterResponse
 ```
 
 Methods:
 
-- <code title="post /v2/report/hallucination">client.report.<a href="./src/not_diamond/resources/report.py">evaluate_hallucination</a>(\*\*<a href="src/not_diamond/types/report_evaluate_hallucination_params.py">params</a>) -> object</code>
-- <code title="post /v2/report/metrics/latency">client.report.<a href="./src/not_diamond/resources/report.py">latency</a>(\*\*<a href="src/not_diamond/types/report_latency_params.py">params</a>) -> object</code>
-- <code title="post /v2/report/metrics/feedback">client.report.<a href="./src/not_diamond/resources/report.py">submit_feedback</a>(\*\*<a href="src/not_diamond/types/report_submit_feedback_params.py">params</a>) -> <a href="./src/not_diamond/types/report_submit_feedback_response.py">ReportSubmitFeedbackResponse</a></code>
+- <code title="post /v2/pzn/surveyResponse">client.pzn.<a href="./src/not_diamond/resources/pzn.py">submit_survey_response</a>(\*\*<a href="src/not_diamond/types/pzn_submit_survey_response_params.py">params</a>) -> object</code>
+- <code title="post /v2/pzn/trainCustomRouter">client.pzn.<a href="./src/not_diamond/resources/pzn.py">train_custom_router</a>(\*\*<a href="src/not_diamond/types/pzn_train_custom_router_params.py">params</a>) -> <a href="./src/not_diamond/types/pzn_train_custom_router_response.py">PznTrainCustomRouterResponse</a></code>
 
 # Models
 
 Types:
 
 ```python
-from not_diamond.types import ModelListResponse
+from not_diamond.types import Model, ModelListResponse
 ```
 
 Methods:

pyproject.toml

@@ -1,11 +1,11 @@
 [project]
-name = "notdiamond"
-version = "1.0.0-rc2"
+name = "not_diamond"
+version = "1.0.0-rc3"
 description = "The official Python library for the not-diamond API"
 dynamic = ["readme"]
 license = "Apache-2.0"
 authors = [
-{ name = "Not Diamond", email = "d6@notdiamond.ai" },
+{ name = "Not Diamond", email = "" },
 ]
 dependencies = [
     "httpx>=0.23.0, <1",