nbq 0.9.0__tar.gz

nbq-0.9.0/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Virtual environments and tooling
+.venv/
+venv/
+.uv/
+
+# JavaScript / TypeScript
+node_modules/
+.turbo/
+coverage/
+
+# Secrets and local environment
+.env
+.env.*
+!.env.example
+*.envrc
+
+# Editors and operating systems
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store

nbq-0.9.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.

nbq-0.9.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.5
+Name: nbq
+Version: 0.9.0
+Summary: Official Python SDK for the Zelinqa Next Best Question API
+Project-URL: Documentation, https://docs.zelinqa.ai
+Project-URL: Homepage, https://zelinqa.ai
+Project-URL: Repository, https://github.com/Zelinqa/nbq-sdk
+Project-URL: Issues, https://github.com/Zelinqa/nbq-sdk/issues
+Author-email: Zelinqa <support@zelinqa.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: conversational-ai,nbq,next-best-question,zelinqa
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<1,>=0.27
+Description-Content-Type: text/markdown
+
+# NBQ Python SDK
+
+The official Python client for the [Zelinqa NBQ API](https://docs.zelinqa.ai).
+
+NBQ selects the next best question for a conversation from a customer-configured question
+bank. This package is a typed HTTP client; the scoring algorithm remains in the hosted NBQ
+Engine.
+
+> The SDK is currently beta. Its public surface follows the deployed `/v1` runtime API.
+
+## Installation
+
+```bash
+pip install nbq
+```
+
+## Synchronous client
+
+```python
+from nbq import Message, NBQClient
+
+with NBQClient(api_key="nbq_live_...") as client:
+    result = client.next_question(
+        session_id="conversation-123",
+        conversation_history=[
+            Message(role="user", content="We receive about 200 leads per month."),
+        ],
+    )
+
+    if result.next_question is not None:
+        print(result.next_question.text)
+```
+
+Keep the same `session_id` for the entire conversation and use a new one for each new
+conversation. Send every question actually asked in `answered_question_ids` on subsequent
+calls.
+
+## Asynchronous client
+
+```python
+from nbq import AsyncNBQClient, Message
+
+async with AsyncNBQClient(api_key="nbq_live_...") as client:
+    result = await client.next_question(
+        session_id="conversation-123",
+        conversation_history=[
+            Message(role="user", content="We receive about 200 leads per month."),
+        ],
+        answered_question_ids=["q_company_size"],
+    )
+```
+
+## Report an outcome
+
+```python
+conversion = client.report_conversion(
+    session_id="conversation-123",
+    outcome="lead",
+    metadata={"source": "website"},
+)
+print(conversion.conversion_id)
+```
+
+The SDK automatically adds an idempotency key to writes. You can provide your own key when
+the same business operation may be retried outside the SDK process.
+
+## Configuration
+
+```python
+client = NBQClient(
+    api_key="nbq_live_...",
+    base_url="https://api.zelinqa.ai",
+    timeout=10.0,
+    max_retries=2,
+)
+```
+
+Do not expose the runtime API key in browser or mobile code. Call NBQ from a trusted backend.
+
+## Support
+
+Log the `request_id` returned by NBQ when contacting support. Do not include API keys or
+conversation content in bug reports.
+
+## License
+
+Apache License 2.0.

nbq-0.9.0/pyproject.toml

@@ -0,0 +1,61 @@
+[project]
+name = "nbq"
+version = "0.9.0"
+description = "Official Python SDK for the Zelinqa Next Best Question API"
+readme = "python/README.md"
+requires-python = ">=3.11"
+authors = [{ name = "Zelinqa", email = "support@zelinqa.ai" }]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = ["nbq", "next-best-question", "conversational-ai", "zelinqa"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Typing :: Typed",
+]
+dependencies = ["httpx>=0.27,<1"]
+
+[project.urls]
+Documentation = "https://docs.zelinqa.ai"
+Homepage = "https://zelinqa.ai"
+Repository = "https://github.com/Zelinqa/nbq-sdk"
+Issues = "https://github.com/Zelinqa/nbq-sdk/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = ["python/src/nbq", "python/README.md", "LICENSE"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["python/src/nbq"]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.10",
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+    "ruff>=0.6.0",
+    "twine>=6.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["python/tests"]
+addopts = "-ra -q --strict-markers"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "B", "UP", "RUF"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true

nbq-0.9.0/python/README.md

@@ -0,0 +1,87 @@
+# NBQ Python SDK
+
+The official Python client for the [Zelinqa NBQ API](https://docs.zelinqa.ai).
+
+NBQ selects the next best question for a conversation from a customer-configured question
+bank. This package is a typed HTTP client; the scoring algorithm remains in the hosted NBQ
+Engine.
+
+> The SDK is currently beta. Its public surface follows the deployed `/v1` runtime API.
+
+## Installation
+
+```bash
+pip install nbq
+```
+
+## Synchronous client
+
+```python
+from nbq import Message, NBQClient
+
+with NBQClient(api_key="nbq_live_...") as client:
+    result = client.next_question(
+        session_id="conversation-123",
+        conversation_history=[
+            Message(role="user", content="We receive about 200 leads per month."),
+        ],
+    )
+
+    if result.next_question is not None:
+        print(result.next_question.text)
+```
+
+Keep the same `session_id` for the entire conversation and use a new one for each new
+conversation. Send every question actually asked in `answered_question_ids` on subsequent
+calls.
+
+## Asynchronous client
+
+```python
+from nbq import AsyncNBQClient, Message
+
+async with AsyncNBQClient(api_key="nbq_live_...") as client:
+    result = await client.next_question(
+        session_id="conversation-123",
+        conversation_history=[
+            Message(role="user", content="We receive about 200 leads per month."),
+        ],
+        answered_question_ids=["q_company_size"],
+    )
+```
+
+## Report an outcome
+
+```python
+conversion = client.report_conversion(
+    session_id="conversation-123",
+    outcome="lead",
+    metadata={"source": "website"},
+)
+print(conversion.conversion_id)
+```
+
+The SDK automatically adds an idempotency key to writes. You can provide your own key when
+the same business operation may be retried outside the SDK process.
+
+## Configuration
+
+```python
+client = NBQClient(
+    api_key="nbq_live_...",
+    base_url="https://api.zelinqa.ai",
+    timeout=10.0,
+    max_retries=2,
+)
+```
+
+Do not expose the runtime API key in browser or mobile code. Call NBQ from a trusted backend.
+
+## Support
+
+Log the `request_id` returned by NBQ when contacting support. Do not include API keys or
+conversation content in bug reports.
+
+## License
+
+Apache License 2.0.

nbq-0.9.0/python/src/nbq/__init__.py

@@ -0,0 +1,40 @@
+"""Official Python SDK for the Zelinqa NBQ API."""
+
+from ._version import __version__
+from .client import AsyncNBQClient, NBQClient
+from .errors import (
+    NBQAPIError,
+    NBQAuthenticationError,
+    NBQConflictError,
+    NBQConnectionError,
+    NBQError,
+    NBQRateLimitError,
+    NBQServerError,
+    NBQValidationError,
+)
+from .models import (
+    ConversionResponse,
+    Message,
+    NextQuestion,
+    NextQuestionsResponse,
+    Outcome,
+)
+
+__all__ = [
+    "AsyncNBQClient",
+    "ConversionResponse",
+    "Message",
+    "NBQAPIError",
+    "NBQAuthenticationError",
+    "NBQClient",
+    "NBQConflictError",
+    "NBQConnectionError",
+    "NBQError",
+    "NBQRateLimitError",
+    "NBQServerError",
+    "NBQValidationError",
+    "NextQuestion",
+    "NextQuestionsResponse",
+    "Outcome",
+    "__version__",
+]

nbq-0.9.0/python/src/nbq/_version.py

@@ -0,0 +1 @@
+__version__ = "0.9.0"

nbq-0.9.0/python/src/nbq/client.py

@@ -0,0 +1,359 @@
+"""Synchronous and asynchronous clients for the NBQ runtime API."""
+
+from __future__ import annotations
+
+import asyncio
+import json
+import time
+import uuid
+from collections.abc import Mapping, Sequence
+from typing import Any, cast
+from urllib.parse import quote, urlsplit
+
+import httpx
+
+from ._version import __version__
+from .errors import NBQConnectionError, api_error_from_payload
+from .models import (
+    ConversionResponse,
+    MessageInput,
+    NextQuestionsResponse,
+    Outcome,
+    serialize_messages,
+)
+
+DEFAULT_BASE_URL = "https://api.zelinqa.ai"
+DEFAULT_TIMEOUT_SECONDS = 10.0
+DEFAULT_MAX_RETRIES = 2
+MAX_SESSION_ID_CHARS = 128
+MAX_HISTORY_MESSAGES = 50
+MAX_ANSWERED_QUESTIONS = 200
+MAX_CONTEXT_CHARS = 8000
+MAX_METADATA_BYTES = 4096
+RETRIABLE_STATUS_CODES = frozenset({429, 500, 502, 503, 504})
+
+
+def _validate_settings(api_key: str, base_url: str, timeout: float, max_retries: int) -> None:
+    if not api_key.strip():
+        raise ValueError("api_key must not be empty")
+    parsed_url = urlsplit(base_url)
+    if parsed_url.scheme not in ("https", "http") or not parsed_url.netloc:
+        raise ValueError("base_url must be an absolute HTTP(S) URL")
+    if parsed_url.username or parsed_url.password:
+        raise ValueError("base_url must not contain credentials")
+    if parsed_url.query or parsed_url.fragment:
+        raise ValueError("base_url must not contain a query string or fragment")
+    if timeout <= 0:
+        raise ValueError("timeout must be greater than zero")
+    if max_retries < 0:
+        raise ValueError("max_retries must be zero or greater")
+
+
+def _request_headers(api_key: str) -> dict[str, str]:
+    return {
+        "Authorization": f"Bearer {api_key}",
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+        "User-Agent": f"nbq-python/{__version__}",
+    }
+
+
+def _next_payload(
+    *,
+    session_id: str,
+    conversation_history: Sequence[MessageInput],
+    context: str | None,
+    answered_question_ids: Sequence[str],
+) -> dict[str, Any]:
+    if not session_id.strip():
+        raise ValueError("session_id must not be empty")
+    if len(session_id) > MAX_SESSION_ID_CHARS:
+        raise ValueError(f"session_id must not exceed {MAX_SESSION_ID_CHARS} characters")
+    if len(conversation_history) > MAX_HISTORY_MESSAGES:
+        raise ValueError(f"conversation_history must not exceed {MAX_HISTORY_MESSAGES} messages")
+    if len(answered_question_ids) > MAX_ANSWERED_QUESTIONS:
+        raise ValueError(f"answered_question_ids must not exceed {MAX_ANSWERED_QUESTIONS} entries")
+    if context is not None and len(context) > MAX_CONTEXT_CHARS:
+        raise ValueError(f"context must not exceed {MAX_CONTEXT_CHARS} characters")
+
+    messages = serialize_messages(conversation_history)
+    if not messages and not (context and context.strip()):
+        raise ValueError("provide conversation_history or context")
+    if messages and messages[-1]["role"] != "user":
+        raise ValueError("the last conversation message must have role='user'")
+
+    return {
+        "session_id": session_id,
+        "conversation_history": messages,
+        "context": context,
+        "answered_question_ids": list(answered_question_ids),
+    }
+
+
+def _conversion_payload(*, outcome: Outcome, metadata: Mapping[str, Any] | None) -> dict[str, Any]:
+    if outcome not in ("purchase", "lead", "abandon", "other"):
+        raise ValueError("outcome must be purchase, lead, abandon or other")
+    metadata_payload = dict(metadata or {})
+    try:
+        metadata_size = len(json.dumps(metadata_payload, ensure_ascii=False).encode("utf-8"))
+    except (TypeError, ValueError) as exc:
+        raise ValueError("metadata must be JSON serializable") from exc
+    if metadata_size > MAX_METADATA_BYTES:
+        raise ValueError(f"metadata must not exceed {MAX_METADATA_BYTES} bytes when serialized")
+    return {"outcome": outcome, "metadata": metadata_payload}
+
+
+def _idempotency_key(value: str | None) -> str:
+    if value is not None:
+        if not value.strip():
+            raise ValueError("idempotency_key must not be empty")
+        return value
+    return str(uuid.uuid4())
+
+
+def _retry_delay(response: httpx.Response | None, attempt: int) -> float:
+    if response is not None:
+        retry_after = response.headers.get("Retry-After")
+        if retry_after is not None:
+            try:
+                return min(max(float(retry_after), 0.0), 10.0)
+            except ValueError:
+                pass
+    return float(min(0.25 * (2**attempt), 2.0))
+
+
+def _response_payload(response: httpx.Response) -> Mapping[str, Any]:
+    try:
+        payload = response.json()
+    except ValueError as exc:
+        raise api_error_from_payload(
+            status_code=response.status_code,
+            payload={"detail": "NBQ API returned a non-JSON response"},
+            request_id=response.headers.get("X-Request-Id"),
+        ) from exc
+    if not isinstance(payload, Mapping):
+        raise api_error_from_payload(
+            status_code=response.status_code,
+            payload={"detail": "NBQ API returned an invalid JSON payload"},
+            request_id=response.headers.get("X-Request-Id"),
+        )
+    return cast(Mapping[str, Any], payload)
+
+
+def _raise_for_api_error(response: httpx.Response) -> None:
+    if response.is_success:
+        return
+    payload: Mapping[str, Any] | None
+    try:
+        raw = response.json()
+        payload = cast(Mapping[str, Any], raw) if isinstance(raw, Mapping) else None
+    except ValueError:
+        payload = None
+    request_id = response.headers.get("X-Request-Id")
+    if payload and payload.get("request_id"):
+        request_id = str(payload["request_id"])
+    raise api_error_from_payload(
+        status_code=response.status_code,
+        payload=payload,
+        request_id=request_id,
+    )
+
+
+class NBQClient:
+    """Blocking client for the hosted NBQ runtime API."""
+
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = DEFAULT_TIMEOUT_SECONDS,
+        max_retries: int = DEFAULT_MAX_RETRIES,
+        transport: httpx.BaseTransport | None = None,
+    ) -> None:
+        _validate_settings(api_key, base_url, timeout, max_retries)
+        self._max_retries = max_retries
+        self._http = httpx.Client(
+            base_url=base_url.rstrip("/"),
+            headers=_request_headers(api_key),
+            timeout=timeout,
+            transport=transport,
+        )
+
+    def __enter__(self) -> NBQClient:
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.close()
+
+    def close(self) -> None:
+        self._http.close()
+
+    def _post(
+        self, path: str, *, payload: Mapping[str, Any], idempotency_key: str
+    ) -> httpx.Response:
+        response: httpx.Response | None = None
+        for attempt in range(self._max_retries + 1):
+            try:
+                response = self._http.post(
+                    path,
+                    json=payload,
+                    headers={"Idempotency-Key": idempotency_key},
+                )
+            except httpx.TransportError as exc:
+                if attempt >= self._max_retries:
+                    raise NBQConnectionError("Unable to reach the NBQ API") from exc
+                time.sleep(_retry_delay(None, attempt))
+                continue
+
+            if response.status_code not in RETRIABLE_STATUS_CODES or attempt >= self._max_retries:
+                break
+            time.sleep(_retry_delay(response, attempt))
+
+        assert response is not None
+        _raise_for_api_error(response)
+        return response
+
+    def next_question(
+        self,
+        *,
+        session_id: str,
+        conversation_history: Sequence[MessageInput] = (),
+        context: str | None = None,
+        answered_question_ids: Sequence[str] = (),
+        idempotency_key: str | None = None,
+    ) -> NextQuestionsResponse:
+        """Return the next best question for a conversation."""
+
+        response = self._post(
+            "/v1/next-questions",
+            payload=_next_payload(
+                session_id=session_id,
+                conversation_history=conversation_history,
+                context=context,
+                answered_question_ids=answered_question_ids,
+            ),
+            idempotency_key=_idempotency_key(idempotency_key),
+        )
+        return NextQuestionsResponse.from_payload(_response_payload(response))
+
+    def report_conversion(
+        self,
+        *,
+        session_id: str,
+        outcome: Outcome,
+        metadata: Mapping[str, Any] | None = None,
+        idempotency_key: str | None = None,
+    ) -> ConversionResponse:
+        """Report the final business outcome of a conversation."""
+
+        if not session_id.strip():
+            raise ValueError("session_id must not be empty")
+        if len(session_id) > MAX_SESSION_ID_CHARS:
+            raise ValueError(f"session_id must not exceed {MAX_SESSION_ID_CHARS} characters")
+        response = self._post(
+            f"/v1/sessions/{quote(session_id, safe='')}/conversion",
+            payload=_conversion_payload(outcome=outcome, metadata=metadata),
+            idempotency_key=_idempotency_key(idempotency_key),
+        )
+        return ConversionResponse.from_payload(_response_payload(response))
+
+
+class AsyncNBQClient:
+    """Async client for the hosted NBQ runtime API."""
+
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = DEFAULT_TIMEOUT_SECONDS,
+        max_retries: int = DEFAULT_MAX_RETRIES,
+        transport: httpx.AsyncBaseTransport | None = None,
+    ) -> None:
+        _validate_settings(api_key, base_url, timeout, max_retries)
+        self._max_retries = max_retries
+        self._http = httpx.AsyncClient(
+            base_url=base_url.rstrip("/"),
+            headers=_request_headers(api_key),
+            timeout=timeout,
+            transport=transport,
+        )
+
+    async def __aenter__(self) -> AsyncNBQClient:
+        return self
+
+    async def __aexit__(self, *_: object) -> None:
+        await self.close()
+
+    async def close(self) -> None:
+        await self._http.aclose()
+
+    async def _post(
+        self, path: str, *, payload: Mapping[str, Any], idempotency_key: str
+    ) -> httpx.Response:
+        response: httpx.Response | None = None
+        for attempt in range(self._max_retries + 1):
+            try:
+                response = await self._http.post(
+                    path,
+                    json=payload,
+                    headers={"Idempotency-Key": idempotency_key},
+                )
+            except httpx.TransportError as exc:
+                if attempt >= self._max_retries:
+                    raise NBQConnectionError("Unable to reach the NBQ API") from exc
+                await asyncio.sleep(_retry_delay(None, attempt))
+                continue
+
+            if response.status_code not in RETRIABLE_STATUS_CODES or attempt >= self._max_retries:
+                break
+            await asyncio.sleep(_retry_delay(response, attempt))
+
+        assert response is not None
+        _raise_for_api_error(response)
+        return response
+
+    async def next_question(
+        self,
+        *,
+        session_id: str,
+        conversation_history: Sequence[MessageInput] = (),
+        context: str | None = None,
+        answered_question_ids: Sequence[str] = (),
+        idempotency_key: str | None = None,
+    ) -> NextQuestionsResponse:
+        """Return the next best question for a conversation."""
+
+        response = await self._post(
+            "/v1/next-questions",
+            payload=_next_payload(
+                session_id=session_id,
+                conversation_history=conversation_history,
+                context=context,
+                answered_question_ids=answered_question_ids,
+            ),
+            idempotency_key=_idempotency_key(idempotency_key),
+        )
+        return NextQuestionsResponse.from_payload(_response_payload(response))
+
+    async def report_conversion(
+        self,
+        *,
+        session_id: str,
+        outcome: Outcome,
+        metadata: Mapping[str, Any] | None = None,
+        idempotency_key: str | None = None,
+    ) -> ConversionResponse:
+        """Report the final business outcome of a conversation."""
+
+        if not session_id.strip():
+            raise ValueError("session_id must not be empty")
+        if len(session_id) > MAX_SESSION_ID_CHARS:
+            raise ValueError(f"session_id must not exceed {MAX_SESSION_ID_CHARS} characters")
+        response = await self._post(
+            f"/v1/sessions/{quote(session_id, safe='')}/conversion",
+            payload=_conversion_payload(outcome=outcome, metadata=metadata),
+            idempotency_key=_idempotency_key(idempotency_key),
+        )
+        return ConversionResponse.from_payload(_response_payload(response))

