qveris 0.2.0__tar.gz

qveris-0.2.0/.env.example

@@ -0,0 +1,6 @@
+QVERIS_BASE_URL=https://qveris.ai/api/v1
+QVERIS_API_KEY=<your_qveris_api_key>
+OPENAI_API_KEY=<your_openai_api_key>
+OPENAI_BASE_URL=https://openrouter.ai/api/v1
+HTTP_PROXY=
+DEBUG=false

qveris-0.2.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

qveris-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 QVerisAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qveris-0.2.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: qveris
+Version: 0.2.0
+Summary: QVeris Python SDK for agent capability discovery, calling, and audit
+Author-email: QVeris Team <contact@qveris.ai>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator==0.26.3; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: python-dotenv; extra == 'dev'
+Requires-Dist: rich>=13.0.0; extra == 'dev'

qveris-0.2.0/README.md

@@ -0,0 +1,188 @@
+# QVeris Python SDK
+
+Async Python SDK for the QVeris Agent External Data & Tool Harness workflow: discover, inspect, call, and audit real-world capabilities from your own agents or applications.
+
+## Install
+
+```bash
+pip install qveris
+```
+
+For local development in this monorepo:
+
+```bash
+cd packages/python-sdk
+uv run --extra dev python -m pytest
+```
+
+## Configuration
+
+```bash
+export QVERIS_API_KEY="sk-..."
+```
+
+`QverisConfig` also accepts explicit values:
+
+```python
+from qveris import QverisClient, QverisConfig
+
+client = QverisClient(QverisConfig(api_key="sk-...", base_url="https://qveris.ai/api/v1"))
+```
+
+## Canonical Workflow
+
+```python
+import asyncio
+from qveris import QverisClient
+
+async def main():
+    client = QverisClient()
+    try:
+        discovered = await client.discover("weather forecast API", limit=5)
+        tool = discovered.results[0]
+
+        inspected = await client.inspect([tool.tool_id], search_id=discovered.search_id)
+        selected = inspected.results[0]
+
+        params = selected.examples.sample_parameters if selected.examples else {"city": "London"}
+        result = await client.call(
+            selected.tool_id,
+            params,
+            search_id=discovered.search_id,
+            max_response_size=20480,
+        )
+
+        usage = await client.usage(execution_id=result.execution_id, summary=True)
+        ledger = await client.ledger(summary=True, limit=5)
+
+        print(result.success, result.billing, usage.total, ledger.total)
+    finally:
+        await client.close()
+
+asyncio.run(main())
+```
+
+First-class typed APIs:
+
+| Method | REST endpoint | Purpose |
+|--------|---------------|---------|
+| `discover(query, ...)` | `POST /search` | Find capabilities with natural language |
+| `inspect(tool_ids, ...)` | `POST /tools/by-ids` | Fetch full capability metadata |
+| `call(tool_id, parameters, ...)` | `POST /tools/execute` | Execute a selected capability |
+| `usage(...)` | `GET /auth/usage/history/v2` | Audit request status and charge outcome |
+| `ledger(...)` | `GET /auth/credits/ledger` | Inspect final credit balance movements |
+
+Backward-compatible aliases remain available: `search_tools`, `get_tools_by_ids`, and `execute_tool`.
+
+## Typed Models
+
+The SDK exposes Pydantic v2 models for the main QVeris Agent External Data & Tool Harness surfaces:
+
+- Capability metadata: `ToolInfo`, `ToolParameter`, `ToolStats`
+- Billing: `BillingRule`, `CompactBillingStatement`, `BillingChargeLine`
+- Execution: `ToolExecutionResponse`
+- Audit: `UsageHistoryResponse`, `UsageEventItem`
+- Credits ledger: `CreditsLedgerResponse`, `CreditsLedgerItem`
+
+Models allow additive API fields so newer backend metadata does not break older SDK clients.
+
+## Agent Runtime
+
+`qveris.Agent` wraps the same workflow into an LLM tool loop. It exposes canonical `discover`, `inspect`, and `call` tool definitions to OpenAI-compatible providers.
+
+```python
+import asyncio
+from qveris import Agent, Message
+
+async def main():
+    agent = Agent()
+    try:
+        messages = [Message(role="user", content="Find a weather capability and explain its parameters.")]
+        async for event in agent.run(messages):
+            if event.type == "content" and event.content:
+                print(event.content, end="", flush=True)
+    finally:
+        await agent.close()
+
+asyncio.run(main())
+```
+
+Set `OPENAI_API_KEY` and optional `OPENAI_BASE_URL` for the default OpenAI-compatible provider, or pass your own `LLMProvider`.
+
+## Integration Patterns
+
+Use the SDK at the level that matches your application:
+
+- Direct typed client: call `discover`, `inspect`, `call`, `usage`, and `ledger` from your own code.
+- Built-in streaming agent: use `Agent.run(messages)` and consume `StreamEvent` values for content, tool calls, tool results, metrics, and errors.
+- Built-in non-streaming agent: use `Agent.run(messages, stream=False)` when your UI wants complete assistant turns plus events.
+- Final text only: use `Agent.run_to_completion(messages)`.
+- Bring your own loop: pass `DISCOVER_TOOL_DEF`, `INSPECT_TOOL_DEF`, and `CALL_TOOL_DEF` to your LLM provider, then route tool calls through `QverisClient.handle_tool_call(...)`.
+
+## Custom LLM Providers
+
+The default `Agent()` uses the built-in OpenAI-compatible provider. For non-OpenAI-compatible model APIs, implement `LLMProvider` and pass it to `Agent`:
+
+```python
+from typing import AsyncGenerator, List
+from openai.types.chat import ChatCompletionToolParam
+from qveris import Agent
+from qveris.config import AgentConfig
+from qveris.llm.base import LLMProvider
+from qveris.types import ChatResponse, Message, StreamEvent
+
+class MyProvider(LLMProvider):
+    async def chat_stream(
+        self,
+        messages: List[Message],
+        tools: List[ChatCompletionToolParam],
+        config: AgentConfig,
+    ) -> AsyncGenerator[StreamEvent, None]:
+        ...
+
+    async def chat(
+        self,
+        messages: List[Message],
+        tools: List[ChatCompletionToolParam],
+        config: AgentConfig,
+    ) -> ChatResponse:
+        ...
+
+agent = Agent(llm_provider=MyProvider())
+```
+
+## Examples
+
+Five runnable examples are included under [`examples/`](examples):
+
+| Example | Scenario |
+|---------|----------|
+| `finance_research.py` | Stock quote / market data research |
+| `risk_compliance.py` | Sanctions, adverse media, or compliance screening |
+| `crypto_market.py` | Crypto price and volume data |
+| `data_analysis.py` | Dataset enrichment with external capability data |
+| `agent_loop_integration.py` | LLM agent loop integration |
+
+The capability examples run `discover` and `inspect` when `QVERIS_API_KEY` is set. They only execute `call` when `RUN_QVERIS_CALLS=1` is set.
+
+## Tests
+
+```bash
+cd packages/python-sdk
+uv run python -m compileall qveris examples
+uv run --extra dev python -m pytest
+```
+
+Contract tests use `httpx.MockTransport` to validate SDK models against the REST API shapes for discover, inspect, call, usage, and ledger without consuming credits.
+
+## Compatibility and Release Policy
+
+- Python: `>=3.8`
+- Runtime dependencies: `httpx`, `pydantic`, `pydantic-settings`, `openai`
+- Public methods and Pydantic model fields follow additive compatibility where possible.
+- Deprecated aliases remain for at least one minor release after canonical replacements are available.
+- Breaking API changes require a major version bump and migration notes in this README.
+
+## License
+
+MIT