nbq-0.9.0/python/src/nbq/errors.py

@@ -0,0 +1,85 @@
+"""Exceptions raised by the NBQ SDK."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any
+
+
+class NBQError(Exception):
+    """Base class for every SDK error."""
+
+
+class NBQConnectionError(NBQError):
+    """The API could not be reached after retrying."""
+
+
+class NBQAPIError(NBQError):
+    """The NBQ API returned an unsuccessful response."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: int,
+        request_id: str | None = None,
+        error_type: str | None = None,
+        detail: Any = None,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.request_id = request_id
+        self.error_type = error_type
+        self.detail = detail
+
+
+class NBQAuthenticationError(NBQAPIError):
+    """The runtime credential is missing, invalid or not authorised."""
+
+
+class NBQValidationError(NBQAPIError):
+    """The request does not satisfy the API contract."""
+
+
+class NBQConflictError(NBQAPIError):
+    """An idempotency key or future state version conflicts."""
+
+
+class NBQRateLimitError(NBQAPIError):
+    """The runtime credential exceeded its rate limit."""
+
+
+class NBQServerError(NBQAPIError):
+    """The NBQ service failed to process the request."""
+
+
+def api_error_from_payload(
+    *, status_code: int, payload: Mapping[str, Any] | None, request_id: str | None
+) -> NBQAPIError:
+    data = payload or {}
+    title = data.get("title")
+    detail = data.get("detail")
+    error_type = data.get("type")
+    message = str(title or detail or f"NBQ API request failed with status {status_code}")
+
+    error_class: type[NBQAPIError]
+    if status_code in (401, 403):
+        error_class = NBQAuthenticationError
+    elif status_code == 409:
+        error_class = NBQConflictError
+    elif status_code == 422:
+        error_class = NBQValidationError
+    elif status_code == 429:
+        error_class = NBQRateLimitError
+    elif status_code >= 500:
+        error_class = NBQServerError
+    else:
+        error_class = NBQAPIError
+
+    return error_class(
+        message,
+        status_code=status_code,
+        request_id=request_id,
+        error_type=str(error_type) if error_type is not None else None,
+        detail=detail,
+    )

nbq-0.9.0/python/src/nbq/models.py

@@ -0,0 +1,99 @@
+"""Public data models returned by the NBQ runtime API."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping, Sequence
+from dataclasses import dataclass
+from typing import Any, Literal, TypeAlias, cast
+
+Role: TypeAlias = Literal["user", "assistant"]
+Outcome: TypeAlias = Literal["purchase", "lead", "abandon", "other"]
+
+MAX_MESSAGE_CHARS = 2000
+
+
+@dataclass(frozen=True, slots=True)
+class Message:
+    """A conversation message accepted by the NBQ runtime API."""
+
+    role: Role
+    content: str
+
+    def __post_init__(self) -> None:
+        if self.role not in ("user", "assistant"):
+            raise ValueError("role must be 'user' or 'assistant'")
+        if not self.content.strip():
+            raise ValueError("content must not be empty")
+        if len(self.content) > MAX_MESSAGE_CHARS:
+            raise ValueError(f"content must not exceed {MAX_MESSAGE_CHARS} characters")
+
+    def to_payload(self) -> dict[str, str]:
+        return {"role": self.role, "content": self.content}
+
+
+MessageInput: TypeAlias = Message | Mapping[str, str]
+
+
+@dataclass(frozen=True, slots=True)
+class NextQuestion:
+    external_id: str
+    text: str
+
+    @classmethod
+    def from_payload(cls, payload: Mapping[str, Any]) -> NextQuestion:
+        return cls(external_id=str(payload["external_id"]), text=str(payload["text"]))
+
+
+@dataclass(frozen=True, slots=True)
+class NextQuestionsResponse:
+    next_question: NextQuestion | None
+    exhausted: bool
+    nbq_version: str
+    request_id: str
+
+    @classmethod
+    def from_payload(cls, payload: Mapping[str, Any]) -> NextQuestionsResponse:
+        raw_question = payload.get("next_question")
+        question = (
+            NextQuestion.from_payload(cast(Mapping[str, Any], raw_question))
+            if isinstance(raw_question, Mapping)
+            else None
+        )
+        return cls(
+            next_question=question,
+            exhausted=bool(payload["exhausted"]),
+            nbq_version=str(payload["nbq_version"]),
+            request_id=str(payload["request_id"]),
+        )
+
+
+@dataclass(frozen=True, slots=True)
+class ConversionResponse:
+    conversion_id: str
+    request_id: str
+
+    @classmethod
+    def from_payload(cls, payload: Mapping[str, Any]) -> ConversionResponse:
+        return cls(
+            conversion_id=str(payload["conversion_id"]),
+            request_id=str(payload["request_id"]),
+        )
+
+
+def serialize_messages(messages: Sequence[MessageInput]) -> list[dict[str, str]]:
+    result: list[dict[str, str]] = []
+    for message in messages:
+        if isinstance(message, Message):
+            result.append(message.to_payload())
+            continue
+
+        role = message.get("role")
+        content = message.get("content")
+        if role not in ("user", "assistant"):
+            raise ValueError("each message role must be 'user' or 'assistant'")
+        if not content or not content.strip():
+            raise ValueError("each message content must not be empty")
+        if len(content) > MAX_MESSAGE_CHARS:
+            raise ValueError(f"each message content must not exceed {MAX_MESSAGE_CHARS} characters")
+        result.append({"role": role, "content": content})
+    return result