qveris-0.2.0/examples/_shared.py

@@ -0,0 +1,72 @@
+import os
+from typing import Any, Dict, Optional
+
+from qveris import QverisClient, ToolInfo
+
+
+def require_api_key() -> bool:
+    if os.getenv("QVERIS_API_KEY"):
+        return True
+    print("Set QVERIS_API_KEY to run this example against the QVeris API.")
+    return False
+
+
+def should_call() -> bool:
+    return os.getenv("RUN_QVERIS_CALLS") == "1"
+
+
+def sample_parameters(tool: ToolInfo, fallback: Dict[str, Any]) -> Dict[str, Any]:
+    if tool.examples and tool.examples.sample_parameters:
+        return tool.examples.sample_parameters
+    return fallback
+
+
+async def preview_capability(
+    query: str,
+    fallback_params: Dict[str, Any],
+    *,
+    limit: int = 5,
+    max_response_size: Optional[int] = 4096,
+) -> None:
+    if not require_api_key():
+        return
+
+    client = QverisClient()
+    try:
+        discovered = await client.discover(query, limit=limit)
+        print(f"search_id: {discovered.search_id}")
+        print(f"matches: {len(discovered.results)} / total={discovered.total}")
+        if not discovered.results:
+            return
+
+        tool = discovered.results[0]
+        inspected = await client.inspect([tool.tool_id], search_id=discovered.search_id)
+        tool = inspected.results[0] if inspected.results else tool
+        print(f"selected: {tool.tool_id} - {tool.name or tool.description or 'unnamed'}")
+        if tool.stats:
+            print(f"quality: success_rate={tool.stats.success_rate} latency_ms={tool.stats.avg_execution_time_ms}")
+        if tool.billing_rule:
+            print(f"billing: {tool.billing_rule.description or tool.billing_rule.metering_mode}")
+
+        params = sample_parameters(tool, fallback_params)
+        print(f"params: {params}")
+        if not should_call():
+            print("Set RUN_QVERIS_CALLS=1 to execute the selected capability.")
+            return
+
+        result = await client.call(
+            tool.tool_id,
+            params,
+            search_id=discovered.search_id,
+            max_response_size=max_response_size,
+        )
+        print(f"execution_id: {result.execution_id}")
+        print(f"success: {result.success}")
+        print(f"billing: {result.billing.summary if result.billing else None}")
+        print(f"result: {result.result}")
+        usage = await client.usage(execution_id=result.execution_id, summary=True, limit=5)
+        print(f"usage_records: {usage.total}")
+        ledger = await client.ledger(summary=True, limit=5)
+        print(f"ledger_records: {ledger.total}")
+    finally:
+        await client.close()

qveris-0.2.0/examples/agent_loop_integration.py

@@ -0,0 +1,35 @@
+"""Minimal agent loop integration using the built-in QVeris Agent."""
+
+import asyncio
+import os
+
+from qveris import Agent, Message
+
+
+async def main() -> None:
+    if not os.getenv("QVERIS_API_KEY") or not os.getenv("OPENAI_API_KEY"):
+        print("Set QVERIS_API_KEY and OPENAI_API_KEY to run the agent loop example.")
+        return
+
+    agent = Agent()
+    try:
+        messages = [
+            Message(
+                role="user",
+                content="Find a capability for current weather, inspect it if needed, then explain what parameters it needs.",
+            )
+        ]
+
+        async for event in agent.run(messages):
+            if event.type == "content" and event.content:
+                print(event.content, end="", flush=True)
+            elif event.type == "tool_call" and event.tool_call:
+                print(f"\n-> tool_call: {event.tool_call.get('function', {}).get('name')}")
+            elif event.type == "tool_result" and event.tool_result:
+                print("\n<- tool_result")
+    finally:
+        await agent.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

qveris-0.2.0/examples/crypto_market.py

@@ -0,0 +1,16 @@
+"""Crypto market data workflow for token prices and exchange metrics."""
+
+import asyncio
+
+from _shared import preview_capability
+
+
+async def main() -> None:
+    await preview_capability(
+        "cryptocurrency market price and volume API",
+        {"symbol": "BTC", "currency": "USD"},
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

qveris-0.2.0/examples/data_analysis.py

@@ -0,0 +1,16 @@
+"""Data analysis workflow for enriching a dataset with a discovered capability."""
+
+import asyncio
+
+from _shared import preview_capability
+
+
+async def main() -> None:
+    await preview_capability(
+        "company domain enrichment API",
+        {"domain": "qveris.ai"},
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

qveris-0.2.0/examples/finance_research.py

@@ -0,0 +1,16 @@
+"""Finance research workflow using discover, inspect, call, usage, and ledger."""
+
+import asyncio
+
+from _shared import preview_capability
+
+
+async def main() -> None:
+    await preview_capability(
+        "public company stock quote and market data API",
+        {"symbol": "AAPL"},
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())