Compare commits

..
Author SHA1 Message Date
james.maes 57673131ff Merge remote-tracking branch 'origin/develop' into feature/answer-presentation 2026-10-13 19:54:07 -05:00
james.maesandClaude Opus 5.5 c27994c432 feat: answer presentation: present_results tool, presentation parts and the default presentation skill
Owner priority: answers must be easy to read and act on.

- present_results tool: summary, metrics, table (computed percent
  columns, per-row filtered-list links), bar/pie/line chart from the
  table, filter and record links, follow-up actions. Every table and
  field is checked against what the user can see through the UI API;
  hrefs (/app/<table>?filter=<QQQ filter JSON>, records) and number
  formats are built server-side from metadata; the model never writes
  URLs.
- presentation message part (persisted, SSE event) with a server-built
  multi-line GFM markdown fallback for clients without blocks.
- Static system-prompt Presentation section (built-in default skill):
  answer first, no restating, tables for 3+ items, charts for shares and
  trends, filterLinks whenever a list is offered.
- Golden eval of the owner's example: summary, 2-row table with 80.2% /
  19.8%, a 2-point pie and two mimeType filter links; negative cases.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 19:54:05 -05:00
james.maes 14bd4e377c Merge pull request #31 from QRun-IO/fix/core-alerts-rc5
refactor: budget alerts through core QAlerts on QQQ RC.5 (#28)
2026-10-13 19:34:21 -05:00
james.maesandClaude Opus 5.5 cb7d5d4d5a refactor: budget alerts through core QAlerts (QQQ 4.1.0-RC.5), alert types declared
Closes #28 (first half; the DataClassification and loopback gateway
stand-ins go with RC.6).

- Default QQQ is 4.1.0-RC.5.
- BudgetAlerts calls QAlerts.raise(AlertSignal...) directly instead of
  binding by reflection.
- The producer declares assistant.budget.warning, .downgraded and .stopped
  as QAlertTypeMetaData (assistant.admin, subject assistant_budget).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 19:30:01 -05:00
james.maes 51e0692f46 Merge pull request #27 from QRun-IO/feature/p5-routing-fallback
feat: simple/complex model routing and fallback chains (P-e)
2026-10-13 19:13:26 -05:00
james.maes 6f80dcaff4 Merge remote-tracking branch 'origin/develop' into feature/p5-routing-fallback 2026-10-13 19:09:28 -05:00
james.maesandClaude Opus 5.5 55804d9059 feat: simple/complex model routing and fallback chains across providers (P-e)
- Profiles gain routing (OFF, HEURISTIC, CLASSIFIER) with simple, complex
  and classifier models. The heuristic is a small documented rule set; the
  classifier is one 4-token call on the question text only (ROUTE usage,
  3 s timeout, heuristic on any failure, skipped for PHI on a
  non-eligible provider).
- assistant_model.fallback_model_id chains (cycle-checked, max 4 hops)
  across providers; retryable failures before any output fall back.
  Candidates that are disabled, down, over a STOP budget or fail the PHI
  rule are skipped; without a chain, LOCAL falls back only to LOCAL.
- Circuit breaker (provider health UP/DOWN, down_until) and a cached
  health probe for stale LOCAL providers.
- A mid-turn provider switch rebuilds history from neutral parts and drops
  adapter state (Anthropic thinking signatures).
- Turn route decision, source and fallback count; home shows health and
  fallbacks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 19:09:26 -05:00
james.maes 73159e536e Merge pull request #26 from QRun-IO/feature/p4-budgets
feat: budgets with warn, downgrade, stop and admin overrides (P-d)
2026-10-13 18:46:19 -05:00
james.maes c05c606745 Merge remote-tracking branch 'origin/develop' into feature/p4-budgets 2026-10-13 18:43:47 -05:00
james.maesandClaude Opus 5.5 51fcfa6a33 feat: data-driven budgets with warn, downgrade, stop and admin overrides (P-d)
- assistant_budget (scope INSTANCE/USER/ROLE/PROVIDER/MODEL, DAY/MONTH,
  cost or tokens, warn %, DOWNGRADE or STOP at 100%, hard ceiling),
  assistant_budget_override (reason, grantor, expiry) and
  assistant_budget_event (deduplicated WARNED/DOWNGRADED/STOPPED).
- BudgetService checks before every model call; strictest outcome wins.
  Warnings raise a panel notice and an optional Alerts signal; downgrade
  prefers a cheaper LOCAL model and never crosses the PHI rule.
- assistant_budget_usage: an owner-lock-free accounting projection of
  usage counters so shared-scope sums run under the caller's own session.
- App home: budgets card with state and overrides, 30-day cost and token
  bars with user, model, provider and tool breakdowns.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 18:43:45 -05:00
james.maes 8a7c10fde4 Merge pull request #24 from QRun-IO/feature/p3-hipaa-routing
feat: data classification, PHI routing and HIPAA mode (P-c, stacked on #23)
2026-10-13 18:23:37 -05:00
james.maesandClaude Opus 5.5 d15c7dce12 feat: data classification, PHI routing and HIPAA mode (P-c)
- DataClassification (PUBLIC < CONFIDENTIAL < PII < PHI): a qbit
  stand-in for core's (QRun-IO/qqq#1142) behind a pluggable
  ClassificationSource (config by default; core metadata or
  qbit-secured-data overrides later).
- Each turn tracks the highest classification its page context, history
  and tool results touched (turn.classification, conversation
  max_classification, never lowered).
- PhiRoutingGuard before EVERY model call: PHI only to hipaa_eligible
  provider rows; otherwise the turn ends PHI_BLOCKED with the reason and
  the tool results are never sent.
- HIPAA mode: no non-eligible providers (resolve, enable, code fallback),
  AES-256-GCM conversation storage (key by env-var reference, required),
  PHI retention period, no provider messages or stack traces in logs.
- assistant_data_audit: one row per model call that carried PII/PHI and
  per block (who, classification, tables, provider, model, decision).
- System rule 11: masked values stay masked; never ask to reveal them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 18:20:13 -05:00
james.maes e8c202ace6 Merge pull request #23 from QRun-IO/feature/p2-bedrock-vertex
feat: AWS Bedrock and Google Vertex adapters (P-b, stacked on #22)
2026-10-13 18:04:12 -05:00
james.maesandClaude Opus 5.5 95f0040748 fix: a cancelled stream ignores the worker's late complete/fail
cancel() closes the stream before it completes the handle, so the
worker's IOException could win and turn a cancel into a NETWORK error
(flaky OpenAiContractTest.timeoutCancelAndNetwork on CI).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 18:01:21 -05:00
james.maes 9dbb44b8c2 Merge pull request #22 from QRun-IO/feature/p1-provider-registry
feat: provider and model registry, OpenAI-compatible adapter, discovery and health (P-a)
2026-10-13 17:59:52 -05:00
james.maesandClaude Opus 5.5 34b0f67670 feat: Bedrock and Vertex kind labels
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 17:49:19 -05:00
james.maes 88e1081396 Merge remote-tracking branch 'origin/feature/p1-provider-registry' into feature/p2-bedrock-vertex 2026-10-13 17:47:42 -05:00
james.maesandClaude Opus 5.5 c9ccd4c79b feat: AWS Bedrock and Google Vertex adapters (P-b)
- qbit-assistant-provider-bedrock: Claude on Bedrock through the
  anthropic-java Bedrock backend (AnthropicMapping reused), credentials
  from the server's AWS default chain, region required, no key reference.
  IRSA/web identity needs the host to add software.amazon.awssdk:sts.
- qbit-assistant-provider-vertex: Claude on Vertex through the
  anthropic-java Vertex backend, Gemini through Vertex's OpenAI-compatible
  endpoint with an ADC bearer token refreshed per request (never strict).
  Region and the new cloud_project column are required.
- AnthropicModelProvider.Builder.client(...) and a bearer-token supplier
  on ProviderSettings / the OpenAI adapter.
- Mocked contract tests: a Bedrock event-stream mock with SigV4 checks,
  Vertex rawPredict and OpenAI-compatible mocks, validation, and a golden
  tool round trip per module.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 17:47:40 -05:00
james.maesandClaude Opus 5.5 311c37c23d fix(openai): a transport error at the deadline is a TIMEOUT, not a race with the guard
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 17:47:24 -05:00
james.maesandClaude Opus 5.5 a7be39db0f feat: readable labels for the provider registry; P-a demo server and screenshots
- Kind, source and field labels (HIPAA-eligible, API version, prices
  per million tokens, timeouts) instead of raw ids.
- Test-only OpenAiDemoServer: a mock OpenAI-compatible host, real
  Discover models / Test connection runs and one turn.
- Screenshots of the home providers card, a local provider, its Models
  child list and a model, light and dark at 390 and 1440 px.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 17:33:43 -05:00
james.maesandClaude Opus 5.5 8d869f65cd feat: provider and model registry, OpenAI-compatible adapter, discovery and health (P-a)
- assistant_provider gains kind, location, hipaa_eligible, region, api
  version, timeouts, a CA bundle reference and discovery status.
- New assistant_model table (child list on the provider): capabilities,
  prices per million tokens, enabled flag, last test.
- Provider SPI: ProviderSettings, kinds, discovery and health as default
  methods; create(apiKey, baseUrl) implementations keep working.
- New module qbit-assistant-provider-openai: OpenAI, Azure OpenAI,
  OpenRouter, Ollama, LM Studio, vLLM and llama.cpp over JDK HTTP, with
  streaming, tool calls, usage, timeouts, cancel, strict only where
  supported (and the existing fallback on refusal), keyless local
  endpoints and per-provider private CA trust.
- Record actions: Discover models (provider), Test connection (model);
  provider Test connection checks health first.
- Mock-server contract tests, a golden tool round trip, TLS tests and a
  config-driven live check (skipped unless configured).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 17:17:39 -05:00
james.maes 4532098e6b Merge pull request #20 from QRun-IO/feature/spec-providers-write-mode-wall
docs: spec for write mode, the config wall, audit attribution and providers
2026-10-13 16:29:02 -05:00
james.maesandClaude Opus 5.5 f2eb20a8bc docs: spec for write mode, the config wall, audit attribution and providers
Owner decisions (2026-10-13), continued, with all recommendations
accepted:
- write mode per conversation (Read-only by default), user preference,
  admin policy, confirmed writes, auto-confirm rules;
- the hard wall: the assistant client channel is denied every assistant_*
  object and the security surfaces in core, plus a startup check;
- audit attribution: the human actor plus via=assistant/<turnId>;
- providers and models as data (OpenAI-compatible, Bedrock, Vertex),
  local models, HIPAA/PHI routing, budgets, routing, RAG and scheduled
  tasks.
Also the phase plan and its dependencies.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 16:20:43 -05:00
james.maes 3721a69637 Merge pull request #18 from QRun-IO/feature/demo-pending-card
test(demo): the panel proposes a page change; card screenshots
2026-10-13 14:44:50 -05:00
james.maes 501d067415 Merge pull request #17 from QRun-IO/feature/release-rc-automation
ci: automate RC releases; hotfix/* pushes no longer publish
2026-10-13 14:42:49 -05:00
james.maesandClaude Opus 5.5 0f34c8a1dc test(demo): the panel proposes a page change; screenshots of the card
The demo queues recorded answers that propose update_record on page 12
(READ_WRITE), so a question in the panel shows the confirmation card;
Save runs it through PATCH /qqq/v1/table/page/12 with the user's session.
Screenshots of the persona, the pending card and the confirmed write
(light/dark, 390/1440), taken locally against the demo server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 14:34:36 -05:00
james.maes 5f5d6c5b38 Merge pull request #16 from QRun-IO/feature/demo-screens
fix: log denied tool calls against their table; demo persona and data access; screenshots
2026-10-13 14:29:39 -05:00
james.maesandClaude Opus 5.5 b0a6b648bf ci: automate RC releases; hotfix/* pushes no longer publish
Removes publish_hotfix_release: a hotfix/* branch push published a GA
release to Maven Central with no tag or review (QRun-IO/qbit-cdn#12,
QRun-IO/qqq#1121). hotfix/* branches now run test_only; a hotfix
release publishes from a reviewed vX.Y.Z tag through publish_release.
Adds .github/workflows/release-rc.yml (reusable QRun-IO/.github
qbit-release-rc): a manual dispatch, or merging a develop PR labelled
release:rc, merges develop into the release line and the release/* push
runs the existing CircleCI RC publish.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 14:29:30 -05:00
james.maesandClaude Opus 5.5 af811c99c2 fix: Explain access works before any assistant call, and degrades gracefully
- The route provider learns the server's local port from the first
  /qqq/v1 request (a before-handler), so the loopback UI API is known
  as soon as the UI has loaded, not only after an assistant call.
- The assistantAccess widget says why access could not be computed when
  the UI API is unreachable, instead of failing the dashboard.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 14:26:42 -05:00
james.maesandClaude Opus 5.5 6634d88286 fix: log denied tool calls against their table; demo seeds persona and data access
- The tool's table is recorded before the call, so a call the UI API
  refuses still names its table in the log and in Recent denials.
- AssistantDemoServer seeds a default profile (Ada), an analysts profile,
  two skills (one linked) and data access rows (page READ_WRITE,
  media NONE).
- Screenshots of the Recent denials card, Explain access widget, Data
  access table, profile, skill and policy (light/dark, 390/1440).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 14:24:30 -05:00
james.maes b5484bace8 Merge pull request #15 from QRun-IO/feature/profiles-skills-access
feat: profiles, skills, explain access and recent denials (phase c)
2026-10-13 14:13:40 -05:00
james.maesandClaude Opus 5.5 0babaa7022 feat: profiles, skills, explain access and recent denials
Owner (2026-10-13): set a name, personality and extra skills for the
assistant, and the assistant stays limited to the UI API and to what the
signed-in user could do through it.

- assistant_profile (persona: display name, icon, bounded personality,
  greeting, starter prompts; default, app- or permission-scoped) and
  assistant_skill (admin Markdown instruction packs, read only when
  relevant, bounded) linked by assistant_profile_skill. Text only: it
  goes into the per-user system block and never reaches tool code.
- Explain access: GET /assistant/access and the assistantAccess home
  widget, per table and tool: allowed or why not, from GET /metaData with
  the user's own session plus data access and policy.
- Recent denials card on the Assistant home.
- Hard guarantee: ArchUnit forbids the tool / UI API / access packages
  from QQQ actions, the AI kernel and the profile/skill classes, and the
  store refuses any non-assistant_ table. A denial matrix proves query,
  get, insert, update and delete are denied identically via the UI API
  and via the assistant.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 14:10:47 -05:00
james.maes 96426ec95a Merge pull request #14 from QRun-IO/feature/ui-api-tools
feat!: assistant tools go through the /qqq/v1 UI API with the user's session (phase b)
2026-10-13 13:59:36 -05:00
189 changed files with 22159 additions and 276 deletions

No files matched your search

+1 -12
View File
@@ -22,7 +22,7 @@ workflows:
context: [qqq-maven-registry-credentials]
filters:
branches:
ignore: /(develop|release\/.*|hotfix\/.*)/
ignore: /(develop|release\/.*)/
publish_snapshot:
jobs:
@@ -58,14 +58,3 @@ workflows:
ignore: /.*/
tags:
only: [/^v\d+\.\d+\.\d+$/]
publish_hotfix_release:
jobs:
- qqq-orb/mvn_publish:
pre-steps:
- configure-package-install
context: [qqq-maven-registry-credentials]
branch_type: hotfix
filters:
branches:
only: [/hotfix\/.*/]
+25
View File
@@ -0,0 +1,25 @@
# Cut the next release candidate (QRun-IO/qqq docs/QRUN-QBIT-REPO-STANDARD.md, C6):
# run this workflow by hand, or merge a develop PR labelled `release:rc`. It merges develop into
# the release line and the release/* push runs CircleCI publish_release_candidate.
name: Release candidate
on:
workflow_dispatch:
inputs:
dry_run:
description: Print the plan without merging or creating branches
type: boolean
default: false
pull_request:
types: [closed]
branches: [develop]
permissions:
contents: write
jobs:
release-rc:
if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release:rc'))
uses: QRun-IO/.github/.github/workflows/qbit-release-rc.yml@main
with:
dry_run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run }}
+3
View File
@@ -19,3 +19,6 @@ dependency-reduced-pom.xml
/.env.local
/.cache/
.claude/settings.local.json
# Runtime output from every provider module
log/
+4 -1
View File
@@ -42,6 +42,9 @@ Always use the wrapper: Maven 3.10 cannot read the parent POM. The committed def
- `processes/`: `AssistantRetentionStep` and `TestConnectionProcess` (record action on `assistant_provider`).
- `engine/ProviderService` (active provider from `assistant_provider` rows, key references, prices), `UsageRecorder` (one `assistant_usage` row per model call), `ConnectionTest`.
- `qbit-assistant-provider-anthropic`: `AnthropicModelProvider` and `AnthropicMapping` (anthropic-java streaming).
- `qbit-assistant-provider-openai`: OpenAI-compatible Chat Completions, model discovery and health using JDK HTTP and Jackson.
- `qbit-assistant-provider-bedrock`: Claude through the Anthropic Bedrock backend, AWS default credentials and SigV4; IRSA/web-identity hosts supply STS.
- `qbit-assistant-provider-vertex`: Claude through the Anthropic Vertex backend and Gemini through OpenAI-compatible Chat Completions, with refreshed Google ADC tokens.
## Invariants (do not break)
@@ -90,4 +93,4 @@ QQQ style:
- `develop` publishes SNAPSHOTs.
- `release/*` publishes RCs; the orb bumps `<revision>` in the root POM.
- `v*` tags publish releases.
- Both modules and the parent POM publish. The flatten plugin resolves `${revision}`.
- All five modules and the parent POM publish. The flatten plugin resolves `${revision}`.
+50 -1
View File
@@ -1,9 +1,53 @@
# Changelog
## Unreleased - Answer presentation
- Add `present_results`: server-formatted metrics, tables, computed percentages,
charts and validated in-app filter/record/action links.
- Persist and stream presentation parts with a multi-line GFM fallback and
record-data retention; add a static default presentation skill.
- Add the owner's 81 JPEG / 20 PNG golden example, shared live eval coverage,
permission/formatting/input tests and strict-schema budget coverage.
## Unreleased - P-e
- Add per-profile heuristic/classifier model routing, with budgeted ROUTE usage.
- Add bounded cross-provider fallback chains, PHI-safe selection, neutral history
rebuilding, and a 60-second connection circuit breaker with cached local probes.
- Show provider health, fallback totals and turn routing; include additive schema
migration and admin record-screen controls.
## Unreleased - P-d
- Require QQQ RC.5 and send budget alerts directly through core QAlerts, with admin-visible alert type metadata and core sink tests.
- Admin budgets, expiring overrides, deduplicated warning/downgrade/stop events.
- Per-dispatch limits preserving PHI routing and existing caps.
- Home budget cards, 30-day cost/token bars and provider breakdowns.
## Unreleased — P-c
- Add configurable table/field classification, persistent turn/conversation maxima,
and PHI routing checks before every model call, with a safe blocked-turn reason.
- Add HIPAA mode, eligible-provider enforcement, AES-256-GCM conversation storage,
provider diagnostic redaction, and independent PHI conversation retention.
- Add owner-locked, admin read-only data routing audits and HIPAA status on the home.
- Keep QQQ RC.4 compatibility with a classification stand-in and core #1142 adapter seam.
All notable changes to this project are documented here. The format follows Keep a Changelog, and versions follow semantic versioning.
## [0.1.0] - Unreleased
- Add optional AWS Bedrock (Claude) and Google Vertex (Claude/Gemini) adapters using server credentials, static model discovery and allow-listed endpoint overrides. AWS IRSA/web-identity hosts supply STS themselves; no additional dependency is bundled.
- Add the provider `cloudProject` column, cloud settings validation, injected Anthropic clients and per-request OpenAI bearer-token suppliers. Vertex Gemini prefixes model ids and omits strict tools.
- Add localhost cloud contract tests and golden tool turns, including AWS binary event-stream framing, SigV4, token refresh and cloud HTTP error mapping.
- Add named, server-only CA bundles for HTTPS providers, additive JVM trust and sanitized TLS diagnostics; tolerate repeated/missing streamed tool identities and invalid arguments, with a golden tool round-trip test.
- Add the provider/model registry, per-model capabilities and prices, keyless local providers, discovery and health, and provider/model connection tests.
- Add the optional JDK HTTP OpenAI-compatible adapter for OpenAI, Azure, OpenRouter, Ollama, LM Studio, vLLM and llama.cpp, with strict-schema safeguards and localhost contract tests.
Phase 0/1 of the QQQ Assistant: read-only Q&A and navigation. Requires QQQ 4.1 with:
- the AI tool kernel (`qqq-backend-core` `actions.ai`, QRun-IO/qqq#1078)
- the developer-panel contract (QRun-IO/qqq#1076).
@@ -13,6 +57,11 @@ Phase 0/1 of the QQQ Assistant: read-only Q&A and navigation. Requires QQQ 4.1 w
- Tools: `list_tables`, `describe_table`, `query_records`, `count_records`, `get_record`, `search_records`, `render_widget`, `get_record_history`, and new **`create_record`, `update_record`, `delete_record`**.
### Added (0.1.0-RC.6)
- **Profiles** (`assistant_profile`, nav "Profiles"): display name, icon, personality (≤ 2,000 chars, appended to the per-user system block), greeting, starter prompts; one default, optional app / permission scope. `/assistant/config` returns `profile`.
- **Skills** (`assistant_skill`, nav "Skills", linked through `assistant_profile_skill`, a child list on profiles): admin-written Markdown instructions read only when relevant (keywords / apps), ≤ 6,000 chars each and 12,000 per question. Instructions only: they never grant tools, endpoints or access (ArchUnit-enforced).
- **Explain access**: `GET /qqq/v1/assistant/access?table=&prompt=` and the `assistantAccess` home widget: per table and tool, allowed or the reason.
- **Recent denials** card on the Assistant home.
- `AssistantStore` refuses any table that is not `assistant_*`; ArchUnit forbids the tool / UI API / access packages from using QQQ actions, the AI kernel or the profile and skill classes.
- **Data access** (`assistant_data_access`, nav table "Data access"): NONE / READ / READ_WRITE per table or process. Default: NONE for sensitive tables (AI exposure NONE; cannot be raised), READ for other tables, NONE for processes. It only narrows the UI API.
- **Pending actions** (`assistant_pending_action`): with confirmation on (the default), a write only proposes; `POST /qqq/v1/assistant/actions/{id}/confirm` runs it through the UI API with the confirming user's session, once; `.../reject`; `GET .../actions/{id}`. Child list on conversations.
- **Policy columns** on `assistant_policy`: `writesRequireConfirmation`, `allowedTools`, `maxRowsPerCall`, `redactPii`.
@@ -32,7 +81,7 @@ Phase 0/1 of the QQQ Assistant: read-only Q&A and navigation. Requires QQQ 4.1 w
### Added (0.1.0-RC.4)
- **Provider settings** (`assistant_provider`): type (registered `AssistantProviderType`s; `AnthropicProviderType` in the Anthropic module), model, enabled, default, base URL override, monthly cost cap, max output tokens per request, max concurrent requests, and the last connection test. The default enabled row is the active provider; with no rows the provider registered in code is used, so existing hosts keep working.
- **Key handling:** the key is never stored. A row names the environment variable that holds it (`apiKeyEnvName`, allow-listed); `apiKeyStatus` is computed on read (`Set • …abcd`) and dropped on save. A pasted key, an unrelated variable or an unlisted base URL is refused. New config: `withProviderType`, `allowedApiKeyEnvNames`, `allowedBaseUrls`, `withSecretResolver`, `providerTestTimeoutSeconds`.
- **Key handling:** the key is never stored. A row names the environment variable that holds it (`apiKeyEnvName`, allow-listed); `apiKeyStatus` is computed on read (`Set • …abcd`) and dropped on save. A pasted key, an unrelated variable or an unlisted base URL is refused. New config: `withProviderType`, `allowedApiKeyEnvNames`, `allowedBaseUrls`, `withSecretResolver`, `providerTestTimeoutSeconds`.
- **Test connection**, a record action on providers (standard streamed ETL Review and Result lines): one short live call, result saved on the row and recorded as a `TEST` usage row.
- **Per-call usage** (`assistant_usage`): one row per model call (turn steps and tests) with provider, model, status, error kind, HTTP status, latency, tokens and cost. Child list on conversations and providers.
- **Model prices** (`assistant_model_price`), editable, used for every call's cost; the reference DDL seeds the Anthropic list prices of 2026-10. The built-in `pricing` defaults now cover every current Claude model.
+8 -1
View File
@@ -42,6 +42,9 @@ Always use the wrapper: Maven 3.10 cannot read the parent POM. The committed def
- `processes/`: `AssistantRetentionStep` and `TestConnectionProcess` (record action on `assistant_provider`).
- `engine/ProviderService` (active provider from `assistant_provider` rows, key references, prices), `UsageRecorder` (one `assistant_usage` row per model call), `ConnectionTest`.
- `qbit-assistant-provider-anthropic`: `AnthropicModelProvider` and `AnthropicMapping` (anthropic-java streaming).
- `qbit-assistant-provider-openai`: OpenAI-compatible Chat Completions, model discovery and health using JDK HTTP and Jackson.
- `qbit-assistant-provider-bedrock`: Claude through the Anthropic Bedrock backend, AWS default credentials and SigV4; IRSA/web-identity hosts supply STS.
- `qbit-assistant-provider-vertex`: Claude through the Anthropic Vertex backend and Gemini through OpenAI-compatible Chat Completions, with refreshed Google ADC tokens.
## Invariants (do not break)
@@ -64,6 +67,10 @@ Always use the wrapper: Maven 3.10 cannot read the parent POM. The committed def
- **Logging:** never log message content, prompts, tool results or keys. Structured end-of-turn log only.
- **Thinking:** thinking is never streamed or stored. The Anthropic adapter keeps the raw assistant message (with signatures) only in memory, as `providerState`, for the tool loop.
- **Links:** only `/app` or `/app/...` hrefs are emitted (`TurnEngine.isAppHref`).
- **PHI routing:** PHI only to `hipaaEligible` providers; checked before every model call. Conversation classification never decreases.
- **HIPAA storage:** Conversation storage encrypted in HIPAA mode, only in `AssistantStore`; encryption keys are environment references and never logged or stored in tables.
- **Fallback:** fallback never crosses the PHI rule; never local-to-cloud by default. No retry after partial output from that call; provider switches rebuild neutral history without providerState.
- **Budgets:** budgets are checked before every model call; downgrade never crosses the PHI rule.
- **Kill switch:** read fresh before every model call and every tool step.
## Tests
@@ -92,4 +99,4 @@ QQQ style:
- `develop` publishes SNAPSHOTs.
- `release/*` publishes RCs; the orb bumps `<revision>` in the root POM.
- `v*` tags publish releases.
- Both modules and the parent POM publish. The flatten plugin resolves `${revision}`.
- All five modules and the parent POM publish. The flatten plugin resolves `${revision}`.
+246 -1
View File
@@ -9,7 +9,7 @@ Design spec: `QRun-IO/qqq` `docs/specs/2026-10-11-qqq-assistant-qbit-design.md`.
| `com.kingsrook.qbits:qbit-assistant` | The QBit: conversation tables, turn engine, `/qqq/v1/assistant` routes (JSON + Server-Sent Events), budgets, kill switch, the provider SPI, and a scripted provider for tests and demos. |
| `com.kingsrook.qbits:qbit-assistant-provider-anthropic` | The Claude provider (`com.anthropic:anthropic-java`). Add it to use Claude. The core QBit has no LLM SDK dependency. |
The data access itself is done by the AI tool kernel in QQQ core (`com.kingsrook.qqq.backend.core.actions.ai.AiToolKernel`). The kernel checks table permissions and exposure rules, applies record security, and caps and redacts what the model sees. Every tool result reaches the model wrapped as untrusted data.
Data tools call the QQQ UI API through `UiApiToolbox` and `UiApiGateway` with the signed-in user's session. The UI enforces permissions and record security; the assistant further narrows access and caps and redacts returned values. Data tool results reach the model wrapped as untrusted data. Only record-free navigation and help use the core AI tool kernel.
## Requirements
@@ -203,6 +203,7 @@ Base path `/qqq/v1/assistant`. Every request is authenticated through the app's
The stream sends these events, each with a `seq`:
- `message.start`, `text.delta`
- `tool.start`, `tool.result` (with `render` and `recordRefs`)
- `presentation` (`messageId`, `part`: summary, blocks and server-built GFM markdown)
- `ui.navigate`, `notice`
- `usage`, `message.end`
- `error`
@@ -253,6 +254,250 @@ The **live** evals run the same golden tasks against Claude. They are skipped un
ANTHROPIC_API_KEY=... ./mvnw verify -Dassistant.live=true -Dtest.excludedGroups= -Dgroups=live -Djacoco.skip=true -pl qbit-assistant-provider-anthropic -am
```
## Providers
Add `com.kingsrook.qbits:qbit-assistant-provider-openai` at the same version as
the QBit and register the adapter alongside any Anthropic adapter:
```java
config.withProviderType(new OpenAiCompatibleProviderType());
```
`OpenAiCompatibleProviderType` is in
`com.kingsrook.qbits.assistant.provider.openai`. Its installed type id is
`openai-compatible`; provider rows choose OPENAI, AZURE_OPENAI, OPENROUTER,
OLLAMA, LM_STUDIO, VLLM, LLAMA_CPP or OPENAI_COMPATIBLE as their kind.
- Local kinds use their localhost endpoint by default and need no key. Leave
`apiKeyEnvName` empty. An auth proxy can use an explicitly allowed key env name.
- Cloud defaults use `OPENAI_API_KEY`, `AZURE_OPENAI_API_KEY` or
`OPENROUTER_API_KEY`. Values stay in the host's secret store.
- An override must match an entry in `config.withAllowedBaseUrls(Set.of(...))`.
Azure and OPENAI_COMPATIBLE have no default URL and always require an entry.
Redirects are not followed. Azure uses the deployment model id and defaults
`apiVersion` to `2024-10-21`.
- **Discover models** adds a provider's Models child list; existing edits survive.
Large cloud catalogs (over 20 models) start disabled. **Test connection** is
available on both providers and models and records a TEST usage row.
- A selected registered model must be enabled. With no model selected, the first
enabled registry model wins; providers with no model rows retain legacy selection.
Registry prices override type/model prices, then configured prices. Unpriced
local models cost zero. Capabilities can be adjusted per registered model.
For Ollama behind a TLS proxy with a private CA and bearer authentication:
```java
config.withProviderType(new OpenAiCompatibleProviderType())
.withAllowedBaseUrls(Set.of("https://llm.example.lan:8443/v1"))
.withAllowedApiKeyEnvNames(Set.of("LOCAL_LLM_API_KEY"))
.withTrustedCaBundleFile("local-llm", Path.of("/etc/app/llm-root-ca.pem"));
```
Set `LOCAL_LLM_API_KEY` in the server environment from your secret store. In the
provider record choose kind `OLLAMA`, base URL `https://llm.example.lan:8443/v1`,
`apiKeyEnvName = LOCAL_LLM_API_KEY`, and `tlsCaBundle = local-llm`. Only the names
are stored. `withTrustedCaBundle("local-llm", pem)` also accepts one or more PEM
certificates directly at startup. Invalid PEM fails configuration immediately.
The named bundle adds to the JVM roots; hostname verification stays enabled.
Leave `tlsCaBundle` empty to use JVM trust alone. Restart after changing a CA file.
Default tests use localhost mocks. To exercise an existing development server,
set `ASSISTANT_LIVE_OPENAI_BASE_URL` and `ASSISTANT_LIVE_OPENAI_MODEL`, optionally
`ASSISTANT_LIVE_OPENAI_KIND` (default OLLAMA), `ASSISTANT_LIVE_OPENAI_KEY_ENV`
(the variable name containing the key), and `ASSISTANT_LIVE_OPENAI_CA_FILE`
(a PEM bundle path). Unset or unreachable endpoints, including TLS failures, skip
the live test. Run:
```sh
./mvnw verify -pl qbit-assistant-provider-openai -am -Dtest.excludedGroups= -Dgroups=live -Djacoco.skip=true
```
### AWS Bedrock (Claude)
Add `com.kingsrook.qbits:qbit-assistant-provider-bedrock` at the QBit version and
register `com.kingsrook.qbits.assistant.provider.bedrock.BedrockProviderType`:
```java
config.withProviderType(new BedrockProviderType());
```
Create a provider row with type `bedrock`, kind `BEDROCK`, and the required AWS
`region` (for example `us-east-1`). Leave `apiKeyEnvName` empty. The server uses
the AWS default credential chain: environment variables, profiles and container
credentials (ECS/EKS Pod Identity) work with the transitive dependencies.
**For IRSA / web-identity credentials, the host application must add
`software.amazon.awssdk:sts` to its runtime classpath**, matching the transitive
AWS SDK version. The default chain picks it up when present; this adapter does
not include STS or the full AWS SDK. Credentials are never stored in tables.
Leave the base URL empty for the SDK's
`https://bedrock-runtime.<region>.amazonaws.com` endpoint. Overrides, including
VPC endpoints, must be listed in `withAllowedBaseUrls`. Model ids are Bedrock
Claude ids or inference profile ids, for example
`us.anthropic.claude-sonnet-4-5-20250929-v1:0`. The model must be available to the
server's AWS role in that region.
### Google Vertex AI (Claude, Gemini)
Add `com.kingsrook.qbits:qbit-assistant-provider-vertex` at the QBit version and
register `com.kingsrook.qbits.assistant.provider.vertex.VertexProviderType`:
```java
config.withProviderType(new VertexProviderType());
```
Create a row with type `vertex`, kind `VERTEX`, required `region` (for example
`us-east5`) and `cloudProject` (the GCP project id). Leave `apiKeyEnvName` empty.
The server uses Google Application Default Credentials, such as
`GOOGLE_APPLICATION_CREDENTIALS` or workload identity. Access tokens are refreshed
when expired, held only in memory, and obtained afresh for each Gemini request.
Models beginning `claude-` (for example `claude-sonnet-4-5@20250929`) use the
Anthropic Vertex backend's `streamRawPredict` API. All other model ids use Vertex's
OpenAI-compatible endpoint:
```text
https://{region}-aiplatform.googleapis.com/v1/projects/{project}/locations/{region}/endpoints/openapi
```
Unprefixed ids, such as `gemini-2.5-flash`, are sent as `google/gemini-2.5-flash`;
already-prefixed ids are preserved. Gemini requests omit `strict`, including when
a tool opts in. An allow-listed base URL overrides the Claude API origin or the
complete OpenAI-compatible base URL, according to the selected model. Use separate
provider rows when an override needs different URL prefixes for the two APIs.
Both cloud types default to CLOUD and expose a short static model catalog.
**Discover models** returns those defaults; it does not call Bedrock's
`ListFoundationModels` (which needs the control-plane SDK) or Vertex Model Garden.
Health probes are unsupported; **Test connection** performs the existing one-shot
completion. Model access and availability depend on the configured region/project.
`hipaaEligible` is an administrator-recorded fact: a BAA and the associated legal
and operational requirements remain owner responsibilities. The flag does not
establish eligibility or implement PHI routing.
The default build tests both clouds using localhost only, fake credentials, AWS
binary event-stream framing, Claude SSE and Gemini Chat Completions, including
engine/tool golden turns. No cloud credentials or live endpoints are required.
## License
Apache 2.0.
## Data classification and HIPAA mode
On QQQ 4.1.0-RC.5, classify application tables/fields in the host configuration:
```java
import com.kingsrook.qbits.assistant.classification.DataClassification;
AssistantQBitConfig config = new AssistantQBitConfig()
.withDataClassification("patient", DataClassification.PHI)
.withDataClassification("patient", "id", DataClassification.PUBLIC)
.withDataClassification("patient", "email", DataClassification.PII)
.withDataClassification("patient", "status", DataClassification.PUBLIC)
.withHipaaMode(true)
.withHipaaRetentionDays(2190)
.withConversationEncryptionKeyEnvName("ASSISTANT_CONVERSATION_KEY");
```
Set that environment variable through your secret manager to a base64-encoded,
random 256-bit (32-byte) key. Supply only its **name** in config, never the key.
The existing server-side `withSecretResolver` hook also resolves this reference.
Startup validates the key. HIPAA mode defaults off; encryption can also be enabled
with the key reference while HIPAA mode is off.
The qbit `DataClassification` enum is a stand-in for core QRun-IO/qqq#1142, with
PUBLIC < CONFIDENTIAL < PII < PHI. Unconfigured tables default to PUBLIC; a field
falls back to its table unless explicitly overridden. A field subset uses its
selected fields; unrestricted reads and record page contexts use the highest
classification across the table and its fields. Returned columns and record-label
fields also count: tools include a primary key even for subsets, so classify it
explicitly if the host considers it safe for that subset. Cross-table results with unknown
tables use the highest classification anywhere. Metadata-only tools remain PUBLIC.
The assistant's own tables remain denied to tools.
Hosts can supply `withClassificationSource(ClassificationSource)` instead. When
upgrading to an RC containing core #1142, implement that interface with
`AiDataClassifications`/`AiTableMetaData`/`AiFieldMetaData` (map enum names), then
replace the stand-in once the qbit's minimum core version includes it.
PHI is sent only to a persisted provider row explicitly marked `hipaaEligible`.
Every model dispatch rechecks eligibility, including calls after tools and strict
schema retries. Blocks end the turn with `PHI_BLOCKED` or `HIPAA_PROVIDER`; the
PHI tool result is never sent to that provider. There is no automatic fallback.
A conversation keeps its highest classification, so moving to a PUBLIC page does
not make existing PHI history safe for a non-eligible provider.
HIPAA mode also refuses non-eligible providers at resolution and when enabling
settings rows, disables code-only fallback, requires encrypted conversation
storage, and suppresses provider error details in logs and turn errors. The app
home displays HIPAA mode and PHI retention. The eligibility flag records the
operator's decision (including any applicable BAA); it does not establish one.
Both modes audit each PII/PHI model call and every routing block in
`assistant_data_audit` (admin read-only, owner-locked, on the conversation screen).
PHI conversations use `hipaaRetentionDays` even with HIPAA mode off. A null value
uses normal retention; tool-result/replay cleanup remains independently configured.
See [UPGRADE.md](UPGRADE.md) for schema changes, plaintext migration, and key handling.
## Data-driven budgets
Admins configure **Assistant > Budgets** for UTC DAY or MONTH allowances in USD or
TOKENS, scoped to INSTANCE, USER, ROLE (a permission), PROVIDER or MODEL. Provider
and model scope values are registry record ids. Warnings default to 80%; at 100%
the default action is DOWNGRADE, and the hard ceiling defaults to 120% (always
STOP). Multiple budgets apply together and STOP wins.
An explicit downgrade model is optional. Otherwise the cheapest enabled usable
model is selected, preferring LOCAL providers. PHI never goes to a provider that
is not HIPAA-eligible. No eligible target means STOP. Administrators can grant
extra allowance or temporary unlimited use from the budget's Overrides child list,
with a required reason and expiry; the session sets the grantor.
Budget state changes appear once per scope/period/state in the Events child list,
as panel notices and, through core QAlerts, bell alerts when an alerts sink is installed (logging otherwise).
The Assistant home shows budgets, overrides, daily cost and tokens, and breakdowns
by user, model, provider and tool. Existing `AssistantBudgets`/policy limits and
provider monthly caps continue to apply independently of these rows and overrides.
See [UPGRADE.md](UPGRADE.md) for the required additive schema.
### Profile routing and provider fallback
On an Assistant Profile, **Model routing** defaults to OFF. HEURISTIC selects the
complex slot for long questions (>600 characters), two mentioned app tables,
analysis/comparison/explanation/trend/planning requests, pending writes, more than
eight previous turns, or a previous tool limit; otherwise it selects the simple
slot. CLASSIFIER uses an optional registry model with just the question and a
fixed instruction, four output tokens and a three-second timeout. An invalid reply,
error, unavailable classifier or PHI-ineligible classifier uses HEURISTIC. ROUTE
usage counts toward budgets. Empty model slots keep the provider/policy default;
budgets may downgrade either choice. Without a profile, enabled code-level
`AssistantModelRouting.escalation*` supplies the complex default.
A model's **Fallback model** points to its next candidate, including another
provider. Chains are cycle-free and bounded to four hops. Only retryable failures
before any text or tool start from that call permit fallback. Disabled, down,
PHI-ineligible or budget-blocked candidates are skipped. Without explicit links,
only another LOCAL model in the same adapter family is eligible; local requests
never automatically move to cloud. Provider state/signatures are removed when
switching, preserving neutral tool history. Each attempted call is audited as usage.
NETWORK/TIMEOUT marks a provider DOWN for 60 seconds; success marks it UP. Local
health is probed when unknown/stale with a two-second timeout. Provider cards show
health and down-until, failures show fallback totals, and turn records show the
route and final destination. See [UPGRADE.md](UPGRADE.md) for the additive schema.
### Answer presentation
The always-available `present_results` tool turns retrieved results into metrics,
tables, charts and actionable in-app links. The server validates the user's UI API
visibility, formats field values, computes shares and builds all links. It emits
and stores a `presentation` part with a complete GFM Markdown fallback. Profile
skills can extend the built-in presentation instructions. See the
[part, stream and input contract](docs/answer-presentation.md).
The image-breakdown golden task also runs in the existing opt-in live provider suite:
`./mvnw verify -Dassistant.live=true -Dtest.excludedGroups= -Dgroups=live -Djacoco.skip=true -pl qbit-assistant-provider-anthropic -am`
(with `ANTHROPIC_API_KEY` set). Live calls are excluded from normal verification.
+210 -1
View File
@@ -1,5 +1,124 @@
# Upgrading qbit-assistant
## P-e: profile routing and provider fallback
Apply the additive **P-e** ALTER TABLE statements at the end of
[docs/schema-postgres.sql](docs/schema-postgres.sql) before deploying. Existing
profiles default to OFF; optional model references and health columns start null.
No routing or fallback configuration is seeded. Existing turns retain unknown
routing/final-provider values; fallback_count defaults to zero.
Profiles now have a **Model routing** section. Select HEURISTIC or CLASSIFIER,
then optional simple/complex registry models and a classifier model. Empty route
slots retain provider/policy selection. CLASSIFIER with no usable classifier
uses HEURISTIC. OFF preserves prior provider selection. With no effective profile,
code-configured escalation supplies the complex model/effort when enabled.
Set a model's **Fallback model** to opt into a cross-provider chain. Saves reject
cycles, more than four edges, or disabled/missing targets. Provider health is
read-only; NETWORK/TIMEOUT opens a 60-second circuit, and successful calls close
it. Local endpoints with stale health get a bounded two-second probe. Automatic
fallback without an explicit link is confined to local models of the same adapter
family. PHI/HIPAA eligibility and budgets apply to every destination.
Classifier usage is recorded with purpose ROUTE and included in budgets. Reports
that filter usage purpose should include ROUTE. Turn screens show route decision,
source, fallback count and final provider; the home shows health and fallback totals.
All configuration remains assistant.admin-only, with AI exposure NONE.
## P-d: data-driven budgets
Requires QQQ 4.1.0-RC.5 for the core Alerts API and alert type metadata.
Create `assistant_budget`, `assistant_budget_override`, `assistant_budget_event`
and `assistant_budget_usage`
using the P-d DDL in [schema-postgres.sql](docs/schema-postgres.sql) before deploying.
The event unique key is required: it deduplicates each state per budget, scope and
UTC period across replicas. Do not remove it or truncate events during a period.
Budgets appear in Assistant navigation. Overrides and immutable events are child
lists. All four tables require `assistant.admin` and have AI exposure NONE.
Overrides record the actual session grantor and require a reason and expiry.
The standard host QQQ audit configuration applies to budget and override edits.
`assistant_budget_usage` is a private accounting projection populated from persisted
usage writes. It copies only counters, time, user, provider and model, with no owner
lock, so shared INSTANCE/PROVIDER/MODEL sums can run under the caller's own session.
The source usage table retains its owner locks. The projection is read-only, has no
nav entry and no AI exposure. **Pause usage writes during migration and run the DDL's
backfill before restarting**; otherwise shared totals would omit pre-upgrade usage.
Keep accounting rows through their budget periods even if detail rows are removed.
ROLE budgets give each permission holder a separate allowance, checked with their
current session. Override scopeValue, when set, narrows the allowance to one user id.
Existing policy/config budgets and provider monthly caps remain additional limits;
an override of a budget row does not waive those existing caps.
Provider and MODEL scope values are numeric provider/model registry row ids;
USER is a user id and ROLE is a permission name. INSTANCE has no scope value.
Periods reset at midnight UTC or the first of the month UTC. Token usage includes
input, output, cache-read and cache-write tokens; USD uses the recorded micro-dollar
cost, not today's model price. No default budget rows are seeded.
## P-c: classification, PHI routing and encrypted storage
Apply these additive schema changes before deploying P-c (adjust column mappings
for your backend). New conversations/turns record `PUBLIC`, `CONFIDENTIAL`, `PII`
or `PHI`; legacy null classifications read as PUBLIC. Backfill known historical
PHI conversations to PHI before allowing their history to be used with a provider.
```sql
ALTER TABLE assistant_conversation ADD COLUMN max_classification VARCHAR(16);
ALTER TABLE assistant_turn ADD COLUMN classification VARCHAR(16);
ALTER TABLE assistant_turn ADD COLUMN classification_tables VARCHAR(500);
ALTER TABLE assistant_conversation ALTER COLUMN title TYPE TEXT;
ALTER TABLE assistant_tool_call ALTER COLUMN result_summary TYPE TEXT;
ALTER TABLE assistant_pending_action ALTER COLUMN summary TYPE TEXT;
ALTER TABLE assistant_pending_action ALTER COLUMN result_summary TYPE TEXT;
CREATE TABLE assistant_data_audit
(
id SERIAL PRIMARY KEY,
user_id VARCHAR(255),
conversation_id INTEGER,
turn_id INTEGER,
provider_id INTEGER,
provider_name VARCHAR(200),
model VARCHAR(200),
hipaa_eligible BOOLEAN,
classification VARCHAR(16),
tables VARCHAR(500),
decision VARCHAR(16),
reason VARCHAR(1000),
create_date TIMESTAMP WITH TIME ZONE
);
CREATE INDEX assistant_data_audit_user_id ON assistant_data_audit (user_id);
CREATE INDEX assistant_data_audit_conversation_id ON assistant_data_audit (conversation_id);
CREATE INDEX assistant_data_audit_turn_id ON assistant_data_audit (turn_id);
```
`assistant_data_audit` is an admin read-only, owner-locked child list on a
conversation, outside navigation. It records each model call carrying PII/PHI and
each routing block, without record values. It expires with the conversation.
PHI conversations use `hipaaRetentionDays` (2190 by default), even outside HIPAA
mode; null uses normal retention. Existing tool-result/replay cleanup still uses
`toolResultRetentionDays`.
Before enabling HIPAA mode, mark the permitted provider rows `hipaaEligible = true`
and provision `conversationEncryptionKeyEnvName` with a base64-encoded 32-byte
key. Startup refuses missing or invalid keys. A code-only provider is not eligible.
The flag records the operator's eligibility decision; it does not establish a BAA.
New/updated message parts, titles, conversation context, tool payloads/redactions
and summaries, replay data, and pending-action payloads/summaries use
`enc:v1:<base64(iv|ciphertext|tag)>` (AES-256-GCM, random 12-byte IV, 16-byte tag).
Only `AssistantStore` decrypts; direct backend/admin record views show ciphertext.
String columns holding encrypted summaries/titles must be TEXT to allow expansion.
Legacy plaintext reads are supported; existing rows are not automatically rewritten.
For an existing deployment, migrate legacy payloads through AssistantStore under
the appropriate owner/admin session before treating the whole archive as encrypted.
Keep the key available for the lifetime of encrypted data and backups. Changing the
key requires a controlled decrypt/re-encrypt migration; P-c has no key rotation job.
Corrupt ciphertext, a wrong key, and encrypted data without a key fail closed.
## 0.1.0-RC.3 to 0.1.0-RC.4: provider settings, prices, per-call usage, app home
Three new tables. Create them before you deploy (see `docs/schema-postgres.sql`, which also seeds the Anthropic prices):
@@ -111,10 +230,100 @@ Deploy RC.3 and run the statements above in the same maintenance window. Until t
## 0.1.0-RC.6: tools through the UI API
Database (see `docs/schema-postgres.sql`):
- new tables `assistant_data_access` and `assistant_pending_action`;
- new tables `assistant_data_access`, `assistant_pending_action`, `assistant_profile`, `assistant_skill` and `assistant_profile_skill`;
- new columns `assistant_tool_call.ui_api_operation`, `http_status`, `audit_href`, `pending_action_id`;
- new columns `assistant_policy.writes_require_confirmation`, `allowed_tools`, `max_rows_per_call`, `redact_pii`.
Runtime: the tools call this server's own `/qqq/v1` on `127.0.0.1` and the port the first assistant request arrived on. If the server is not reachable that way (a different bind address, a TLS-only listener), set `withUiApiBaseUrl(...)`. Grant `assistant.admin` holders the new tables through the qbit's existing admin permission (no new permission names).
Behavior: nothing is writable until an admin adds a READ_WRITE data access row; before that the assistant reads exactly what it did before, now through the UI API.
## P-a: provider and model registry
Before starting the new version, database-backed hosts add the provider columns
and model sub-table below. Memory-backed hosts need no migration. Existing rows
derive kind and location from the adapter and keep their model behavior until
models are registered. Keys remain environment-variable references.
```sql
ALTER TABLE assistant_provider
ADD COLUMN kind VARCHAR(30),
ADD COLUMN tls_ca_bundle VARCHAR(100),
ADD COLUMN location VARCHAR(10),
ADD COLUMN hipaa_eligible BOOLEAN DEFAULT FALSE,
ADD COLUMN region VARCHAR(50),
ADD COLUMN api_version VARCHAR(30),
ADD COLUMN connect_timeout_seconds INTEGER DEFAULT 10 CHECK (connect_timeout_seconds BETWEEN 1 AND 600),
ADD COLUMN request_timeout_seconds INTEGER DEFAULT 120 CHECK (request_timeout_seconds BETWEEN 1 AND 600),
ADD COLUMN last_discovery_at TIMESTAMP WITH TIME ZONE,
ADD COLUMN last_discovery_status VARCHAR(16),
ADD COLUMN last_discovery_error VARCHAR(500);
ALTER TABLE assistant_provider ALTER COLUMN model TYPE VARCHAR(200);
ALTER TABLE assistant_provider ALTER COLUMN last_test_model TYPE VARCHAR(200);
ALTER TABLE assistant_usage ALTER COLUMN model TYPE VARCHAR(200);
ALTER TABLE assistant_message ALTER COLUMN model TYPE VARCHAR(200);
ALTER TABLE assistant_turn ALTER COLUMN model TYPE VARCHAR(200);
CREATE TABLE assistant_model
(
id SERIAL PRIMARY KEY,
provider_id INTEGER NOT NULL REFERENCES assistant_provider(id),
model_id VARCHAR(200) NOT NULL,
display_name VARCHAR(200),
enabled BOOLEAN,
supports_tools BOOLEAN,
supports_vision BOOLEAN,
supports_streaming BOOLEAN,
supports_reasoning_effort BOOLEAN,
context_window_tokens INTEGER,
max_output_tokens INTEGER,
input_usd_per_m_tok NUMERIC(12, 4),
output_usd_per_m_tok NUMERIC(12, 4),
source VARCHAR(16),
discovered_at TIMESTAMP WITH TIME ZONE,
last_test_at TIMESTAMP WITH TIME ZONE,
last_test_status VARCHAR(16),
last_test_latency_ms INTEGER,
last_test_error VARCHAR(500),
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE,
UNIQUE (provider_id, model_id)
);
```
Register the optional `qbit-assistant-provider-openai` module and
`OpenAiCompatibleProviderType` to offer its kinds. Azure and generic endpoints
require an explicit `allowedBaseUrls` entry; local defaults may be keyless.
Discover models preserves existing rows. Cloud catalogs larger than 20 are added
disabled; enable the models to offer before leaving the provider's model empty.
HIPAA eligibility records an administrator's fact; P-a does not implement PHI routing.
Custom CA bundles are server configuration, never database content. Register them
with `withTrustedCaBundle(name, pem)` or `withTrustedCaBundleFile(name, path)` at
startup, then set the HTTPS provider row's `tlsCaBundle` to that name. Empty
references retain JVM default trust. The bundle adds trust without replacing JVM
roots; hostname verification remains enabled. If the P-a columns were already
applied, add only `tls_ca_bundle VARCHAR(100)` to `assistant_provider`.
## P-b: AWS Bedrock and Google Vertex
Before starting this version, database-backed hosts that already applied P-a add:
```sql
ALTER TABLE assistant_provider ADD COLUMN cloud_project VARCHAR(100);
```
Fresh installations use `docs/schema-postgres.sql`; memory-backed hosts need no
migration. Existing providers leave the new column null. Vertex requires the GCP
project id in `cloudProject`; Bedrock and Vertex both require `region` and reject
`apiKeyEnvName`. They default to CLOUD; `hipaaEligible` remains a manual admin fact.
Add the optional `qbit-assistant-provider-bedrock` and/or
`qbit-assistant-provider-vertex` module at the QBit version and register
`BedrockProviderType` / `VertexProviderType`. Credentials come from the server's
AWS default chain / Google Application Default Credentials. No credentials are
stored in provider rows. Hosts using AWS IRSA or web identity supply
`software.amazon.awssdk:sts` on their own runtime classpath (matching the
transitive AWS SDK version); this QBit does not add it. See README Providers for
configuration, endpoint overrides and static discovery limitations.
+269 -1
View File
@@ -114,7 +114,20 @@ Owner: *"the agent should have to go through the same API that the UIUX does. th
- Each table and process has an AI data access setting: NONE, READ or READ_WRITE. Sensitive tables default to NONE.
- Admins can see what the assistant could do for a given user, and why.
3. **Writes need confirmation.** A write tool only *proposes* the change, as a pending action card. Nothing changes until the user confirms in the panel, unless the policy turns confirmation off.
4. All other open questions in this section were decided as recommended (shared rule: "all recommendations accepted").
4. **Persona and skills, never more access** (owner, 2026-10-13): *"in the config for the AI settings, we should be able to set a name and personality and extra skills etc for the agent - and again - the agent should be limited to only using our UIUX API and being able to only do the things that the currently logged in user could do with the same UIUX API via the UIUX"*.
- **Profiles** (`assistant_profile`, admin-edited): display name, icon, personality (tone instructions, at most 2,000 characters), greeting and up to 6 starter prompts.
- One profile is the default. Others are scoped to an app, to users holding a permission (a role), or to both. The most specific profile wins.
- `/assistant/config` returns the profile for the panel header, the greeting and the starter prompts.
- **Skills** (`assistant_skill`, linked to profiles through `assistant_profile_skill`): named Markdown instruction packs of at most 6,000 characters, with a description, an enabled flag, trigger keywords and apps.
- A skill is read only when relevant: a keyword appears in the question, the user is in one of its apps, or it has neither, in which case it is always read.
- All skills read for one question total at most 12,000 characters.
- Profile and skill text goes into the per-user system block, framed as "tone and know-how only". The rules come first, and rule 10 says these can never override the rules or give other tools, data or permissions.
- **Hard guarantee:**
- Every data, process, report or widget capability is a `/qqq/v1` operation, called through the gateway (core `UiApiInvoker` once it is released) with the CURRENT user's session.
- The tool list is the spec'd operations ∩ data access ∩ policy. Profiles and skills are never read when tools are built or run.
- It is enforced by ArchUnit: the tool, UI API and access code may not use QQQ table, process, report, dashboard or async actions, the core AI kernel, or the profile and skill classes. It is also enforced by a runtime guard: `AssistantStore` refuses any table that is not `assistant_*`.
- `UiApiToolsSecurityTest.testDenialMatrix` checks that a user without permission gets the identical status and message from the UI API and through the assistant for query, get, insert, update and delete. The assistant has no process or report tool, and process data access defaults to NONE.
5. All other open questions in this section were decided as recommended (shared rule: "all recommendations accepted").
## Tools through the UI API (0.1.0-RC.6)
@@ -204,6 +217,228 @@ A confirmed write adds its own row. The rows are a child list on conversations,
The golden and red-team evals now run through the UI API too.
## Explain access and recent denials (0.1.0-RC.6)
- **Explain access:**
- `GET /qqq/v1/assistant/access?table=&prompt=` returns, for the calling user and each table (or only the named table, or only the tables a prompt mentions):
- the user's UI permissions, from `GET /qqq/v1/metaData` with their own session;
- the assistant's data access and where it comes from (setting, default, or sensitive table);
- each tool's operation, with allowed or the reason it would be denied (policy, data access, not visible in the UI, or no read/insert/edit/delete permission).
- The `assistantAccess` widget on the Assistant home renders the same thing for the viewing admin.
- Choosing *another* user would need that user's permissions without their session. QQQ core has no API to evaluate another user's permissions, and the assistant never builds or borrows a session. That part waits for a core API, so the report is always computed with the requester's own session.
- **Recent denials:** the home's "Recent denials" card lists the newest tool calls the UI API, data access or the policy refused, with who, the table, the operation and the HTTP status, or the assistant setting that refused it.
## Owner decisions (2026-10-13), continued: write mode, the hard wall, audit attribution, providers
These were added on the same day. All recommendations below are accepted; we adjust once they can be seen working.
### W. Write mode: the assistant is just a UI client
Owner: *"the assistant should be able to go into 'write mode' too - with a user selection or preference? allowing it to do things like create and schedule a report for you, or update a record. it should ALWAYS only have access via the UIUX API (the assistant is just a UI) and all permissions that the user has via the UIUX should always hard apply at a layer above the assistant. All auditing needs to be aware of this too and audit accordingly"*
- **Mode per conversation.** A panel toggle switches between **Read-only** (the default) and **Write**.
- The default comes from the user's preference (`assistant_user_preference.default_write_mode`).
- An admin policy can disable write mode globally (`assistant_policy.write_mode_allowed`), per role (`write_mode_permission`: only holders may switch to Write), or per table or process (data access READ or NONE).
- **Read-only:** the write tools are not in the tool list at all. This is decided when the request is built, not by the model.
- **Write:** every write is still a pending-action card that the user confirms.
- A user may set "auto-confirm low-risk writes" only when the policy allows it (`auto_confirm_allowed`).
- Low-risk means a single-record insert or update on a table the admin marked `auto_confirm_ok`.
- Deletes, bulk operations, processes, report schedules and notifications are never auto-confirmed.
- **What counts as a write.** All of these are `/qqq/v1` UI API operations:
- insert, update and delete records;
- run a process (`/processes/{name}/init` and steps; every step is a confirmed action);
- create, save or schedule a report or saved view (through the saved-report and scheduled-job tables' own insert operations);
- create a notification.
- **Enforcement is beneath the assistant.** The UI API and core permission layer decide, exactly as for Next UI. The assistant only forwards the user's credentials (`UiApiInvoker`, `UiApiCredentials`, qqq#1128).
- The ArchUnit rule (no core actions from the tool code) and the denial matrix stay.
- The matrix is extended to every write operation, in both modes.
### X. The hard wall between the assistant and its configuration
Owner: *"there should also be a hard wall between the assistant and the configuration for the assistant. he should never be able to see his own configuration tables etc."*
AI exposure NONE is not enough, because the assistant acts as the user and an admin user can edit the configuration. The wall is enforced in core, beneath the assistant, by client channel (UI API 1.2.x, approved design):
- Every `/qqq/v1` request the assistant makes carries `X-QQQ-Client: assistant/<turnId>`. It is set server-side by `UiApiInvoker.forServer(server, "assistant")` and `withClientDetail(turnId)`, and the invoker drops any client-supplied value. Core stores it as `QSession.getClientChannel()`.
- **Deny rules:**
- `ClientChannelsMetaData.withDeniedPattern("assistant", "assistant_*")`, plus core's defaults: `authentik_*`, `audit*`, `*api_key*`, `*apiKey*`, `*credential*`, `*secret*` and `webhooks_*secret*`;
- `QPermissionRules.withDeniedClients(Set.of("assistant"))` on every assistant process (retention, test connection) and widget.
The rules are enforced in `PermissionsHelper`: the object is left out of metadata, and calls get 403, failing closed.
- The qbit registers **every** `assistant_*` table, process and widget in the deny set. A **startup check** fails the instance if any `assistant_*` object is not denied to the `assistant` channel.
- Profiles and skills reach the model only as server-assembled instructions. No tool reads or edits them (this is already enforced by ArchUnit), so a prompt injection can never persist itself.
- The current conversation's context is read by internal code (`AssistantStore`, assistant tables only), never by a tool.
- **Tests:** an admin through the assistant is denied on every configuration table and process (403, and absent from `list_tables` and `/metaData`), while the same admin through Next UI is allowed.
### Y. Audit attribution
- Every action records the human user as the actor **and** the client channel: `actor=james@kof22.com via=assistant/<turnId>`, versus `via=next-ui`.
- Core writes `clientChannel` on `audit` (`AuditsMetaDataProvider.withClientChannelField(true)`, filled by `DMLAuditAction`), so audit screens can filter by channel.
- `assistant_tool_call` keeps the turn, conversation and model, and links to the audit rows (`auditHref`), so `via=assistant/<turnId>` leads to the conversation, the turn and the model.
- **Tests:** an assistant write produces audit rows with the human actor and `via=assistant/<turnId>`; the same write from the UI produces `via=next-ui`.
- kof22 needs a feature-named changeset (`changesets/features/...`) for the audit column.
### P. Providers, local models, HIPAA routing, budgets
1. **Providers and models as data, any number, each with an enabled toggle.**
- Kinds:
- Anthropic (exists);
- **OpenAI-compatible**, one adapter for OpenAI, Azure OpenAI, OpenRouter, Ollama, LM Studio, vLLM and the llama.cpp server;
- **AWS Bedrock** (Claude and others);
- **Google Vertex** (Claude and Gemini).
- `assistant_provider` gains: kind, base URL, key env reference (unchanged pattern, no stored secrets), local or cloud, `hipaa_eligible` and region.
- The new **`assistant_model`** table holds: provider, model id, display name, capabilities (tools, context window, vision, streaming), price in and out per million tokens (0 or a configured compute cost for local models), and an enabled flag.
- Test connection works for every provider and every model.
- Tool calling follows each provider's rules. The strict-grammar lesson applies: strict only where supported, and a fallback when it is refused.
2. **Local models** (Mac Studio, and the workstation "lora" with an RTX A5000 24 GB, running Ollama, LM Studio or vLLM; another agent sets up the hosts). Any OpenAI-compatible endpoint is supported, with health checks, model discovery (`GET /v1/models` fills `assistant_model`) and per-provider timeouts.
3. **HIPAA/PHI routing:**
- A data classification on tables and fields in metadata: PHI, PII, CONFIDENTIAL or PUBLIC.
- Each turn tracks the highest classification its context and tool results touched.
- The policy allows PHI only to `hipaa_eligible` providers (local, or cloud under a BAA). Otherwise it blocks, with a clear reason.
- A per-instance **HIPAA mode** (on for MHP, off for kof22) also enforces:
- PHI redaction in logs;
- encrypted conversation storage;
- a separate retention period;
- a full audit (who, which classification, which model);
- no non-eligible providers.
- **BAAs are an owner and legal step**: the flag records a fact; it does not create one.
4. **Budgets:**
- daily and monthly cost and token budgets per user, group or role, provider or model, and instance;
- default behaviour: warn at 80% (bell and alert, through the Alerts SPI when present), downgrade to a cheaper or local model at 100%, and stop at a configurable ceiling;
- admins can override;
- usage and cost over time on the app home, by user, model, provider and tool.
5. **Extras:**
- model routing (simple versus complex, per profile) and fallback chains across providers;
- **RAG** over the instance's content: a local embedding model, pgvector, and retrieval filtered by permissions through the UI API as the user;
- **scheduled assistant tasks**: recurring prompts that run as a designated user (with that user's stored credentials through the UI API, never a system session) and post results as notifications or records.
6. Everything goes through the `/qqq/v1` UI API, as the user, with the guarantees above.
### P-a as built
- Per-provider `tlsCaBundle` references startup-parsed, transient server CA bundles. OpenAI-compatible chat, health and discovery trust JVM roots plus the bundle, retain hostname verification, and report sanitized NETWORK errors with a trust hint.
- `assistant_provider` records kind, location, HIPAA eligibility, region, API
version, timeouts and discovery status. `assistant_model` is its admin-only
child list: enablement, capabilities, prices and test status, unique per provider/model.
- `ProviderSettings`, discovery and health extend the provider SPI through default
methods. Legacy `create(apiKey, baseUrl)` implementations keep working.
- The OpenAI-compatible module uses JDK HTTP and Jackson, Chat Completions with
SSE or single JSON replies, Azure deployment URLs and api-key auth, and keyless
local endpoints. Keys and URL overrides pass the existing allowlists first.
- Strict tools require explicit opt-in, OpenAI or Azure, and recursively strict
object schemas. A strict/schema/grammar 400 signals the existing one-retry fallback.
- Discovery only adds missing models; it preserves edits and disables catalogs
larger than 20 for cloud providers. Health uses a short models request. Provider
tests probe health then complete; model tests can probe a disabled model before
enabling it. Completion tests record TEST usage.
- Registry prices and capabilities override adapter/type defaults. Empty provider
model selects the first enabled registry model; an explicitly disabled selection
is a setup error. Rows without models retain the prior behavior.
- Localhost contract tests cover dialects, fragmented parallel tool calls, usage,
errors, timeouts, cancellation, discovery and a golden tool round trip. The live
smoke is environment-driven and excluded by default.
### P-b as built
- Optional Bedrock and Vertex modules reuse the Anthropic mapping and streaming
adapter through an injected SDK client. Bedrock retains SDK SigV4 and binary
event-stream decoding; a small Backend delegate supplies allow-listed endpoints
because SDK 2.71.0 has no Bedrock endpoint setter.
- Bedrock uses the server's AWS default credential chain; IRSA/web-identity hosts
supply STS on their runtime classpath. No STS or control-plane SDK is bundled.
- Vertex uses scoped Google ADC. `claude-*` routes to the Anthropic backend; other
ids route to the OpenAI-compatible endpoint with a per-request token supplier,
`google/` for unprefixed ids, and no strict tools.
- Both types require region, reject key references and default to CLOUD. Vertex
additionally requires `cloudProject` (`cloud_project VARCHAR(100)`); it is part
of resolved settings and the provider cache key. Type hooks own validation.
- Discovery is a static catalog, health is unsupported, and Test connection uses
the existing completion. HIPAA eligibility remains an admin fact, not a BAA.
- Localhost contract tests cover wire paths, authentication, text/tools/usage,
expired-token refresh, errors, allowlists and golden turns for all three routes.
### P-c as built
- The qbit classification enum is a stand-in for core #1142 until a released RC
includes it. Configured table/field overrides are the default; hosts can supply
a `ClassificationSource` over core metadata, mapping enum names, then replace
the stand-in when the minimum QQQ version advances.
- Turn/page/tool classification is monotonic, persisted on the turn and retained
on the conversation. Field subsets use overrides; unknown cross-table results
conservatively use the highest configured level. Metadata tools stay PUBLIC.
- Small engine hooks check a fresh provider row before every model dispatch,
including strict retries. PHI requires explicit row eligibility; HIPAA mode
requires it for all calls. Blocks withhold results, explain the rule without
values, and write an audit. `ProviderService.eligibleAlternative` is an empty
seam for P-e; P-c never changes providers automatically.
- HIPAA mode refuses non-eligible settings/selection and requires a valid key
reference at startup. AssistantStore alone encrypts/decrypts conversation
payloads using AES-256-GCM; legacy plaintext reads remain supported and corrupt
ciphertext fails closed. No key is persisted. Provider diagnostic text is
suppressed in HIPAA logs and turn errors.
- Admin read-only, owner-locked `assistant_data_audit` records each PII/PHI model
dispatch and each block, outside navigation. PHI conversation retention defaults
to 2190 days in either mode; shorter tool-result/replay cleanup is unchanged.
The app home shows HIPAA mode and PHI retention.
### P-d as built
- ROLE allowances are per permission holder. Shared scopes sum a private immutable
accounting projection of usage counters; owner-locked source rows stay locked.
Migration backfills existing usage before writes resume. No sessions are elevated.
- Standard admin budget rows add daily/monthly cost or token allowances above the
existing config/policy budgets and provider monthly caps. Overrides carry a
reason, session grantor and expiry; they never waive the other limit layers.
- Start-turn checks use the existing 429 BUDGET path through PolicyService.
Every dispatch, including strict retries, evaluates current usage and overrides.
Events deduplicate WARNED, DOWNGRADED and STOPPED.
- QQQ RC.5 core QAlerts sends budget signals alongside panel notices, with three
admin-visible alert types and a default logging sink. Resolution awaits active
alert/recurrence tracking so overrides cannot clear shared alerts incorrectly.
- Explicit registry model selection leaves provider defaults untouched. Automatic
downgrades prefer LOCAL, then price. PHI eligibility and destination provider caps
still apply; a missing eligible target stops the turn.
- The home owns the budget cards and 30-day cost/token bars, with user, model,
provider and tool breakdowns, inherited colors and empty states.
### P-e as built
- Profiles select OFF (the migration default), HEURISTIC or CLASSIFIER and optional
simple/complex/classifier registry models. Selection uses ProfileService's existing
specificity. Without a profile, enabled escalation config supplies the complex
model and effort. Empty slots retain provider row/default/policy selection.
- The documented heuristic is a pure rule table: >600 characters, two distinct app
table names, complexity keywords, pending write context, >8 previous turns or a
previous tool limit. This branch has no conversation write-mode field.
- Classifier transport is non-streaming, bounded to four output tokens/three seconds,
and contains only the fixed instruction and user question. PHI guards apply before
dispatch. Errors/unexpected replies use the heuristic. ROUTE usage enters budget
accounting; normal dispatch budgets may override the selected route.
- FallbackChain follows at most four edges on retryable failures, only before any
text/tool start of that call. Candidates are checked for enablement, health,
PHI/HIPAA eligibility and budgets. Without explicit links only the same LOCAL
adapter family is considered. Provider switches rebuild neutral messages and
discard providerState; failed attempts remain visible in usage.
- ProviderHealth persists UP/DOWN, checked-at and a 60-second connection-failure
circuit. Local stale/unknown health uses a bounded two-second probe. Successful
completions close the breaker. Turn rows persist route/source, fallback count and
final provider/model; notices name only the unavailable and answering providers.
- Admin record screens, additive Postgres DDL and the flow-layout home expose these
settings and counters without granting AI access to assistant configuration.
### Phases (each a green PR)
| | Scope | Depends on |
|---|---|---|
| d | Spec'd `/assistant` endpoints, tools on `UiApiInvoker` (#19) | QQQ RC.6 |
| W1 | Write mode: conversation toggle, user preference, policy (global, role, table), tool list by mode, auto-confirm rules, write matrix in both modes; Next toggle | — |
| X1 | Client channel `assistant/<turnId>` on every call, deny registration for all `assistant_*` objects and the security surfaces, startup check, admin-denied tests | core client-channel PR (UI API 1.2.x) |
| Y1 | Audit attribution tests and `auditHref` to audit rows filtered by channel | core audit column |
| W2 | Process, report-schedule, saved-view and notification writes as confirmed UI API operations | W1, X1 |
| P-a | Provider and model registry, OpenAI-compatible adapter, discovery and health | — |
| P-b | Bedrock and Vertex | P-a |
| P-c | Classification, HIPAA routing and mode | P-a, core metadata |
| P-d | Budgets and dashboards | P-a |
| P-e | Routing and fallback chains | P-a |
| P-f | RAG (embeddings, pgvector, UI-API-filtered retrieval) | P-a |
| P-g | Scheduled assistant tasks | W1, X1 |
## Next phases
- **(c) Data access screens:**
@@ -211,3 +446,36 @@ The golden and red-team evals now run through the UI API too.
- an "Explain access" action (for a user, and a table or a prompt, which operations the assistant could call and which it would be denied, with the reason);
- a recent-denials widget on the app home.
- **(d) Spec'd assistant endpoints:** move `/qqq/v1/assistant/...` (conversations, turns, events, feedback, cancel, config, actions) onto `AbstractEndpointSpec`s through the qbit spec extension point (`MiddlewareSpecExtension`, established prefix `/assistant`, QRun-IO/qqq#1128). The SSE turn and events streams stay raw routes until the spec layer can describe a stream.
## Answer presentation (owner priority 2026-10-13)
`present_results` is always offered and reads no records. It takes a direct answer,
metrics, a table, an optional table-derived chart, filtered list links, record links
and next-step actions. The server validates metadata and the user's UI API table
visibility once per turn, formats values using QQQ field types/display formats,
computes percentages and builds every `/app` href. Unknown or denied items are
dropped with an explanation. The assistant must still retrieve every fact through
data tools before presenting it.
The [presentation part and SSE contract](answer-presentation.md) defines `summary`,
`blocks` and the complete server-built GFM `markdown` fallback. Each successful
call emits `presentation` with `{messageId, part}` and persists that part; the tool
response tells the model not to repeat its tables or links. Audit rows contain
only accepted presentation data. Normal record-data retention removes these parts.
The built-in Presentation skill is compact static prompt text in the cached rules
block. It asks for a one-sentence answer first, metrics for single numbers, tables
for breakdowns/comparisons, charts for useful shares/trends and actual filter links
whenever offering a list. Administrator profile skills append after it as before
and extend it; there is no replacement boolean or extra permission surface.
The owner's one-line table was a frontend parsing defect: Next's `AssistantMarkdown`
used react-markdown without `remark-gfm`, so table lines became a paragraph.
The renderer fix belongs to `qqq-frontend-next`; this worktree preserves real
newlines and provides structured blocks plus a proper multi-line GFM fallback.
The frontend change is maintained separately and is not verified by this build.
The shared golden task asks "How many images do I have by type?": five UI count
calls establish 81 JPEG, 20 PNG and zero other configured types, then a presentation
with two rows, 80.2%/19.8% shares, two pie points and working MIME filter links.
The same task is included in the opt-in `live` Anthropic eval suite.
+56
View File
@@ -0,0 +1,56 @@
# Assistant answer presentation contract (v1)
Owner priority (2026-10-13): answers must ALWAYS be easy to read and act on. Bad example the owner saw, rendered on ONE line:
"| Type | Count | |---|---| | JPEG (image/jpeg) | 81 | | PNG (image/png) | 20 | | WebP, GIF, SVG | 0 |" followed by "You can open the lists filtered by JPEG or PNG" with NO links.
Root cause found in Next: `AssistantMarkdown` uses react-markdown WITHOUT `remark-gfm`, so GFM tables are not parsed and the table's lines collapse into one paragraph (soft line breaks). Backend streaming preserves `\n` (events are JSON).
## New message part: `presentation`
An assistant message's `parts` (persisted in `assistant_message.parts_json`, streamed as an SSE event, returned by the conversation API) may contain, besides `text`, `notice`, `tool`/`render` parts etc., ONE part per `present_results` call:
```json
{
"type": "presentation",
"summary": "101 media files are images: 81 JPEG and 20 PNG.",
"markdown": "<server-built GFM fallback of the whole presentation, for clients that do not render blocks (CLI/TUI)>",
"blocks": [
{ "kind": "metrics", "items": [ { "label": "Images", "value": 101, "display": "101", "href": "/app/media?filter=..." } ] },
{ "kind": "table", "title": "Media by type",
"columns": [ { "key": "type", "label": "Type", "align": "left" },
{ "key": "count", "label": "Count", "align": "right" },
{ "key": "share", "label": "Share", "align": "right" } ],
"rows": [ { "cells": { "type": "JPEG (image/jpeg)", "count": 81, "share": 0.802 },
"display": { "type": "JPEG (image/jpeg)", "count": "81", "share": "80.2%" },
"href": "/app/media?filter=..." } ] },
{ "kind": "chart", "chartType": "pie", "title": "Share by type",
"points": [ { "label": "JPEG", "value": 81, "display": "81", "href": "/app/media?filter=..." },
{ "label": "PNG", "value": 20, "display": "20", "href": "/app/media?filter=..." } ] },
{ "kind": "filterLinks", "items": [ { "label": "Open JPEG media (81)", "tableName": "media", "href": "/app/media?filter=..." } ] },
{ "kind": "recordLinks", "items": [ { "label": "Sunset.jpg", "tableName": "media", "recordId": "12", "href": "/app/media/12" } ] },
{ "kind": "actions", "items": [ { "label": "Show the PNG files", "prompt": "Show me the PNG media files" },
{ "label": "Open media", "href": "/app/media" } ] }
]
}
```
Rules:
- `summary` is required, one sentence, the direct answer first.
- `chartType` ∈ `bar`, `pie`, `line`; ≤ 12 points; values are numbers.
- Every `href` is built SERVER-SIDE from metadata and is an `/app` path (same rules as `TurnEngine.isAppHref`). Filtered list links are `/app/<tableName>?filter=<URL-encoded JSON {"criteria":[{"fieldName":..,"operator":..,"values":[..]}],"booleanOperator":"AND"}>`, which Next's `deserializeFilter` accepts (JSON starting with `{`). The model never writes URLs.
- `display` strings are formatted server-side from field metadata (`displayFormat`, e.g. `%,d`, `$%,.2f`; percent columns as `80.2%`); clients show `display` when present, else the raw value.
- `actions` items have either `prompt` (send as the user's next message) or `href` (navigate), never both.
- Unknown `kind`s must be ignored by clients (forward compatible); clients that do not render blocks render `markdown`.
- The SSE event is `presentation` with `{ "messageId": <id>, "part": <the part above> }`; Next's reducer appends it to the assistant message's parts.
## Tool input and implementation
The input schema is [present-results.schema.json](../qbit-assistant/src/main/resources/present-results.schema.json). `table.rowKeys` supplies one raw filter value per row; `table.rowFilter` names the table, field and optional operator (EQUALS by default). Columns receive stable server keys `c0`, `c1`, etc. Input cells remain raw scalars; each row has a parallel display map. The example keys above are illustrative.
`PresentResultsTool` is instantiated per turn. It caches `GET /metaData` with that turn's session, checks table read visibility and instance fields, validates QQQ criteria operators and builds paths using RC.5 `AiLinkBuilder`. Filter links use URL-encoded JSON accepted by Next. Record ids are encoded as opaque path segments. Metadata denial or invalid item drops that item (an invalid table drops its table/chart), with a short explanation to the model; other items survive. No data query or permission elevation happens here.
Limits: summary 300 characters, display text 2,000 characters, table 20 columns/200 rows, chart 12 points, item lists 100 entries, filters 20 criteria/200 values. Chart truncation is reported to the model. Percent columns reference a raw numeric column; a zero total yields 0.0%. Numbers still must originate in earlier data tool results; presentation is formatting, not a new source of facts.
The schema uses small named, nonrecursive definitions to avoid deeply inlined structures. Each object component is at most two levels of inline containers; the resolved table/criteria structure necessarily has the nesting shown in the owner contract. Strict is off by default. Opting `present_results` into strict mode requires all properties (empty arrays/strings, empty table and -1 for unused percentage indexes), removes provider-unsupported length constraints, and retains server validation. This has zero optional parameters and one shared scalar union in the existing strict-budget test.
Presentation parts are persisted with the assistant message and replayed as `presentation` events with `{messageId, part}` (plus the standard event sequence). They are removed by record-data retention along with tool renders. Model history and text-only consumers can use the server-built Markdown. Unknown block kinds should be ignored. Plain labels must be rendered as text, never parsed as links or HTML; fallback Markdown escapes them. Tool audit input records the accepted presentation only, excluding dropped values.
+200 -9
View File
@@ -6,7 +6,8 @@ CREATE TABLE assistant_conversation
(
id SERIAL PRIMARY KEY,
user_id VARCHAR(255),
title VARCHAR(255),
title TEXT,
max_classification VARCHAR(16),
status VARCHAR(16),
pinned BOOLEAN,
last_message_at TIMESTAMP WITH TIME ZONE,
@@ -30,7 +31,7 @@ CREATE TABLE assistant_message
status VARCHAR(16),
turn_id INTEGER,
seq INTEGER,
model VARCHAR(64),
model VARCHAR(200),
parts_json TEXT,
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE
@@ -46,10 +47,12 @@ CREATE TABLE assistant_turn
user_message_id INTEGER,
assistant_message_id INTEGER,
status VARCHAR(16),
classification VARCHAR(16),
classification_tables VARCHAR(500),
stop_reason VARCHAR(64),
error_code VARCHAR(32),
cancel_reason VARCHAR(64),
model VARCHAR(64),
model VARCHAR(200),
started_at TIMESTAMP WITH TIME ZONE,
ended_at TIMESTAMP WITH TIME ZONE,
tool_call_count INTEGER,
@@ -95,7 +98,7 @@ CREATE TABLE assistant_tool_call
widget_name VARCHAR(128),
row_count INTEGER,
duration_ms BIGINT,
result_summary VARCHAR(500),
result_summary TEXT,
result_json TEXT,
redactions_json TEXT,
ui_api_operation VARCHAR(255),
@@ -173,10 +176,22 @@ CREATE TABLE assistant_provider
id SERIAL PRIMARY KEY,
name VARCHAR(100) NOT NULL UNIQUE,
provider_type VARCHAR(50) NOT NULL,
model VARCHAR(100),
kind VARCHAR(30),
location VARCHAR(10),
hipaa_eligible BOOLEAN DEFAULT FALSE,
region VARCHAR(50),
cloud_project VARCHAR(100),
api_version VARCHAR(30),
connect_timeout_seconds INTEGER DEFAULT 10 CHECK (connect_timeout_seconds BETWEEN 1 AND 600),
request_timeout_seconds INTEGER DEFAULT 120 CHECK (request_timeout_seconds BETWEEN 1 AND 600),
last_discovery_at TIMESTAMP WITH TIME ZONE,
last_discovery_status VARCHAR(16),
last_discovery_error VARCHAR(500),
model VARCHAR(200),
enabled BOOLEAN,
is_default BOOLEAN,
base_url VARCHAR(255),
tls_ca_bundle VARCHAR(100),
api_key_env_name VARCHAR(100),
api_key_status VARCHAR(200),
monthly_cost_cap_usd NUMERIC(12, 2),
@@ -185,12 +200,38 @@ CREATE TABLE assistant_provider
last_test_at TIMESTAMP WITH TIME ZONE,
last_test_status VARCHAR(16),
last_test_latency_ms INTEGER,
last_test_model VARCHAR(100),
last_test_model VARCHAR(200),
last_test_error VARCHAR(500),
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE
);
CREATE TABLE assistant_model
(
id SERIAL PRIMARY KEY,
provider_id INTEGER NOT NULL REFERENCES assistant_provider(id),
model_id VARCHAR(200) NOT NULL,
display_name VARCHAR(200),
enabled BOOLEAN,
supports_tools BOOLEAN,
supports_vision BOOLEAN,
supports_streaming BOOLEAN,
supports_reasoning_effort BOOLEAN,
context_window_tokens INTEGER,
max_output_tokens INTEGER,
input_usd_per_m_tok NUMERIC(12, 4),
output_usd_per_m_tok NUMERIC(12, 4),
source VARCHAR(16),
discovered_at TIMESTAMP WITH TIME ZONE,
last_test_at TIMESTAMP WITH TIME ZONE,
last_test_status VARCHAR(16),
last_test_latency_ms INTEGER,
last_test_error VARCHAR(500),
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE,
UNIQUE (provider_id, model_id)
);
CREATE TABLE assistant_model_price
(
id SERIAL PRIMARY KEY,
@@ -215,7 +256,7 @@ CREATE TABLE assistant_usage
turn_id INTEGER,
provider_id INTEGER,
provider_type VARCHAR(50),
model VARCHAR(100),
model VARCHAR(200),
purpose VARCHAR(16),
status VARCHAR(16),
error_kind VARCHAR(32),
@@ -275,10 +316,10 @@ CREATE TABLE assistant_pending_action
table_name VARCHAR(128),
record_id VARCHAR(128),
params_json TEXT,
summary VARCHAR(500),
summary TEXT,
status VARCHAR(16),
http_status INTEGER,
result_summary VARCHAR(500),
result_summary TEXT,
expires_at TIMESTAMP WITH TIME ZONE,
decided_at TIMESTAMP WITH TIME ZONE,
create_date TIMESTAMP WITH TIME ZONE,
@@ -286,3 +327,153 @@ CREATE TABLE assistant_pending_action
);
CREATE INDEX assistant_pending_action_user_id ON assistant_pending_action (user_id);
CREATE INDEX assistant_pending_action_conversation_id ON assistant_pending_action (conversation_id);
-- 0.1.0-RC.6: profiles (persona) and skills. Text the model reads; never tools or access.
CREATE TABLE assistant_profile
(
id SERIAL PRIMARY KEY,
name VARCHAR(64) NOT NULL UNIQUE,
display_name VARCHAR(64) NOT NULL,
icon VARCHAR(64),
personality TEXT,
greeting VARCHAR(500),
starter_prompts TEXT,
is_default BOOLEAN,
enabled BOOLEAN,
app_name VARCHAR(128),
permission_name VARCHAR(128),
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE
);
CREATE TABLE assistant_skill
(
id SERIAL PRIMARY KEY,
name VARCHAR(64) NOT NULL UNIQUE,
description VARCHAR(500),
instructions TEXT NOT NULL,
enabled BOOLEAN,
trigger_keywords VARCHAR(500),
app_names VARCHAR(500),
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE
);
CREATE TABLE assistant_profile_skill
(
id SERIAL PRIMARY KEY,
profile_id INTEGER NOT NULL,
skill_id INTEGER NOT NULL,
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE,
CONSTRAINT assistant_profile_skill_pair UNIQUE (profile_id, skill_id)
);
CREATE TABLE assistant_data_audit
(
id SERIAL PRIMARY KEY,
user_id VARCHAR(255),
conversation_id INTEGER,
turn_id INTEGER,
provider_id INTEGER,
provider_name VARCHAR(200),
model VARCHAR(200),
hipaa_eligible BOOLEAN,
classification VARCHAR(16),
tables VARCHAR(500),
decision VARCHAR(16),
reason VARCHAR(1000),
create_date TIMESTAMP WITH TIME ZONE
);
CREATE INDEX assistant_data_audit_user_id ON assistant_data_audit (user_id);
CREATE INDEX assistant_data_audit_conversation_id ON assistant_data_audit (conversation_id);
CREATE INDEX assistant_data_audit_turn_id ON assistant_data_audit (turn_id);
-- P-d: data-driven budgets (UTC periods, USD or whole-token allowances).
CREATE TABLE assistant_budget
(
id SERIAL PRIMARY KEY,
name VARCHAR(200) NOT NULL,
enabled BOOLEAN DEFAULT TRUE,
scope_type VARCHAR(16) NOT NULL,
scope_value VARCHAR(200),
period VARCHAR(16) NOT NULL,
metric VARCHAR(16) NOT NULL,
limit_value NUMERIC NOT NULL CHECK (limit_value > 0),
warn_percent INTEGER DEFAULT 80 CHECK (warn_percent >= 0 AND warn_percent < 100),
at_limit_action VARCHAR(16) DEFAULT 'DOWNGRADE',
downgrade_model_id INTEGER REFERENCES assistant_model(id),
hard_ceiling_percent INTEGER DEFAULT 120 CHECK (hard_ceiling_percent >= 100),
notes VARCHAR(2000),
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE
);
CREATE TABLE assistant_budget_override
(
id SERIAL PRIMARY KEY,
budget_id INTEGER NOT NULL REFERENCES assistant_budget(id),
scope_value VARCHAR(200),
extra_value NUMERIC,
unlimited_until TIMESTAMP WITH TIME ZONE,
reason VARCHAR(1000) NOT NULL,
granted_by VARCHAR(200),
expires_at TIMESTAMP WITH TIME ZONE NOT NULL,
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE,
CHECK ((extra_value > 0 AND unlimited_until IS NULL) OR (extra_value IS NULL AND unlimited_until IS NOT NULL))
);
CREATE INDEX assistant_budget_override_budget_id ON assistant_budget_override(budget_id);
CREATE TABLE assistant_budget_event
(
id SERIAL PRIMARY KEY,
budget_id INTEGER NOT NULL REFERENCES assistant_budget(id),
scope_key VARCHAR(400) NOT NULL,
period_start TIMESTAMP WITH TIME ZONE NOT NULL,
state VARCHAR(16) NOT NULL,
used_value NUMERIC,
limit_value NUMERIC,
user_id VARCHAR(200),
create_date TIMESTAMP WITH TIME ZONE,
UNIQUE (budget_id, scope_key, period_start, state)
);
CREATE INDEX assistant_usage_budget_period ON assistant_usage(create_date, user_id, provider_id, model);
-- Private projection: standard admin permissions, AI NONE, no owner lock.
-- No conversation identifiers, text, request ids or credentials are copied.
CREATE TABLE assistant_budget_usage
(
id SERIAL PRIMARY KEY,
usage_id INTEGER NOT NULL UNIQUE,
user_id VARCHAR(255),
provider_id INTEGER,
model VARCHAR(200),
occurred_at TIMESTAMP WITH TIME ZONE NOT NULL,
cost_micros BIGINT,
input_tokens BIGINT,
output_tokens BIGINT,
cache_read_tokens BIGINT,
cache_write_tokens BIGINT
);
CREATE INDEX assistant_budget_usage_period ON assistant_budget_usage(occurred_at, provider_id, model);
-- Run once before enabling P-d, with writes paused, to include existing usage.
INSERT INTO assistant_budget_usage
(usage_id, user_id, provider_id, model, occurred_at, cost_micros, input_tokens, output_tokens, cache_read_tokens, cache_write_tokens)
SELECT id, user_id, provider_id, model, create_date, cost_micros, input_tokens, output_tokens, cache_read_tokens, cache_write_tokens
FROM assistant_usage
ON CONFLICT (usage_id) DO NOTHING;
-- P-e: profile routing, bounded fallback chains, provider health and turn outcome.
ALTER TABLE assistant_profile ADD COLUMN routing_mode VARCHAR(16) DEFAULT 'OFF'
CHECK (routing_mode IN ('OFF', 'HEURISTIC', 'CLASSIFIER'));
ALTER TABLE assistant_profile ADD COLUMN simple_model_id INTEGER REFERENCES assistant_model(id);
ALTER TABLE assistant_profile ADD COLUMN complex_model_id INTEGER REFERENCES assistant_model(id);
ALTER TABLE assistant_profile ADD COLUMN classifier_model_id INTEGER REFERENCES assistant_model(id);
ALTER TABLE assistant_model ADD COLUMN fallback_model_id INTEGER REFERENCES assistant_model(id);
ALTER TABLE assistant_provider ADD COLUMN health_state VARCHAR(8) CHECK (health_state IN ('UP', 'DOWN'));
ALTER TABLE assistant_provider ADD COLUMN health_checked_at TIMESTAMP WITH TIME ZONE;
ALTER TABLE assistant_provider ADD COLUMN down_until TIMESTAMP WITH TIME ZONE;
ALTER TABLE assistant_turn ADD COLUMN route_decision VARCHAR(16);
ALTER TABLE assistant_turn ADD COLUMN route_source VARCHAR(16);
ALTER TABLE assistant_turn ADD COLUMN fallback_count INTEGER DEFAULT 0;
ALTER TABLE assistant_turn ADD COLUMN provider_id INTEGER REFERENCES assistant_provider(id);
+25
View File
@@ -10,3 +10,28 @@ Light and dark, 390 and 1440 px:
- `provider-not-set-*`: a provider whose key variable is not set.
- `provider-edit-*`: the edit form.
- `prices-*`: the model price table.
0.1.0-RC.6 additions, taken 2026-10-13 with the same demo server and the Next UI 1.0.0-RC.17 jar. The demo seeds a profile ("Ada"), two skills, and data access rows (page READ_WRITE, media NONE). Its tools run through the `/qqq/v1` UI API.
Light and dark, 390 and 1440 px:
- `home-denials-*`: the home's "Recent denials" card. The analyst's `count_records` on Blog Post got HTTP 403 from `POST /table/{tableName}/count`.
- `home-access-*`: the "Data access: what the assistant can do for you" widget (Explain access), with each table's access and each tool allowed or denied, with the reason.
- `data-access-*`: the Data access table.
- `profile-*`: a profile (persona), with its personality, its scope and its Skills child list.
- `skill-*`: a skill: its instructions and when it is used.
- `policy-*`: the policy, with its "Tools and data" section.
- `panel-persona-*`: the panel with the configured persona. This is the Next UI build of qqq-frontend-next#94; the demo's admin matches the permission-scoped "Ada (analytics)" profile.
- `panel-pending-*`: the assistant proposed `update_record` on page 12, which is READ_WRITE. The card shows the change with Save and Cancel; nothing is saved yet.
- `panel-confirmed-*`: after Save, the write ran once through `PATCH /qqq/v1/table/page/12` with the user's session. The card says Done, and the record screen behind the panel shows the new value.
Planned P-a provider registry additions, taken against `OpenAiDemoServer` in the
OpenAI provider's test sources with the Next UI **1.0.0-RC.18** jar. See that
[demo's run instructions](../../qbit-assistant-provider-openai/src/test/java/com/kingsrook/qbits/assistant/provider/openai/demo/README.md).
Discovery and connection-test status, TEST usage and the assistant turn are real
executions against the localhost mock; replies/token counts are synthetic, not
live GPU measurements. No screenshots in this group have been added yet.
Light and dark, 390 and 1440 px:
- `p-provider-local-*`: Local GPU (Ollama), keyless LOCAL settings, discovery/test results and discovered models.
- `p-model-*`: a discovered model's capabilities, compute prices and connection-test result.
- `p-home-providers-*`: the home's provider summary and usage from the executed demo calls, including disabled OpenRouter with its key Not set.
Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

+25 -2
View File
@@ -52,6 +52,9 @@
<modules>
<module>qbit-assistant</module>
<module>qbit-assistant-provider-anthropic</module>
<module>qbit-assistant-provider-openai</module>
<module>qbit-assistant-provider-bedrock</module>
<module>qbit-assistant-provider-vertex</module>
</modules>
<licenses>
@@ -81,6 +84,21 @@
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-provider-anthropic</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>com.anthropic</groupId>
<artifactId>anthropic-java-bedrock</artifactId>
<version>${anthropic.version}</version>
</dependency>
<dependency>
<groupId>com.anthropic</groupId>
<artifactId>anthropic-java-vertex</artifactId>
<version>${anthropic.version}</version>
</dependency>
<!-- QQQ 4.1 is built on Jackson 2.21; the Anthropic SDK asks for 2.19. -->
<!-- Pin the newer one so both resolve to the same line. -->
<dependency>
@@ -101,6 +119,11 @@
<version>${revision}</version>
<type>test-jar</type>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-provider-openai</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>com.anthropic</groupId>
<artifactId>anthropic-java</artifactId>
@@ -170,7 +193,7 @@
</build>
<profiles>
<!-- The assistant needs QQQ 4.1.0-RC.4: the AI tool kernel (package -->
<!-- The assistant needs QQQ 4.1.0-RC.5: the AI tool kernel (package -->
<!-- actions.ai, qqq#1078) and the developer panels (qqq#1076). Until -->
<!-- qbit-build-parent imports the 4.1 BOM, this -->
<!-- profile is active by default and imports qqq-bom-pom ahead of the -->
@@ -182,7 +205,7 @@
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<qqq.snapshot.version>4.1.0-RC.4</qqq.snapshot.version>
<qqq.snapshot.version>4.1.0-RC.5</qqq.snapshot.version>
</properties>
<dependencyManagement>
<dependencies>
@@ -98,15 +98,16 @@ public class AnthropicModelProvider implements AssistantModelProvider
/*******************************************************************************
** Builds the provider. apiKey is required (a literal from a secret store,
** or "${env.NAME}").
** Builds the provider. Unless a client is supplied, apiKey is required
** (a literal from a secret store, or "${env.NAME}").
*******************************************************************************/
public static class Builder
{
private String apiKey;
private String baseUrl;
private Duration timeout = Duration.ofMinutes(10);
private Integer maxRetries = 2;
private String apiKey;
private AnthropicClient client;
private String baseUrl;
private Duration timeout = Duration.ofMinutes(10);
private Integer maxRetries = 2;
@@ -121,6 +122,19 @@ public class AnthropicModelProvider implements AssistantModelProvider
/*******************************************************************************
** Use an already configured client, including a cloud backend. The provider
** owns and closes this client; key, URL, timeout and retry builder options
** apply only when the builder creates its own client.
*******************************************************************************/
public Builder client(AnthropicClient client)
{
this.client = client;
return (this);
}
/*******************************************************************************
** Another API base URL (a gateway, or a test server).
*******************************************************************************/
@@ -159,6 +173,10 @@ public class AnthropicModelProvider implements AssistantModelProvider
*******************************************************************************/
public AnthropicModelProvider build()
{
if(client != null)
{
return (new AnthropicModelProvider(client, baseUrl));
}
String key = resolveSecret(apiKey);
if(!StringUtils.hasContent(key))
{
@@ -260,6 +278,26 @@ public class AnthropicModelProvider implements AssistantModelProvider
return (handle);
}
if(Boolean.FALSE.equals(request.getStreaming()))
{
java.util.concurrent.Future<?> completion = executor.submit(() ->
{
try
{
handle.complete(AnthropicMapping.toResponse(client.messages().create(params)));
}
catch(Throwable error)
{
if(!handle.isCancelled())
{
handle.fail(AnthropicMapping.toProviderException(error));
}
}
});
handle.setOnCancel(() -> completion.cancel(true));
return (handle);
}
AtomicReference<ModelUsage> seen = new AtomicReference<>();
handle.setPartialUsage(seen::get);
@@ -51,6 +51,39 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy;
*******************************************************************************/
class AnthropicModelProviderTest
{
/*******************************************************************************
** Routing requests use a single JSON reply without text deltas.
*******************************************************************************/
@Test
void nonStreamingClassifier() throws Exception
{
server.thenError(200, "classifier-response.json");
ModelRequest request = new ModelRequest().withModel("claude-sonnet-5-5").withMaxTokens(4).withStreaming(false)
.withMessages(List.of(ModelMessage.user("hello")));
List<String> deltas = new ArrayList<>();
ModelResponse response = provider.stream(request, deltas::add).await(Duration.ofSeconds(3));
assertThat(response.getText()).isEqualTo("SIMPLE");
assertThat(response.getUsage().getOutputTokens()).isEqualTo(1L);
assertThat(deltas).isEmpty();
assertThat(sentBody(0).get("stream")).isIn(null, false);
assertThat(sentBody(0).get("max_tokens")).isEqualTo(4);
}
/*******************************************************************************
** Non-streaming errors retain the normal exception mapping.
*******************************************************************************/
@Test
void nonStreamingError() throws Exception
{
server.thenError(401, "unauthorized.json");
assertThatThrownBy(() -> provider.stream(request().withStreaming(false), new StringBuilder()::append).await(Duration.ofSeconds(3)))
.isInstanceOfSatisfying(ModelProviderException.class, error -> assertThat(error.getKind()).isEqualTo(ModelProviderException.Kind.AUTHENTICATION));
}
private static final String TEST_KEY = "sk-ant-test-0000000000000000000000";
private RecordedAnthropicServer server;
@@ -342,4 +375,28 @@ class AnthropicModelProviderTest
.hasMessageContaining("ANTHROPIC_API_KEY");
}
/*******************************************************************************
** An injected cloud-capable client wins over the key and HTTP builder options.
*******************************************************************************/
@Test
void injectedClientTakesPrecedence() throws Exception
{
server.thenStream("text-with-thinking.sse", 0);
var client = com.anthropic.client.okhttp.AnthropicOkHttpClient.builder().apiKey(TEST_KEY).baseUrl(server.baseUrl()).maxRetries(0).build();
var injected = AnthropicModelProvider.builder().client(client).apiKey(null).baseUrl("https://unused.invalid").build();
try
{
var response = injected.stream(request(), delta -> {}).await(Duration.ofSeconds(10));
assertThat(response.getText()).isEqualTo("There are 4 published posts.");
assertThat(server.getRequests()).hasSize(1);
assertThat(server.getRequests().getFirst().get("apiKey")).isEqualTo(TEST_KEY);
}
finally
{
injected.close();
}
}
}
@@ -108,6 +108,24 @@ class AnthropicRequestContractTest
/*******************************************************************************
** Presentation remains inside the actual serialized strict request budget.
*******************************************************************************/
@Test
void testPresentationStrictOptIn() throws Exception
{
Map<String, Object> body = requestBody(new AssistantQBitConfig().withModelProvider(new ScriptedModelProvider()).withStrictToolNames(Set.of("present_results")));
assertThat(violations(body)).isEmpty();
assertThat(strictBudgetViolations(body)).isEmpty();
assertThat(tools(body)).anySatisfy(tool ->
{
assertThat(tool.get("name")).isEqualTo("present_results");
assertThat(tool.get("strict")).isEqualTo(true);
});
}
/*******************************************************************************
** The RC.3 shape (every tool strict) is recognized as over budget, and a
** host can still opt a few tools in.
@@ -129,6 +129,22 @@ public class AssistantDemoServer extends AbstractQQQApplication
"cacheWrite1hUsdPerMTok", BigDecimal.valueOf(p.getCacheWrite1hUsdPerMTok()), "notes", "Anthropic list price, 2026-10"));
}
////////////////////////////////////////////////////////////////////
// persona, a skill, and data access (page READ_WRITE, media NONE) //
////////////////////////////////////////////////////////////////////
Integer ada = insert("assistant_profile", Map.of("name", "default", "displayName", "Ada", "icon", "school", "isDefault", true,
"personality", "Friendly and brief. Use plain words and short lists.", "greeting", "Hi, I'm Ada. Ask me about your posts and pages.",
"starterPrompts", "How many published posts are there?\nWhat changed on page 12 this week?\nWhich posts have no excerpt?"));
insert("assistant_profile", Map.of("name", "analysts", "displayName", "Ada (analytics)", "icon", "insights", "permissionName", "analytics_daily_stat.read",
"personality", "Lead with the number, then one sentence of context."));
Integer style = insert("assistant_skill", Map.of("name", "blog-style-guide", "description", "House style for titles and excerpts",
"instructions", "## Blog style\n- Titles: sentence case, at most 60 characters.\n- Excerpts: one sentence, no links.", "triggerKeywords", "title, excerpt, headline"));
insert("assistant_skill", Map.of("name", "seo-basics", "description", "Meta description rules", "instructions", "Meta descriptions are 120 to 155 characters.",
"triggerKeywords", "seo, meta description", "enabled", true));
insert("assistant_profile_skill", Map.of("profileId", ada, "skillId", style));
insert("assistant_data_access", Map.of("objectType", "TABLE", "objectName", "page", "mode", "READ_WRITE", "notes", "Editors may let the assistant draft page changes (confirmed in the panel)."));
insert("assistant_data_access", Map.of("objectType", "TABLE", "objectName", "media", "mode", "NONE", "notes", "Not needed for content questions."));
api.thenStream("text-with-thinking.sse", 0);
ConnectionTest.run(config.getRuntime(), config.getRuntime().getStore().getProvider(production), "admin-1");
ConnectionTest.run(config.getRuntime(), config.getRuntime().getStore().getProvider(staging), "admin-1");
@@ -144,6 +160,15 @@ public class AssistantDemoServer extends AbstractQQQApplication
api.thenError(529, "overloaded.json").thenError(529, "overloaded.json").thenError(529, "overloaded.json");
runner.run(AssistantTestFixture.OTHER_EDITOR, "Draft a post outline.");
///////////////////////////////////////////////////////////////////
// the first question asked in the panel proposes a page change //
// (page is READ_WRITE): the panel shows the confirmation card //
///////////////////////////////////////////////////////////////////
for(int i = 0; i < 8; i++)
{
api.thenStream("propose-page-update.sse", 0).thenStream("proposed-answer.sse", 0);
}
instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("mock").withType(QAuthenticationType.MOCK)
.withCustomizer(new QCodeReference(DemoSessionCustomizer.class)));
instance.setHomeAppName(AssistantMetaDataBuilder.APP_NAME);
@@ -0,0 +1 @@
{"id":"msg_classify","type":"message","role":"assistant","model":"claude-sonnet-5-5","content":[{"type":"text","text":"SIMPLE"}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":18,"output_tokens":1}}
@@ -0,0 +1,39 @@
event: message_start
data: {"type":"message_start","message":{"id":"msg_tools_01","type":"message","role":"assistant","model":"claude-sonnet-5-5","content":[],"stop_reason":null,"stop_sequence":null,"usage":{"input_tokens":300,"output_tokens":1,"cache_creation_input_tokens":0,"cache_read_input_tokens":5000}}}
event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"thinking","thinking":"","signature":""}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"signature_delta","signature":"sig-tools-1"}}
event: content_block_stop
data: {"type":"content_block_stop","index":0}
event: content_block_start
data: {"type":"content_block_start","index":1,"content_block":{"type":"text","text":""}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"text_delta","text":"I can draft that page change for you."}}
event: content_block_stop
data: {"type":"content_block_stop","index":1}
event: content_block_start
data: {"type":"content_block_start","index":2,"content_block":{"type":"tool_use","id":"toolu_W","name":"update_record","input":{}}}
event: content_block_delta
data: {"type":"content_block_delta","index":2,"delta":{"type":"input_json_delta","partial_json":"{\"table\": \"page\", \"id\": \"12\", "}}
event: content_block_delta
data: {"type":"content_block_delta","index":2,"delta":{"type":"input_json_delta","partial_json":"\"values\": {\"metaDescription\": \"Who I am, what I build, and the home lab behind it.\"}}"}}
event: content_block_stop
data: {"type":"content_block_stop","index":2}
event: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"tool_use","stop_sequence":null},"usage":{"output_tokens":60}}
event: message_stop
data: {"type":"message_stop"}
@@ -0,0 +1,36 @@
event: message_start
data: {"type":"message_start","message":{"id":"msg_text_01","type":"message","role":"assistant","model":"claude-sonnet-5-5","content":[],"stop_reason":null,"stop_sequence":null,"usage":{"input_tokens":120,"output_tokens":1,"cache_creation_input_tokens":2048,"cache_read_input_tokens":0,"cache_creation":{"ephemeral_5m_input_tokens":48,"ephemeral_1h_input_tokens":2000}}}}
event: content_block_start
data: {"type":"content_block_start","index":0,"content_block":{"type":"thinking","thinking":"","signature":""}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"thinking_delta","thinking":"SECRET_THINKING_TEXT"}}
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"signature_delta","signature":"sig-abc-123"}}
event: content_block_stop
data: {"type":"content_block_stop","index":0}
event: content_block_start
data: {"type":"content_block_start","index":1,"content_block":{"type":"text","text":""}}
event: ping
data: {"type":"ping"}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"text_delta","text":""}}
event: content_block_delta
data: {"type":"content_block_delta","index":1,"delta":{"type":"text_delta","text":"I proposed the new meta description for page 12. Confirm it in the card to save it."}}
event: content_block_stop
data: {"type":"content_block_stop","index":1}
event: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"end_turn","stop_sequence":null},"usage":{"output_tokens":42}}
event: message_stop
data: {"type":"message_stop"}
+137
View File
@@ -0,0 +1,137 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2026 Kingsrook, LLC
~
~ 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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-parent</artifactId>
<version>${revision}</version>
</parent>
<artifactId>qbit-assistant-provider-bedrock</artifactId>
<packaging>jar</packaging>
<name>QBit Assistant - Bedrock provider</name>
<description>Bedrock provider using the Anthropic cloud backend</description>
<url>https://github.com/QRun-IO/qbit-assistant</url>
<dependencies>
<dependency>
<groupId>com.anthropic</groupId>
<artifactId>anthropic-java-bedrock</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-provider-anthropic</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-backend-core</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant</artifactId>
<type>test-jar</type>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-middleware-javalin</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!-- live evals call the real API: opt-in only -->
<excludedGroups>${test.excludedGroups}</excludedGroups>
<redirectTestOutputToFile>true</redirectTestOutputToFile>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<executions>
<execution>
<id>prepare-agent</id>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>verify</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
<execution>
<id>check</id>
<goals>
<goal>check</goal>
</goals>
<configuration>
<rules>
<rule>
<element>BUNDLE</element>
<limits>
<limit>
<counter>INSTRUCTION</counter>
<value>COVEREDRATIO</value>
<minimum>0.70</minimum>
</limit>
<limit>
<counter>CLASS</counter>
<value>COVEREDRATIO</value>
<minimum>0.90</minimum>
</limit>
</limits>
</rule>
</rules>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,73 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.bedrock;
import com.anthropic.backends.Backend;
import com.anthropic.core.http.HttpRequest;
import com.anthropic.core.http.HttpResponse;
/*******************************************************************************
** SDK 2.71 has no Bedrock endpoint setter. Override only the endpoint, keeping
** the SDK's request conversion, SigV4 signing of that endpoint, and decoding.
** The caller must validate the URL against the host's allowlist first.
*******************************************************************************/
record BedrockEndpointBackend(Backend delegate, String baseUrl) implements Backend
{
/*******************************************************************************
** Preserve the Bedrock model-path and body conversion.
*******************************************************************************/
@Override
public HttpRequest prepareRequest(HttpRequest request)
{
return (delegate.prepareRequest(request));
}
/*******************************************************************************
** Sign the actual request URL, including the overridden host.
*******************************************************************************/
@Override
public HttpRequest authorizeRequest(HttpRequest request)
{
return (delegate.authorizeRequest(request));
}
/*******************************************************************************
** Decode the AWS event stream through the SDK.
*******************************************************************************/
@Override
public HttpResponse prepareResponse(HttpResponse response)
{
return (delegate.prepareResponse(response));
}
/*******************************************************************************
** Release the SDK's stream conversion resources.
*******************************************************************************/
@Override
public void close()
{
delegate.close();
}
}
@@ -0,0 +1,185 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.bedrock;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import com.anthropic.backends.Backend;
import com.anthropic.bedrock.backends.BedrockBackend;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.core.Timeout;
import com.kingsrook.qbits.assistant.model.AssistantProvider;
import com.kingsrook.qbits.assistant.provider.AssistantModelProvider;
import com.kingsrook.qbits.assistant.provider.AssistantProviderType;
import com.kingsrook.qbits.assistant.provider.DiscoveredModel;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.provider.anthropic.AnthropicModelProvider;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
import software.amazon.awssdk.regions.Region;
/*******************************************************************************
** AWS Bedrock (Claude), using server credentials and region-derived endpoints.
** Environment, profile and container (ECS/EKS Pod Identity) credentials use
** the transitive SDK dependencies. Hosts using IRSA / web identity must add
** software.amazon.awssdk:sts to their runtime classpath; the default credential
** chain discovers it when present. This adapter does not depend on STS.
*******************************************************************************/
public class BedrockProviderType implements AssistantProviderType
{
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getType()
{
return ("bedrock");
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getLabel()
{
return ("AWS Bedrock (Claude)");
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public List<String> getModels()
{
return (List.of("us.anthropic.claude-sonnet-4-5-20250929-v1:0", "us.anthropic.claude-haiku-4-5-20251001-v1:0"));
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getDefaultApiKeyEnvName()
{
return (null);
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getDefaultBaseUrl()
{
return (null);
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public boolean requiresBaseUrl(String kind)
{
return (false);
}
/*******************************************************************************
** Validate cloud settings without loading credentials.
*******************************************************************************/
@Override
public List<String> validate(AssistantProvider row)
{
List<String> errors = new ArrayList<>();
if(row.getRegion() == null || row.getRegion().isBlank())
{
errors.add("Region is required for BEDROCK.");
}
if(row.getApiKeyEnvName() != null && !row.getApiKeyEnvName().isBlank())
{
errors.add("Leave API key variable empty: AWS Bedrock (Claude) uses the AWS default credential chain (environment, profile or server role).");
}
return (errors);
}
/*******************************************************************************
** Cloud providers require resolved region/project settings.
*******************************************************************************/
@Override
public AssistantModelProvider create(String apiKey, String baseUrl)
{
throw (new IllegalArgumentException("Use ProviderSettings with the required cloud region."));
}
/*******************************************************************************
** Static defaults: ListFoundationModels requires the Bedrock control-plane SDK,
** which this adapter deliberately does not add.
*******************************************************************************/
@Override
public List<DiscoveredModel> discoverModels(ProviderSettings settings)
{
return (getModels().stream().map(id -> new DiscoveredModel(id, id, null, null)).toList());
}
/*******************************************************************************
** Create the provider with server credentials.
*******************************************************************************/
@Override
public AssistantModelProvider create(ProviderSettings settings)
{
return (create(settings, DefaultCredentialsProvider.builder().build()));
}
/*******************************************************************************
** Credential injection for contract tests; no credential values are stored.
*******************************************************************************/
AnthropicModelProvider create(ProviderSettings settings, AwsCredentialsProvider credentials)
{
Backend backend = BedrockBackend.builder().region(Region.of(settings.getRegion())).awsCredentialsProvider(credentials).build();
if(settings.getBaseUrl() != null)
{
backend = new BedrockEndpointBackend(backend, settings.getBaseUrl());
}
var client = AnthropicOkHttpClient.builder().backend(backend)
.timeout(Timeout.builder().connect(Duration.ofSeconds(settings.getConnectTimeoutSeconds()))
.request(Duration.ofSeconds(settings.getRequestTimeoutSeconds())).build());
return (AnthropicModelProvider.builder().client(client.build()).build());
}
}
@@ -0,0 +1,213 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.bedrock;
import java.nio.charset.StandardCharsets;
import java.time.Clock;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.engine.ProviderService;
import com.kingsrook.qbits.assistant.model.AssistantProvider;
import com.kingsrook.qbits.assistant.provider.ModelEventListener;
import com.kingsrook.qbits.assistant.provider.ModelMessage;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ModelToolDefinition;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.provider.anthropic.AnthropicModelProvider;
import com.kingsrook.qbits.assistant.testing.CloudProviderTestServer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
import static com.kingsrook.qbits.assistant.testing.CloudProviderTestServer.JSON;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Real Anthropic Bedrock SDK against signed loopback requests and binary streams.
*******************************************************************************/
class BedrockContractTest
{
static final String MODEL = "us.anthropic.claude-sonnet-4-5-20250929-v1:0";
/*******************************************************************************
** Explicit fake credentials avoid all default-chain network lookup in tests.
*******************************************************************************/
static AnthropicModelProvider provider(CloudProviderTestServer server)
{
return (new BedrockProviderType().create(new ProviderSettings().withRegion("us-east-1").withBaseUrl(server.url())
.withConnectTimeoutSeconds(2).withRequestTimeoutSeconds(5),
StaticCredentialsProvider.create(AwsBasicCredentials.create("AKIDEXAMPLE", "synthetic-secret"))));
}
/*******************************************************************************
** Engine-shaped request with an opted-in strict tool.
*******************************************************************************/
static ModelRequest request()
{
return (new ModelRequest().withModel(MODEL).withMaxTokens(1024).withMessages(List.of(ModelMessage.user("Count posts")))
.withTools(List.of(new ModelToolDefinition().withName("count_records").withDescription("Count records").withStrict(true)
.withInputSchema(Map.of("type", "object", "properties", Map.of("table", Map.of("type", "string")), "required", List.of("table"), "additionalProperties", false)))));
}
/*******************************************************************************
** Binary chunk framing, SigV4, request rewriting, text, tools and usage.
*******************************************************************************/
@Test
void streamingContract() throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
server.enqueue(200, "application/vnd.amazon.eventstream", BedrockEventStream.encode(CloudProviderTestServer.anthropicEvents(MODEL, "Checking.", Map.of("table", "blog_post"))));
AnthropicModelProvider provider = provider(server);
try
{
StringBuilder text = new StringBuilder();
List<String> tools = new ArrayList<>();
var response = provider.stream(request(), new ModelEventListener()
{
/*******************************************************************************
** Capture only visible text.
*******************************************************************************/
@Override
public void onTextDelta(String delta)
{
text.append(delta);
}
/*******************************************************************************
** Confirm tool-start callbacks pass through the reused adapter.
*******************************************************************************/
@Override
public void onToolUseStart(String id, String name)
{
tools.add(id + ":" + name);
}
}).await(Duration.ofSeconds(10));
assertThat(text.toString()).isEqualTo("Checking.");
assertThat(response.getText()).isEqualTo("Checking.");
assertThat(tools).containsExactly("count:count_records");
assertThat(response.getToolUses()).singleElement().satisfies(tool ->
{
assertThat(tool.getToolUseId()).isEqualTo("count");
assertThat(tool.getInput()).containsEntry("table", "blog_post");
});
assertThat(response.getStopReason()).isEqualTo("tool_use");
assertThat(response.getUsage().getInputTokens()).isEqualTo(12);
assertThat(response.getUsage().getOutputTokens()).isEqualTo(7);
var sent = server.requests.getFirst();
assertThat(sent.path()).isEqualTo("/model/" + MODEL + "/invoke-with-response-stream");
assertThat(sent.authorization()).startsWith("AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/").contains("/us-east-1/bedrock/aws4_request", "Signature=");
var body = JSON.readTree(sent.body());
assertThat(body.path("anthropic_version").asText()).isEqualTo("bedrock-2023-05-31");
assertThat(body.has("model")).isFalse();
assertThat(body.has("stream")).isFalse();
assertThat(body.path("max_tokens").asInt()).isEqualTo(1024);
assertThat(body.path("messages").get(0).path("role").asText()).isEqualTo("user");
assertThat(body.path("tools").get(0).path("strict").asBoolean()).isTrue();
}
finally
{
provider.close();
}
}
}
/*******************************************************************************
** The cloud backend keeps the Anthropic adapter's HTTP error mapping.
*******************************************************************************/
@ParameterizedTest
@CsvSource({ "403,AUTHENTICATION", "429,RATE_LIMITED", "500,SERVER" })
void errors(Integer status, ModelProviderException.Kind kind) throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
for(int attempt = 0; attempt < 3; attempt++)
{
server.enqueue(status, "application/json", "{\"message\":\"Synthetic failure\"}".getBytes(StandardCharsets.UTF_8));
}
AnthropicModelProvider provider = provider(server);
try
{
assertThatThrownBy(() -> provider.stream(request(), delta -> {}).await(Duration.ofSeconds(20)))
.isInstanceOfSatisfying(ModelProviderException.class, error ->
{
assertThat(error.getKind()).isEqualTo(kind);
assertThat(error.getHttpStatus()).isEqualTo(status);
});
}
finally
{
provider.close();
}
}
}
/*******************************************************************************
** Registry defaults and validation run without resolving AWS credentials.
*******************************************************************************/
@Test
void settingsValidationAndDefaults() throws Exception
{
var type = new BedrockProviderType();
var config = new AssistantQBitConfig().withProviderType(type).withAllowedBaseUrls(Set.of("http://127.0.0.1:1234"));
var service = new ProviderService(config, null, Clock.systemUTC());
var row = new AssistantProvider().withProviderType("bedrock");
assertThat(service.validate(row)).anyMatch(error -> error.contains("Region is required"));
row.withRegion(" ");
assertThat(service.validate(row)).anyMatch(error -> error.contains("Region is required"));
row.withRegion("us-east-1");
assertThat(service.validate(row)).isEmpty();
row.withApiKeyEnvName("AWS_API_KEY");
assertThat(service.validate(row)).anyMatch(error -> error.contains("default credential chain"));
row.withApiKeyEnvName(" ").withBaseUrl("https://unlisted.example");
assertThat(service.validate(row)).anyMatch(error -> error.contains("not allowed"));
row.withBaseUrl("http://127.0.0.1:1234");
assertThat(service.validate(row)).isEmpty();
assertThat(type.getType()).isEqualTo("bedrock");
assertThat(type.getKinds()).containsExactly("BEDROCK");
assertThat(type.getLabel()).isEqualTo("AWS Bedrock (Claude)");
assertThat(type.getDefaultLocation("BEDROCK")).isEqualTo("CLOUD");
assertThat(type.getDefaultApiKeyEnvName()).isNull();
assertThat(type.getDefaultBaseUrl()).isNull();
assertThat(type.discoverModels(new ProviderSettings())).extracting(model -> model.modelId()).containsExactlyElementsOf(type.getModels());
assertThat(type.checkHealth(new ProviderSettings()).healthy()).isNull();
assertThatThrownBy(() -> type.create("key", null)).isInstanceOf(IllegalArgumentException.class);
// Client creation is lazy: no credentials are resolved and no request sent.
var defaultChain = (AnthropicModelProvider) type.create(new ProviderSettings().withRegion("us-east-1"));
defaultChain.close();
}
}
@@ -0,0 +1,90 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.bedrock;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.List;
import java.util.Map;
import java.util.zip.CRC32;
import com.kingsrook.qbits.assistant.testing.CloudProviderTestServer;
/*******************************************************************************
** Test-side AWS event-stream encoder: prelude, typed headers and both CRC32s.
*******************************************************************************/
final class BedrockEventStream
{
/*******************************************************************************
** Each chunk carries base64 Anthropic event JSON, not an SSE envelope.
*******************************************************************************/
static byte[] encode(List<String> events) throws IOException
{
ByteArrayOutputStream stream = new ByteArrayOutputStream();
for(String event : events)
{
byte[] payload = CloudProviderTestServer.JSON.writeValueAsBytes(Map.of("bytes", Base64.getEncoder().encodeToString(event.getBytes(StandardCharsets.UTF_8))));
ByteArrayOutputStream headers = new ByteArrayOutputStream();
DataOutputStream headerData = new DataOutputStream(headers);
header(headerData, ":message-type", "event");
header(headerData, ":event-type", "chunk");
header(headerData, ":content-type", "application/json");
ByteArrayOutputStream frame = new ByteArrayOutputStream();
DataOutputStream data = new DataOutputStream(frame);
data.writeInt(16 + headers.size() + payload.length);
data.writeInt(headers.size());
data.writeInt(crc(frame.toByteArray()));
data.write(headers.toByteArray());
data.write(payload);
data.writeInt(crc(frame.toByteArray()));
stream.write(frame.toByteArray());
}
return (stream.toByteArray());
}
/*******************************************************************************
** AWS header type 7 is a UTF-8 string with a two-byte length.
*******************************************************************************/
private static void header(DataOutputStream data, String name, String value) throws IOException
{
byte[] nameBytes = name.getBytes(StandardCharsets.UTF_8);
byte[] valueBytes = value.getBytes(StandardCharsets.UTF_8);
data.writeByte(nameBytes.length);
data.write(nameBytes);
data.writeByte(7);
data.writeShort(valueBytes.length);
data.write(valueBytes);
}
/*******************************************************************************
** Network-order CRC32 for the prelude and complete message respectively.
*******************************************************************************/
private static int crc(byte[] bytes)
{
CRC32 crc = new CRC32();
crc.update(bytes);
return ((int) crc.getValue());
}
}
@@ -0,0 +1,87 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.bedrock;
import com.kingsrook.qbits.assistant.AssistantModelRouting;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.testing.AssistantTestFixture;
import com.kingsrook.qbits.assistant.testing.CloudProviderTestServer;
import com.kingsrook.qbits.assistant.testing.GoldenTasks;
import com.kingsrook.qbits.assistant.testing.TurnRunner;
import com.kingsrook.qqq.backend.core.context.QContext;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.assistant.testing.CloudProviderTestServer.JSON;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Golden task through the cloud adapter, turn engine and permissioned UI tools.
*******************************************************************************/
@Tag("golden")
class BedrockGoldenTurnTest
{
/*******************************************************************************
** A real count_records round trip returns the tool result to the model.
*******************************************************************************/
@Test
void goldenToolRoundTrip() throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
String answer = "There are " + AssistantTestFixture.PUBLISHED_POSTS + " published posts. /app/blog_post";
String model = BedrockContractTest.MODEL;
server.enqueue(200, "application/vnd.amazon.eventstream", BedrockEventStream.encode(CloudProviderTestServer.anthropicEvents(model, "", CloudProviderTestServer.countInput())));
server.enqueue(200, "application/vnd.amazon.eventstream", BedrockEventStream.encode(CloudProviderTestServer.anthropicEvents(model, answer, null)));
var provider = BedrockContractTest.provider(server);
var config = new AssistantQBitConfig().withProviderName(provider.getName()).withModelProvider(provider)
.withModels(new AssistantModelRouting().withMainModel(model));
try
{
var instance = AssistantTestFixture.build(config);
var task = GoldenTasks.all().stream().filter(t -> t.id().equals("count-published-posts")).findFirst().orElseThrow();
var outcome = new TurnRunner(instance, config).run(task.userId(), task.prompt());
assertThat(outcome.errorCode()).isNull();
task.check().accept(outcome);
assertThat(outcome.text()).endsWith(answer);
assertThat(outcome.end()).isNotEmpty();
assertThat(server.requests).hasSize(2);
var messages = JSON.readTree(server.requests.get(1).body()).path("messages");
var assistant = messages.get(messages.size() - 2);
var result = messages.get(messages.size() - 1);
assertThat(assistant.path("role").asText()).isEqualTo("assistant");
assertThat(assistant.path("content").toString()).contains("count_records", "count");
assertThat(result.path("role").asText()).isEqualTo("user");
var toolResult = result.path("content").get(0);
assertThat(toolResult.path("type").asText()).isEqualTo("tool_result");
assertThat(toolResult.path("tool_use_id").asText()).isEqualTo("count");
assertThat(toolResult.path("is_error").asBoolean()).isFalse();
assertThat(toolResult.path("content").toString()).contains("count");
}
finally
{
if(config.getRuntime() != null)
{
config.getRuntime().close();
}
provider.close();
QContext.clear();
}
}
}
}
+128
View File
@@ -0,0 +1,128 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2026 Kingsrook, LLC
~
~ 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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-parent</artifactId>
<version>${revision}</version>
</parent>
<artifactId>qbit-assistant-provider-openai</artifactId>
<packaging>jar</packaging>
<name>QBit Assistant - OpenAI-compatible provider</name>
<description>OpenAI-compatible Chat Completions provider using the JDK HTTP client</description>
<url>https://github.com/QRun-IO/qbit-assistant</url>
<dependencies>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-backend-core</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant</artifactId>
<type>test-jar</type>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-middleware-javalin</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!-- live evals call the real API: opt-in only -->
<excludedGroups>${test.excludedGroups}</excludedGroups>
<redirectTestOutputToFile>true</redirectTestOutputToFile>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<executions>
<execution>
<id>prepare-agent</id>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>verify</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
<execution>
<id>check</id>
<goals>
<goal>check</goal>
</goals>
<configuration>
<rules>
<rule>
<element>BUNDLE</element>
<limits>
<limit>
<counter>INSTRUCTION</counter>
<value>COVEREDRATIO</value>
<minimum>0.70</minimum>
</limit>
<limit>
<counter>CLASS</counter>
<value>COVEREDRATIO</value>
<minimum>0.90</minimum>
</limit>
</limits>
</rule>
</rules>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,429 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.http.HttpResponse;
import java.net.http.HttpTimeoutException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.kingsrook.qbits.assistant.provider.AssistantModelProvider;
import com.kingsrook.qbits.assistant.provider.CompletableStreamHandle;
import com.kingsrook.qbits.assistant.provider.ModelCapabilities;
import com.kingsrook.qbits.assistant.provider.ModelEventListener;
import com.kingsrook.qbits.assistant.provider.ModelPart;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ModelResponse;
import com.kingsrook.qbits.assistant.provider.ModelUsage;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.provider.StreamHandle;
/*******************************************************************************
** JDK HTTP Chat Completions adapter. Only visible content is emitted or stored;
** reasoning deltas are ignored. Each call owns its cancellation and read guard.
*******************************************************************************/
public class OpenAiCompatibleModelProvider implements AssistantModelProvider
{
private final OpenAiHttp http;
private final boolean local;
/*******************************************************************************
** Build a client with resolved settings.
*******************************************************************************/
public OpenAiCompatibleModelProvider(ProviderSettings settings)
{
http = new OpenAiHttp(settings);
local = "LOCAL".equals(new OpenAiCompatibleProviderType().getDefaultLocation(http.settings.getKind()));
}
/*******************************************************************************
** Adapter identity.
*******************************************************************************/
@Override
public String getName()
{
return ("openai-compatible");
}
/*******************************************************************************
** Conservative defaults; registry rows can override model-specific facts.
*******************************************************************************/
@Override
public ModelCapabilities getCapabilities(String modelId)
{
return (new ModelCapabilities().withTools(true).withParallelToolCalls(true).withPromptCaching(false).withThinking(false)
.withMaxContextTokens(local ? 32_000 : 128_000).withStreaming(true).withVision(false).withReasoningEffort(false));
}
/*******************************************************************************
** Interrupting the worker aborts the HTTP call, including a blocked body read.
*******************************************************************************/
@Override
public StreamHandle stream(ModelRequest request, ModelEventListener listener)
{
CompletableStreamHandle handle = new CompletableStreamHandle();
AtomicReference<InputStream> input = new AtomicReference<>();
Thread worker = Thread.ofVirtual().unstarted(() -> run(request, listener, handle, input));
handle.setOnCancel(() ->
{
worker.interrupt();
close(input.get());
});
worker.start();
return (handle);
}
/*******************************************************************************
** Guard the entire request and idle reads, including after HTTP headers.
*******************************************************************************/
private void run(ModelRequest request, ModelEventListener listener, CompletableStreamHandle handle, AtomicReference<InputStream> input)
{
Thread worker = Thread.currentThread();
AtomicLong lastRead = new AtomicLong(System.nanoTime());
long started = lastRead.get();
long timeout = TimeUnit.SECONDS.toNanos(http.settings.getRequestTimeoutSeconds());
ScheduledExecutorService guard = Executors.newSingleThreadScheduledExecutor(Thread.ofVirtual().factory());
Accumulator result = new Accumulator(request.getModel(), listener);
handle.setPartialUsage(() -> result.usage);
guard.scheduleAtFixedRate(() ->
{
long now = System.nanoTime();
if(now - lastRead.get() >= timeout || now - started >= timeout)
{
handle.fail(new ModelProviderException(ModelProviderException.Kind.TIMEOUT, null, "The provider did not answer in time.").withPartialUsage(result.usage));
worker.interrupt();
close(input.get());
}
}, 100, 100, TimeUnit.MILLISECONDS);
try
{
ModelCapabilities caps = request.getCapabilities() == null ? getCapabilities(request.getModel()) : request.getCapabilities();
ObjectNode body = OpenAiMapping.request(request, http.settings.getKind(), caps);
boolean strict = false;
for(JsonNode tool : body.path("tools"))
{
strict |= tool.path("function").path("strict").asBoolean();
}
HttpResponse<InputStream> response = http.client.send(http.request(request.getModel(), http.settings.getRequestTimeoutSeconds())
.POST(java.net.http.HttpRequest.BodyPublishers.ofString(body.toString())).build(), HttpResponse.BodyHandlers.ofInputStream());
input.set(response.body());
result.requestId = OpenAiHttp.requestId(response);
if(handle.isCancelled())
{
return;
}
if(response.statusCode() != 200)
{
throw (http.error(response.statusCode(), new String(response.body().readNBytes(64 * 1024), StandardCharsets.UTF_8), result.requestId, strict));
}
if(!Boolean.FALSE.equals(request.getStreaming()) && Boolean.TRUE.equals(caps.getStreaming()))
{
readEvents(response.body(), lastRead, result, strict, handle);
}
else
{
result.accept(OpenAiHttp.JSON.readTree(response.body()), false, http, strict);
}
handle.complete(result.response());
}
catch(ModelProviderException e)
{
handle.fail(e.withPartialUsage(result.usage));
}
catch(HttpTimeoutException e)
{
handle.fail(new ModelProviderException(ModelProviderException.Kind.TIMEOUT, null, "The provider did not answer in time.").withPartialUsage(result.usage));
}
catch(InterruptedException e)
{
Thread.currentThread().interrupt();
if(!handle.isCancelled())
{
handle.fail(new ModelProviderException(ModelProviderException.Kind.NETWORK, null, "The provider request was interrupted."));
}
}
catch(IOException | RuntimeException e)
{
////////////////////////////////////////////////////////////////////////
// a transport error at or past the deadline is the timeout itself //
// (the JDK client or the guard closed the call), whichever saw it //
// first; report it as TIMEOUT so the kind does not depend on a race. //
////////////////////////////////////////////////////////////////////////
long now = System.nanoTime();
long margin = TimeUnit.MILLISECONDS.toNanos(200);
boolean late = now - started >= timeout - margin || now - lastRead.get() >= timeout - margin;
handle.fail((late ? new ModelProviderException(ModelProviderException.Kind.TIMEOUT, null, "The provider did not answer in time.") : OpenAiHttp.transportError(e)).withPartialUsage(result.usage));
}
finally
{
guard.shutdownNow();
close(input.get());
}
}
/*******************************************************************************
** SSE data fields, CRLF, comments, multi-line data and an optional DONE marker.
*******************************************************************************/
private void readEvents(InputStream stream, AtomicLong lastRead, Accumulator result, boolean strict, CompletableStreamHandle handle) throws IOException, ModelProviderException
{
BufferedReader reader = new BufferedReader(new InputStreamReader(stream, StandardCharsets.UTF_8));
StringBuilder data = new StringBuilder();
String line;
while(!handle.isCancelled() && (line = reader.readLine()) != null)
{
lastRead.set(System.nanoTime());
if(line.isEmpty())
{
if(data.length() > 0)
{
if("[DONE]".equals(data.toString().trim()))
{
return;
}
result.accept(OpenAiHttp.JSON.readTree(data.toString()), true, http, strict);
data.setLength(0);
}
}
else if(line.startsWith("data:"))
{
if(data.length() > 0)
{
data.append('\n');
}
data.append(line.substring(5).stripLeading());
}
}
if(data.length() > 0 && !"[DONE]".equals(data.toString().trim()))
{
result.accept(OpenAiHttp.JSON.readTree(data.toString()), true, http, strict);
}
}
/*******************************************************************************
** Closing an already cancelled stream is harmless.
*******************************************************************************/
private static void close(InputStream input)
{
if(input != null)
{
try
{
input.close();
}
catch(IOException e)
{
// The aborted HTTP call may already have closed the stream.
}
}
}
/*******************************************************************************
** Tool arguments arrive as JSON fragments, ordered by call index.
*******************************************************************************/
private static class Tool
{
private String id = "";
private String name = "";
private final StringBuilder arguments = new StringBuilder();
private boolean announced;
}
/*******************************************************************************
** Shared mapping for stream chunks and one-shot responses.
*******************************************************************************/
private static class Accumulator
{
private final ModelEventListener listener;
private final StringBuilder text = new StringBuilder();
private final Map<Integer, Tool> tools = new TreeMap<>();
private volatile ModelUsage usage = new ModelUsage();
private String model;
private String requestId;
private String stop = ModelResponse.STOP_END_TURN;
/*******************************************************************************
** One completion.
*******************************************************************************/
Accumulator(String model, ModelEventListener listener)
{
this.model = model;
this.listener = listener;
}
/*******************************************************************************
** Ignore reasoning fields; retain only text, tools and billable usage.
*******************************************************************************/
void accept(JsonNode chunk, boolean streaming, OpenAiHttp http, boolean strict) throws ModelProviderException
{
if(chunk.has("error"))
{
JsonNode error = chunk.path("error");
int status = error.path("status").asInt(error.path("code").asInt(500));
String type = error.path("type").asText();
if(status == 500)
{
status = switch(type)
{
case "invalid_request_error" -> 400;
case "authentication_error" -> 401;
case "rate_limit_error" -> 429;
case "overloaded_error" -> 503;
default -> 500;
};
}
throw (http.error(status, chunk.toString(), requestId, strict));
}
model = chunk.path("model").asText(model);
if(chunk.hasNonNull("usage"))
{
JsonNode used = chunk.get("usage");
long cached = used.path("prompt_tokens_details").path("cached_tokens").asLong();
usage = new ModelUsage().withInputTokens(Math.max(0, used.path("prompt_tokens").asLong() - cached))
.withOutputTokens(used.path("completion_tokens").asLong()).withCacheReadTokens(cached);
}
for(JsonNode choice : chunk.path("choices"))
{
if(choice.path("index").asInt() != 0)
{
continue;
}
JsonNode delta = choice.path(streaming ? "delta" : "message");
String content = delta.path("content").asText("");
if(!content.isEmpty())
{
text.append(content);
listener.onTextDelta(content);
}
int position = 0;
for(JsonNode call : delta.path("tool_calls"))
{
Tool tool = tools.computeIfAbsent(call.path("index").asInt(position++), k -> new Tool());
if(tool.id.isEmpty())
{
tool.id = call.path("id").asText("");
}
if(tool.name.isEmpty())
{
tool.name = call.path("function").path("name").asText("");
}
tool.arguments.append(call.path("function").path("arguments").asText(""));
if(!tool.announced && !tool.id.isEmpty() && !tool.name.isEmpty())
{
listener.onToolUseStart(tool.id, tool.name);
tool.announced = true;
}
}
if(choice.hasNonNull("finish_reason"))
{
stop = switch(choice.get("finish_reason").asText())
{
case "tool_calls", "function_call" -> ModelResponse.STOP_TOOL_USE;
case "length" -> ModelResponse.STOP_MAX_TOKENS;
case "content_filter" -> ModelResponse.STOP_REFUSAL;
default -> ModelResponse.STOP_END_TURN;
};
}
}
}
/*******************************************************************************
** Parse complete argument objects only, preserving parallel call order.
*******************************************************************************/
ModelResponse response()
{
List<ModelPart> parts = new ArrayList<>();
if(!text.isEmpty())
{
parts.add(ModelPart.text(text.toString()));
}
for(Map.Entry<Integer, Tool> entry : tools.entrySet())
{
Tool tool = entry.getValue();
if(tool.id.isEmpty())
{
tool.id = "call_" + entry.getKey();
}
if(!tool.announced)
{
listener.onToolUseStart(tool.id, tool.name);
tool.announced = true;
}
Map<String, Object> arguments;
try
{
arguments = tool.arguments.isEmpty() ? Map.of() : OpenAiHttp.JSON.readerFor(new TypeReference<Map<String, Object>>() {})
.with(com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_TRAILING_TOKENS).readValue(tool.arguments.toString());
if(arguments == null)
{
throw (new IOException("Tool arguments must be an object."));
}
}
catch(IOException e)
{
arguments = Map.of("_invalid_arguments", tool.arguments.substring(0, Math.min(200, tool.arguments.length())));
}
parts.add(ModelPart.toolUse(tool.id, tool.name, arguments));
}
if(!tools.isEmpty() && ModelResponse.STOP_END_TURN.equals(stop))
{
stop = ModelResponse.STOP_TOOL_USE;
}
return (new ModelResponse().withModel(model).withRequestId(requestId).withParts(parts).withUsage(usage).withStopReason(stop));
}
}
}
@@ -0,0 +1,199 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.util.List;
import com.kingsrook.qbits.assistant.provider.AssistantModelProvider;
import com.kingsrook.qbits.assistant.provider.AssistantProviderType;
import com.kingsrook.qbits.assistant.provider.DiscoveredModel;
import com.kingsrook.qbits.assistant.provider.HealthResult;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
/*******************************************************************************
** One installed adapter for the Chat Completions dialects.
*******************************************************************************/
public class OpenAiCompatibleProviderType implements AssistantProviderType
{
/*******************************************************************************
** Installed adapter id.
*******************************************************************************/
@Override
public String getType()
{
return ("openai-compatible");
}
/*******************************************************************************
** Settings label.
*******************************************************************************/
@Override
public String getLabel()
{
return ("OpenAI-compatible");
}
/*******************************************************************************
** Discover endpoint-specific models instead of guessing ids.
*******************************************************************************/
@Override
public List<String> getModels()
{
return (List.of());
}
/*******************************************************************************
** Extensible kind list.
*******************************************************************************/
@Override
public List<String> getKinds()
{
return (List.of("OPENAI", "AZURE_OPENAI", "OPENROUTER", "OLLAMA", "LM_STUDIO", "VLLM", "LLAMA_CPP", "OPENAI_COMPATIBLE"));
}
/*******************************************************************************
** The legacy factory uses the generic dialect.
*******************************************************************************/
@Override
public String getDefaultApiKeyEnvName()
{
return (null);
}
/*******************************************************************************
** The generic dialect requires an explicit URL.
*******************************************************************************/
@Override
public String getDefaultBaseUrl()
{
return (null);
}
/*******************************************************************************
** Built-in endpoints. Redirects are never followed.
*******************************************************************************/
@Override
public String getDefaultBaseUrl(String kind)
{
return (switch(kind)
{
case "OPENAI" -> "https://api.openai.com/v1";
case "OPENROUTER" -> "https://openrouter.ai/api/v1";
case "OLLAMA" -> "http://localhost:11434/v1";
case "LM_STUDIO" -> "http://localhost:1234/v1";
case "VLLM" -> "http://localhost:8000/v1";
case "LLAMA_CPP" -> "http://localhost:8080/v1";
default -> null;
});
}
/*******************************************************************************
** Default key references, never key values.
*******************************************************************************/
@Override
public String getDefaultApiKeyEnvName(String kind)
{
return (switch(kind)
{
case "OPENAI" -> "OPENAI_API_KEY";
case "AZURE_OPENAI" -> "AZURE_OPENAI_API_KEY";
case "OPENROUTER" -> "OPENROUTER_API_KEY";
default -> null;
});
}
/*******************************************************************************
** Location is an admin-editable fact, with a kind-based default.
*******************************************************************************/
@Override
public String getDefaultLocation(String kind)
{
return (List.of("OLLAMA", "LM_STUDIO", "VLLM", "LLAMA_CPP").contains(kind) ? "LOCAL" : "CLOUD");
}
/*******************************************************************************
** Backward-compatible factory.
*******************************************************************************/
@Override
public AssistantModelProvider create(String apiKey, String baseUrl)
{
return (create(new ProviderSettings().withKind("OPENAI_COMPATIBLE").withApiKey(apiKey).withBaseUrl(baseUrl)));
}
/*******************************************************************************
** Full connection settings.
*******************************************************************************/
@Override
public AssistantModelProvider create(ProviderSettings settings)
{
return (new OpenAiCompatibleModelProvider(settings));
}
/*******************************************************************************
** Only a models request, never a completion.
*******************************************************************************/
@Override
public List<DiscoveredModel> discoverModels(ProviderSettings settings) throws ModelProviderException
{
return (new OpenAiHttp(settings).models(settings.getRequestTimeoutSeconds()));
}
/*******************************************************************************
** A short models probe with latency and count.
*******************************************************************************/
@Override
public HealthResult checkHealth(ProviderSettings settings)
{
long start = System.nanoTime();
try
{
List<DiscoveredModel> models = new OpenAiHttp(settings).models(Math.min(10, settings.getRequestTimeoutSeconds()));
return (new HealthResult(true, (System.nanoTime() - start) / 1_000_000, models.size() + " models available"));
}
catch(ModelProviderException e)
{
return (new HealthResult(false, (System.nanoTime() - start) / 1_000_000,
e.getKind() + (e.getHttpStatus() == null ? "" : " HTTP " + e.getHttpStatus()) + ": " + e.getMessage()));
}
}
}
@@ -0,0 +1,287 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpTimeoutException;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import javax.net.ssl.SSLHandshakeException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.kingsrook.qbits.assistant.provider.DiscoveredModel;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
/*******************************************************************************
** Shared HTTP/authentication/error mapping. ProviderService guards URLs before
** constructing this transport; redirects must not move keys to another host.
*******************************************************************************/
final class OpenAiHttp
{
static final ObjectMapper JSON = new ObjectMapper();
final HttpClient client;
final ProviderSettings settings;
private final String base;
/*******************************************************************************
** Copy settings so callers cannot mutate a cached client's credentials.
*******************************************************************************/
OpenAiHttp(ProviderSettings source)
{
settings = new ProviderSettings().withKind(source.getKind() == null ? "OPENAI_COMPATIBLE" : source.getKind())
.withTlsCaBundle(source.getTlsCaBundle()).withSslContext(source.getSslContext())
.withApiKey(source.getApiKey()).withBaseUrl(source.getBaseUrl()).withApiVersion(source.getApiVersion()).withRegion(source.getRegion())
.withBearerTokenSupplier(source.getBearerTokenSupplier()).withCloudProject(source.getCloudProject())
.withConnectTimeoutSeconds(source.getConnectTimeoutSeconds()).withRequestTimeoutSeconds(source.getRequestTimeoutSeconds());
String url = settings.getBaseUrl() == null ? new OpenAiCompatibleProviderType().getDefaultBaseUrl(settings.getKind()) : settings.getBaseUrl();
if(url == null)
{
throw (new IllegalArgumentException("A base URL is required for this provider kind."));
}
base = url.replaceAll("/+$", "");
HttpClient.Builder builder = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(settings.getConnectTimeoutSeconds())).followRedirects(HttpClient.Redirect.NEVER);
if(settings.getSslContext() != null)
{
builder.sslContext(settings.getSslContext());
}
client = builder.build();
}
/*******************************************************************************
** Azure uses deployment paths and a version query parameter.
*******************************************************************************/
HttpRequest.Builder request(String model, Integer seconds) throws ModelProviderException
{
try
{
String path = model == null ? "/models" : "/chat/completions";
if("AZURE_OPENAI".equals(settings.getKind()))
{
path = model == null ? "/openai/models" : "/openai/deployments/" + encode(model) + "/chat/completions";
path += "?api-version=" + encode(settings.getApiVersion() == null || settings.getApiVersion().isBlank() ? "2024-10-21" : settings.getApiVersion());
}
HttpRequest.Builder builder = HttpRequest.newBuilder(URI.create(base + path)).timeout(Duration.ofSeconds(seconds)).header("Content-Type", "application/json");
if(settings.getBearerTokenSupplier() != null)
{
String token = settings.getBearerTokenSupplier().get();
if(token == null || token.isBlank())
{
throw (new ModelProviderException(ModelProviderException.Kind.AUTHENTICATION, null, "The provider access token is unavailable."));
}
builder.header("Authorization", "Bearer " + token);
}
else if(settings.getApiKey() != null && !settings.getApiKey().isBlank())
{
if("AZURE_OPENAI".equals(settings.getKind()))
{
builder.header("api-key", settings.getApiKey());
}
else
{
builder.header("Authorization", "Bearer " + settings.getApiKey());
}
}
return (builder);
}
catch(IllegalArgumentException e)
{
throw (new ModelProviderException(ModelProviderException.Kind.INVALID_REQUEST, null, "The provider connection settings are invalid."));
}
catch(RuntimeException e)
{
throw (new ModelProviderException(ModelProviderException.Kind.AUTHENTICATION, null, "Could not obtain the provider access token."));
}
}
/*******************************************************************************
** Models with optional server-specific context information.
*******************************************************************************/
List<DiscoveredModel> models(Integer seconds) throws ModelProviderException
{
CompletableFuture<HttpResponse<String>> pending = client.sendAsync(request(null, seconds).GET().build(), HttpResponse.BodyHandlers.ofString());
try
{
HttpResponse<String> response = pending.get(seconds, TimeUnit.SECONDS);
if(response.statusCode() != 200)
{
throw (error(response.statusCode(), response.body(), requestId(response), false));
}
JsonNode body = JSON.readTree(response.body());
if(body.has("error"))
{
throw (error(500, response.body(), requestId(response), false));
}
List<DiscoveredModel> result = new ArrayList<>();
for(JsonNode model : body.path("data"))
{
String id = model.path("id").asText();
if(id.isBlank())
{
continue;
}
int context = model.path("context_length").asInt(model.path("max_model_len").asInt(model.path("meta").path("n_ctx_train").asInt()));
result.add(new DiscoveredModel(id, model.path("name").asText(id), context > 0 ? context : null, model.path("owned_by").asText(null)));
}
return (result);
}
catch(TimeoutException e)
{
throw (new ModelProviderException(ModelProviderException.Kind.TIMEOUT, null, "The provider did not answer in time."));
}
catch(ExecutionException e)
{
throw (transportError(e));
}
catch(InterruptedException e)
{
Thread.currentThread().interrupt();
throw (new ModelProviderException(ModelProviderException.Kind.NETWORK, null, "The provider request was interrupted."));
}
catch(IOException e)
{
throw (transportError(e));
}
finally
{
pending.cancel(true);
client.close();
}
}
/*******************************************************************************
** Sanitize errors, explicitly removing even short or unusual API keys.
*******************************************************************************/
ModelProviderException error(int status, String body, String requestId, boolean strict)
{
String message = "The provider refused the request.";
String type = "openai-compatible";
try
{
JsonNode error = JSON.readTree(body).path("error");
message = error.path("message").asText(message);
type = error.path("type").asText(type);
}
catch(Exception e)
{
// Do not expose unstructured proxy pages or request bodies.
}
message = safe(message);
type = safe(type);
ModelProviderException.Kind kind = errorKind(status);
String lower = message == null ? "" : message.toLowerCase(Locale.ROOT);
return (new ModelProviderException(kind, status, message).withProviderDetails(type, message, safe(requestId))
.withStrictSchemaRejected(strict && status == 400 && (lower.contains("strict") || lower.contains("schema") || lower.contains("grammar"))));
}
/*******************************************************************************
** Credential-free diagnostics.
*******************************************************************************/
private String safe(String value)
{
if(settings.getBearerTokenSupplier() != null)
{
// Dynamic credentials can be echoed by a remote error. Do not retain
// tokens or include remote diagnostics for bearer-supplier requests.
return (null);
}
String key = settings.getApiKey();
return (ModelProviderException.sanitizeProviderMessage(value == null || key == null || key.isEmpty() ? value : value.replace(key, "[redacted]"), 300));
}
/*******************************************************************************
** Common request-id headers.
*******************************************************************************/
static String requestId(HttpResponse<?> response)
{
return (response.headers().firstValue("x-request-id").orElse(response.headers().firstValue("apim-request-id").orElse(null)));
}
/*******************************************************************************
** Encode a single path segment or query value.
*******************************************************************************/
private static String encode(String value)
{
return (URLEncoder.encode(value, StandardCharsets.UTF_8).replace("+", "%20"));
}
/*******************************************************************************
** Map the provider error category.
*******************************************************************************/
private static ModelProviderException.Kind errorKind(int status)
{
return (switch(status)
{
case 401, 403 -> ModelProviderException.Kind.AUTHENTICATION;
case 429 -> ModelProviderException.Kind.RATE_LIMITED;
case 503, 529 -> ModelProviderException.Kind.OVERLOADED;
case 400, 404, 422 -> ModelProviderException.Kind.INVALID_REQUEST;
default -> status >= 500 ? ModelProviderException.Kind.SERVER : ModelProviderException.Kind.INVALID_REQUEST;
});
}
/*******************************************************************************
** Fixed diagnostics omit remote certificate details, URLs and credentials.
*******************************************************************************/
static ModelProviderException transportError(Throwable error)
{
for(Throwable cause = error; cause != null; cause = cause.getCause())
{
if(cause instanceof SSLHandshakeException)
{
return (new ModelProviderException(ModelProviderException.Kind.NETWORK, null,
"The provider TLS certificate is not trusted or does not match the host. Check tlsCaBundle and the HTTPS hostname."));
}
if(cause instanceof HttpTimeoutException)
{
return (new ModelProviderException(ModelProviderException.Kind.TIMEOUT, null, "The provider did not answer in time."));
}
}
return (new ModelProviderException(ModelProviderException.Kind.NETWORK, null, "Could not read the provider response."));
}
}
@@ -0,0 +1,191 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.util.List;
import java.util.Locale;
import java.util.stream.Collectors;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.kingsrook.qbits.assistant.provider.ModelCapabilities;
import com.kingsrook.qbits.assistant.provider.ModelMessage;
import com.kingsrook.qbits.assistant.provider.ModelPart;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ModelToolDefinition;
import com.kingsrook.qbits.assistant.provider.SystemBlock;
/*******************************************************************************
** Chat Completions request mapping and conservative strict-schema checks.
*******************************************************************************/
final class OpenAiMapping
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private OpenAiMapping()
{
}
/*******************************************************************************
** Map only capabilities the target dialect supports.
*******************************************************************************/
static ObjectNode request(ModelRequest request, String kind, ModelCapabilities capabilities) throws JsonProcessingException
{
ObjectNode body = OpenAiHttp.JSON.createObjectNode();
boolean streaming = !Boolean.FALSE.equals(request.getStreaming()) && Boolean.TRUE.equals(capabilities.getStreaming());
boolean nativeOpenAi = List.of("OPENAI", "AZURE_OPENAI").contains(kind);
String model = request.getModel();
body.put("model", "VERTEX".equals(kind) && model != null && !model.contains("/") ? "google/" + model : model);
body.put("stream", streaming);
if(streaming)
{
body.putObject("stream_options").put("include_usage", true);
}
if(request.getMaxTokens() != null)
{
body.put(nativeOpenAi ? "max_completion_tokens" : "max_tokens", request.getMaxTokens());
}
if(Boolean.TRUE.equals(capabilities.getReasoningEffort()) && request.getEffort() != null)
{
String effort = request.getEffort().toLowerCase(Locale.ROOT);
body.put("reasoning_effort", List.of("low", "medium").contains(effort) ? effort : "high");
}
ArrayNode messages = body.putArray("messages");
if(!request.getSystem().isEmpty())
{
messages.addObject().put("role", "system").put("content", request.getSystem().stream().map(SystemBlock::getText).collect(Collectors.joining("\n\n")));
}
for(ModelMessage message : request.getMessages())
{
ObjectNode current = null;
for(ModelPart part : message.getParts())
{
if(part.getType() == ModelPart.Type.TOOL_RESULT)
{
current = null;
messages.addObject().put("role", "tool").put("tool_call_id", part.getToolUseId())
.put("content", (Boolean.TRUE.equals(part.getIsError()) ? "ERROR: " : "") + part.getText());
continue;
}
if(current == null)
{
current = messages.addObject().put("role", message.getRole() == ModelMessage.Role.ASSISTANT ? "assistant" : "user");
current.put("content", "");
}
if(part.getType() == ModelPart.Type.TEXT)
{
current.put("content", current.path("content").asText() + part.getText());
}
else if(part.getType() == ModelPart.Type.TOOL_USE)
{
ArrayNode calls = current.has("tool_calls") ? (ArrayNode) current.get("tool_calls") : current.putArray("tool_calls");
calls.addObject().put("id", part.getToolUseId()).put("type", "function").putObject("function")
.put("name", part.getToolName()).put("arguments", OpenAiHttp.JSON.writeValueAsString(part.getInput()));
}
}
}
if(!request.getTools().isEmpty() && Boolean.TRUE.equals(capabilities.getTools()))
{
ArrayNode tools = body.putArray("tools");
for(ModelToolDefinition tool : request.getTools())
{
JsonNode schema = OpenAiHttp.JSON.valueToTree(tool.getInputSchema());
ObjectNode function = tools.addObject().put("type", "function").putObject("function").put("name", tool.getName()).put("description", tool.getDescription());
function.set("parameters", schema);
if(nativeOpenAi && Boolean.TRUE.equals(tool.getStrict()) && strictCompatible(schema))
{
function.put("strict", true);
}
}
if(List.of("OPENAI", "AZURE_OPENAI", "OPENROUTER", "VLLM").contains(kind))
{
body.put("parallel_tool_calls", Boolean.TRUE.equals(request.getParallelToolCalls()) && Boolean.TRUE.equals(capabilities.getParallelToolCalls()));
}
}
return (body);
}
/*******************************************************************************
** Every object must forbid extras and require every declared property.
*******************************************************************************/
static boolean strictCompatible(JsonNode schema)
{
if(schema == null || !schema.isObject())
{
return (false);
}
JsonNode type = schema.path("type");
if("object".equals(type.asText()) || schema.has("properties") || (type.isArray() && type.toString().contains("\"object\"")))
{
if(!schema.has("additionalProperties") || !schema.get("additionalProperties").isBoolean() || schema.get("additionalProperties").asBoolean())
{
return (false);
}
JsonNode required = schema.path("required");
var names = schema.path("properties").fieldNames();
while(names.hasNext())
{
String name = names.next();
boolean found = false;
for(JsonNode value : required)
{
found |= name.equals(value.asText());
}
if(!found || !strictCompatible(schema.path("properties").get(name)))
{
return (false);
}
}
}
for(String keyword : List.of("items", "additionalProperties"))
{
if(schema.path(keyword).isObject() && !strictCompatible(schema.get(keyword)))
{
return (false);
}
}
for(String keyword : List.of("anyOf", "oneOf", "allOf", "prefixItems"))
{
for(JsonNode child : schema.path(keyword))
{
if(!strictCompatible(child))
{
return (false);
}
}
}
for(String keyword : List.of("$defs", "definitions"))
{
for(JsonNode child : schema.path(keyword))
{
if(!strictCompatible(child))
{
return (false);
}
}
}
return (true);
}
}
@@ -0,0 +1,77 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.nio.file.Path;
import java.time.Duration;
import java.util.List;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.provider.ModelMessage;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Opt-in smoke test; never contacts an endpoint in the default build.
*******************************************************************************/
@Tag("live")
class LiveOpenAiCompatibleTest
{
/*******************************************************************************
** All connection details come from environment references.
*******************************************************************************/
@Test
void live() throws Exception
{
String url = System.getenv("ASSISTANT_LIVE_OPENAI_BASE_URL");
String model = System.getenv("ASSISTANT_LIVE_OPENAI_MODEL");
Assumptions.assumeTrue(url != null && !url.isBlank() && model != null && !model.isBlank(), "Live URL and model must be set");
String kind = System.getenv("ASSISTANT_LIVE_OPENAI_KIND");
String keyEnv = System.getenv("ASSISTANT_LIVE_OPENAI_KEY_ENV");
ProviderSettings settings = new ProviderSettings().withKind(kind == null || kind.isBlank() ? "OLLAMA" : kind)
.withBaseUrl(url).withApiKey(keyEnv == null || keyEnv.isBlank() ? null : System.getenv(keyEnv));
String caFile = System.getenv("ASSISTANT_LIVE_OPENAI_CA_FILE");
if(caFile != null && !caFile.isBlank())
{
settings.withTlsCaBundle("live").withSslContext(new AssistantQBitConfig().withTrustedCaBundleFile("live", Path.of(caFile)).getTrustedCaBundles().get("live"));
}
try
{
OpenAiCompatibleProviderType type = new OpenAiCompatibleProviderType();
Assumptions.assumeTrue(Boolean.TRUE.equals(type.checkHealth(settings).healthy()), "Live health probe must pass");
assertThat(type.discoverModels(settings)).isNotEmpty();
var provider = type.create(settings);
StringBuilder text = new StringBuilder();
provider.stream(new ModelRequest().withModel(model).withMaxTokens(128).withMessages(List.of(ModelMessage.user("Reply with OK."))), text::append).await(Duration.ofSeconds(120));
assertThat(text).isNotEmpty();
var response = provider.stream(new ModelRequest().withModel(model).withMaxTokens(256).withTools(List.of(OpenAiContractTest.tool()))
.withMessages(List.of(ModelMessage.user("Call lookup with q set to hello. Do not answer without calling the tool."))), t -> {}).await(Duration.ofSeconds(120));
assertThat(response.getToolUses()).anyMatch(t -> "lookup".equals(t.getToolName()));
}
catch(ModelProviderException e)
{
Assumptions.assumeFalse(e.getKind() == ModelProviderException.Kind.NETWORK || e.getKind() == ModelProviderException.Kind.TIMEOUT, "Live endpoint unreachable (including TLS)");
throw (e);
}
}
}
@@ -0,0 +1,183 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.LinkedBlockingQueue;
import javax.net.ssl.SSLContext;
import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpServer;
import com.sun.net.httpserver.HttpsConfigurator;
import com.sun.net.httpserver.HttpsServer;
/*******************************************************************************
** Loopback-only scripted Chat Completions server with captured requests.
*******************************************************************************/
class MockOpenAiServer implements AutoCloseable
{
final List<Captured> requests = new CopyOnWriteArrayList<>();
private final LinkedBlockingQueue<Script> scripts = new LinkedBlockingQueue<>();
private final HttpServer server;
private final ExecutorService executor = Executors.newVirtualThreadPerTaskExecutor();
/*******************************************************************************
** Captured wire data, only synthetic keys in default tests.
*******************************************************************************/
record Captured(String path, String authorization, String apiKey, String body)
{
}
/*******************************************************************************
** Delay can be before headers or after an SSE keep-alive.
*******************************************************************************/
record Script(int status, String body, long delayMs, boolean afterHeaders, CountDownLatch started)
{
}
/*******************************************************************************
** Bind only the loopback interface.
*******************************************************************************/
MockOpenAiServer() throws IOException
{
this(null);
}
/*******************************************************************************
** Optional TLS uses exactly the same scripted endpoints and request capture.
*******************************************************************************/
MockOpenAiServer(SSLContext tls) throws IOException
{
if(tls == null)
{
server = HttpServer.create(new InetSocketAddress("127.0.0.1", 0), 0);
}
else
{
HttpsServer https = HttpsServer.create(new InetSocketAddress("127.0.0.1", 0), 0);
https.setHttpsConfigurator(new HttpsConfigurator(tls));
server = https;
}
server.createContext("/", this::serve);
server.setExecutor(executor);
server.start();
}
/*******************************************************************************
** Base URL deliberately has the v1 prefix.
*******************************************************************************/
String url()
{
return ((server instanceof HttpsServer ? "https://localhost:" : "http://127.0.0.1:") + server.getAddress().getPort() + "/v1");
}
/*******************************************************************************
** Queue a reply.
*******************************************************************************/
void enqueue(int status, String body)
{
scripts.add(new Script(status, body, 0, false, new CountDownLatch(1)));
}
/*******************************************************************************
** Queue a stalled response.
*******************************************************************************/
CountDownLatch stall(boolean afterHeaders)
{
CountDownLatch started = new CountDownLatch(1);
scripts.add(new Script(200, "data: [DONE]\n\n", 2500, afterHeaders, started));
return (started);
}
/*******************************************************************************
** Capture and reply, tolerating client cancellation.
*******************************************************************************/
private void serve(HttpExchange exchange) throws IOException
{
try(exchange)
{
requests.add(new Captured(exchange.getRequestURI().toString(), exchange.getRequestHeaders().getFirst("Authorization"),
exchange.getRequestHeaders().getFirst("api-key"), new String(exchange.getRequestBody().readAllBytes(), StandardCharsets.UTF_8)));
Script script = scripts.poll();
if(script == null)
{
exchange.sendResponseHeaders(500, -1);
return;
}
if(!script.afterHeaders())
{
script.started().countDown();
Thread.sleep(script.delayMs());
}
exchange.getResponseHeaders().set("Content-Type", script.body().startsWith("{") ? "application/json" : "text/event-stream");
exchange.getResponseHeaders().set("x-request-id", "mock-request");
exchange.sendResponseHeaders(script.status(), 0);
if(script.afterHeaders())
{
exchange.getResponseBody().write(": keep-alive\r\n\r\n".getBytes(StandardCharsets.UTF_8));
exchange.getResponseBody().flush();
script.started().countDown();
Thread.sleep(script.delayMs());
}
exchange.getResponseBody().write(script.body().getBytes(StandardCharsets.UTF_8));
}
catch(InterruptedException e)
{
Thread.currentThread().interrupt();
}
catch(IOException e)
{
// Cancellation closes the client socket while a script is writing.
}
}
/*******************************************************************************
** Stop all handlers.
*******************************************************************************/
@Override
public void close()
{
server.stop(0);
executor.shutdownNow();
}
}
@@ -0,0 +1,548 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.assistant.provider.ModelCapabilities;
import com.kingsrook.qbits.assistant.provider.ModelEventListener;
import com.kingsrook.qbits.assistant.provider.ModelMessage;
import com.kingsrook.qbits.assistant.provider.ModelPart;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ModelResponse;
import com.kingsrook.qbits.assistant.provider.ModelToolDefinition;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.provider.SystemBlock;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import org.junit.jupiter.params.provider.ValueSource;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Contract tests exercise the wire protocol through localhost HTTP only.
*******************************************************************************/
class OpenAiContractTest
{
/*******************************************************************************
** Classifiers opt out of streaming even when the model supports it.
*******************************************************************************/
@Test
void nonStreamingClassifier() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
server.enqueue(200, "{\"model\":\"test\",\"choices\":[{\"message\":{\"content\":\"SIMPLE\"},\"finish_reason\":\"stop\"}],\"usage\":{\"prompt_tokens\":18,\"completion_tokens\":1}}");
var provider = new OpenAiCompatibleModelProvider(settings(server, "OPENAI"));
ModelResponse response = provider.stream(request().withStreaming(false).withMaxTokens(4), new StringBuilder()::append).await(Duration.ofSeconds(3));
assertThat(response.getText()).isEqualTo("SIMPLE");
JsonNode body = OpenAiHttp.JSON.readTree(server.requests.getFirst().body());
assertThat(body.path("stream").asBoolean()).isFalse();
assertThat(body.path("max_completion_tokens").asInt()).isEqualTo(4);
assertThat(body.has("stream_options")).isFalse();
}
}
static final String TEXT = "data: {\"model\":\"test\",\"choices\":[{\"delta\":{\"content\":\"OK\"},\"finish_reason\":\"stop\"}]}\r\n\r\ndata: [DONE]\r\n\r\n";
/*******************************************************************************
** A minimal request, also shared by the opt-in live test.
*******************************************************************************/
static ModelRequest request()
{
return (new ModelRequest().withModel("test").withMaxTokens(32).withEffort("max").withMessages(List.of(ModelMessage.user("Hello"))));
}
/*******************************************************************************
** Synthetic settings for the local server.
*******************************************************************************/
static ProviderSettings settings(MockOpenAiServer server, String kind)
{
return (new ProviderSettings().withKind(kind).withBaseUrl(server.url()).withApiKey("synthetic-key"));
}
/*******************************************************************************
** Strict-compatible schema with one required property.
*******************************************************************************/
static ModelToolDefinition tool()
{
return (new ModelToolDefinition().withName("lookup").withDescription("Look up a value").withStrict(true)
.withInputSchema(Map.of("type", "object", "additionalProperties", false, "properties", Map.of("q", Map.of("type", "string")), "required", List.of("q"))));
}
/*******************************************************************************
** Kind-specific parameters, ordered tool results, auth and strict behavior.
*******************************************************************************/
@ParameterizedTest
@ValueSource(strings = { "OPENAI", "AZURE_OPENAI", "OPENROUTER", "OLLAMA", "LM_STUDIO", "VLLM", "LLAMA_CPP", "OPENAI_COMPATIBLE" })
void requestContract(String kind) throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
server.enqueue(200, TEXT);
boolean nativeKind = kind.equals("OPENAI") || kind.equals("AZURE_OPENAI");
ModelRequest request = request().withCapabilities(new ModelCapabilities().withReasoningEffort(true)).withTools(List.of(tool()))
.withSystem(List.of(new SystemBlock().withText("one"), new SystemBlock().withText("two")))
.withMessages(List.of(ModelMessage.user("hi"), new ModelMessage().withRole(ModelMessage.Role.ASSISTANT)
.withPart(ModelPart.toolUse("a", "lookup", Map.of("q", "a"))).withPart(ModelPart.toolUse("b", "lookup", Map.of("q", "b"))),
new ModelMessage().withRole(ModelMessage.Role.USER).withPart(ModelPart.toolResult("a", "first", false)).withPart(ModelPart.toolResult("b", "second", true))));
var provider = new OpenAiCompatibleModelProvider(settings(server, kind));
StringBuilder text = new StringBuilder();
assertThat(provider.stream(request, text::append).await(Duration.ofSeconds(5)).getText()).isEqualTo("OK");
assertThat(text.toString()).isEqualTo("OK");
var captured = server.requests.getFirst();
JsonNode body = OpenAiHttp.JSON.readTree(captured.body());
assertThat(body.path("messages").get(0).path("content").asText()).isEqualTo("one\n\ntwo");
assertThat(body.path("messages").get(2).path("tool_calls").get(0).path("function").path("arguments").asText()).isEqualTo("{\"q\":\"a\"}");
assertThat(body.path("messages").get(3).path("tool_call_id").asText()).isEqualTo("a");
assertThat(body.path("messages").get(4).path("content").asText()).isEqualTo("ERROR: second");
assertThat(body.path("tools").get(0).path("function").has("strict")).isEqualTo(nativeKind);
assertThat(body.has("max_completion_tokens")).isEqualTo(nativeKind);
assertThat(body.has("max_tokens")).isEqualTo(!nativeKind);
assertThat(body.path("reasoning_effort").asText()).isEqualTo("high");
assertThat(body.has("tool_choice")).isFalse();
assertThat(body.has("parallel_tool_calls")).isEqualTo(List.of("OPENAI", "AZURE_OPENAI", "OPENROUTER", "VLLM").contains(kind));
assertThat(provider.countTokens(request)).isNull();
if(kind.equals("AZURE_OPENAI"))
{
assertThat(captured.path()).isEqualTo("/v1/openai/deployments/test/chat/completions?api-version=2024-10-21");
assertThat(captured.apiKey()).isEqualTo("synthetic-key");
assertThat(captured.authorization()).isNull();
}
else
{
assertThat(captured.authorization()).isEqualTo("Bearer synthetic-key");
}
}
}
/*******************************************************************************
** Fragmented parallel tools, comments, cache usage and ignored reasoning.
*******************************************************************************/
@Test
void streamedToolsAndUsage() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
StringBuilder script = new StringBuilder(": comment\r\n\r\n");
script.append(event(Map.of("choices", List.of(Map.of("delta", Map.of("reasoning_content", "never expose", "tool_calls", List.of(
Map.of("index", 1, "id", "b", "function", Map.of("name", "lookup", "arguments", "")),
Map.of("index", 0, "id", "a", "function", Map.of("name", "lookup", "arguments", "")))))))));
for(char c : "{\"q\":\"value\"}".toCharArray())
{
script.append(event(Map.of("choices", List.of(Map.of("delta", Map.of("tool_calls", List.of(
Map.of("index", 0, "function", Map.of("arguments", String.valueOf(c))), Map.of("index", 1, "function", Map.of("arguments", String.valueOf(c))))))))));
}
script.append(event(Map.of("choices", List.of(Map.of("delta", Map.of(), "finish_reason", "tool_calls")), "usage",
Map.of("prompt_tokens", 100, "completion_tokens", 8, "prompt_tokens_details", Map.of("cached_tokens", 70)))));
server.enqueue(200, script + "data: [DONE]\n\n");
List<String> starts = new ArrayList<>();
StringBuilder text = new StringBuilder();
ModelResponse response = new OpenAiCompatibleModelProvider(settings(server, "OLLAMA").withApiKey(null)).stream(request(), new ModelEventListener()
{
/*******************************************************************************
** Provider contract.
*******************************************************************************/
@Override
public void onTextDelta(String delta)
{
text.append(delta);
}
/*******************************************************************************
** Provider contract.
*******************************************************************************/
@Override
public void onToolUseStart(String id, String name)
{
starts.add(id);
}
}).await(Duration.ofSeconds(5));
assertThat(response.getToolUses()).extracting(ModelPart::getToolUseId).containsExactly("a", "b");
assertThat(response.getToolUses().getFirst().getInput()).containsEntry("q", "value");
assertThat(starts).containsExactly("b", "a");
assertThat(text).isEmpty();
assertThat(response.getUsage().getInputTokens()).isEqualTo(30L);
assertThat(response.getUsage().getCacheReadTokens()).isEqualTo(70L);
assertThat(response.getUsage().getOutputTokens()).isEqualTo(8L);
assertThat(response.getStopReason()).isEqualTo(ModelResponse.STOP_TOOL_USE);
assertThat(server.requests.getFirst().authorization()).isNull();
}
}
/*******************************************************************************
** Single JSON mode and defaults without optional request fields.
*******************************************************************************/
@Test
void nonStreamingAndNoUsage() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
server.enqueue(200, "{\"choices\":[{\"message\":{\"content\":\"done\"},\"finish_reason\":\"length\"}]}");
var provider = new OpenAiCompatibleModelProvider(settings(server, "OPENAI"));
StringBuilder text = new StringBuilder();
ModelResponse response = provider.stream(request().withCapabilities(new ModelCapabilities().withStreaming(false)), text::append).await(Duration.ofSeconds(5));
assertThat(response.getStopReason()).isEqualTo(ModelResponse.STOP_MAX_TOKENS);
assertThat(text.toString()).isEqualTo("done");
assertThat(response.getUsage().billableTokens()).isZero();
JsonNode body = OpenAiHttp.JSON.readTree(server.requests.getFirst().body());
assertThat(body.path("stream").asBoolean()).isFalse();
assertThat(body.has("stream_options")).isFalse();
assertThat(body.has("reasoning_effort")).isFalse();
assertThat(body.has("parallel_tool_calls")).isFalse();
server.enqueue(200, TEXT);
assertThat(provider.stream(request(), text::append).await(Duration.ofSeconds(5)).getUsage().billableTokens()).isZero();
}
}
/*******************************************************************************
** Every HTTP error category carries safe details.
*******************************************************************************/
@ParameterizedTest
@CsvSource({ "401,AUTHENTICATION", "403,AUTHENTICATION", "429,RATE_LIMITED", "503,OVERLOADED", "529,OVERLOADED", "400,INVALID_REQUEST", "404,INVALID_REQUEST", "422,INVALID_REQUEST", "500,SERVER", "502,SERVER" })
void errors(int status, String kind) throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
server.enqueue(status, "{\"error\":{\"type\":\"bad_request\",\"message\":\"Rejected synthetic-key\"}}");
assertThatThrownBy(() -> new OpenAiCompatibleModelProvider(settings(server, "OPENAI")).stream(request(), t -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, e ->
{
assertThat(e.getKind().name()).isEqualTo(kind);
assertThat(e.getHttpStatus()).isEqualTo(status);
assertThat(e.getRequestId()).isEqualTo("mock-request");
assertThat(e.getMessage()).doesNotContain("synthetic-key");
assertThat(e.getProviderMessage()).contains("[redacted]");
});
}
}
/*******************************************************************************
** Strict rejection is opt-in; incompatible nested object schemas are omitted.
*******************************************************************************/
@Test
void strictAndStreamErrors() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
var provider = new OpenAiCompatibleModelProvider(settings(server, "OPENAI"));
String error = "{\"error\":{\"type\":\"invalid_request_error\",\"message\":\"strict schema grammar refused\"}}";
for(boolean sse : List.of(false, true))
{
server.enqueue(sse ? 200 : 400, sse ? "data: " + error + "\n\n" : error);
assertThatThrownBy(() -> provider.stream(request().withTools(List.of(tool())), t -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, e -> assertThat(e.isStrictSchemaRejected()).isTrue());
}
server.enqueue(200, TEXT);
provider.stream(request().withTools(List.of(tool().withInputSchema(Map.of("type", "object", "properties", Map.of())))), t -> {}).await(Duration.ofSeconds(5));
assertThat(OpenAiHttp.JSON.readTree(server.requests.getLast().body()).path("tools").get(0).path("function").has("strict")).isFalse();
assertThat(OpenAiMapping.strictCompatible(OpenAiHttp.JSON.readTree("{\"type\":\"array\",\"items\":{\"type\":\"object\"}}"))).isFalse();
assertThat(OpenAiMapping.strictCompatible(OpenAiHttp.JSON.readTree("{\"anyOf\":[{\"type\":\"object\"}]}"))).isFalse();
}
}
/*******************************************************************************
** Header timeout, stalled body timeout, cancellation and network failure.
*******************************************************************************/
@Test
void timeoutCancelAndNetwork() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
var provider = new OpenAiCompatibleModelProvider(settings(server, "OLLAMA").withRequestTimeoutSeconds(1));
for(boolean afterHeaders : List.of(false, true))
{
server.stall(afterHeaders);
assertThatThrownBy(() -> provider.stream(request(), t -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, e -> assertThat(e.getKind()).isEqualTo(ModelProviderException.Kind.TIMEOUT));
}
var started = server.stall(true);
var handle = provider.stream(request(), t -> {});
assertThat(started.await(3, java.util.concurrent.TimeUnit.SECONDS)).isTrue();
handle.cancel();
assertThat(handle.await(Duration.ofSeconds(2)).getStopReason()).isEqualTo(ModelResponse.STOP_CANCELLED);
assertThat(handle.isCancelled()).isTrue();
}
String closed;
try(MockOpenAiServer server = new MockOpenAiServer())
{
closed = server.url();
}
var provider = new OpenAiCompatibleModelProvider(new ProviderSettings().withKind("OLLAMA").withBaseUrl(closed));
assertThatThrownBy(() -> provider.stream(request(), t -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, e -> assertThat(e.getKind()).isEqualTo(ModelProviderException.Kind.NETWORK));
}
/*******************************************************************************
** Discovery timeouts include the body, and failed probes never complete.
*******************************************************************************/
@Test
void discoveryTimeoutAndMalformedResponse() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
var type = new OpenAiCompatibleProviderType();
var settings = settings(server, "OLLAMA").withRequestTimeoutSeconds(1);
server.stall(true);
assertThatThrownBy(() -> type.discoverModels(settings)).isInstanceOfSatisfying(ModelProviderException.class,
e -> assertThat(e.getKind()).isEqualTo(ModelProviderException.Kind.TIMEOUT));
server.enqueue(200, "not JSON");
assertThat(type.checkHealth(settings).healthy()).isFalse();
server.enqueue(200, "{\"error\":{\"message\":\"failed\"}}");
assertThat(type.checkHealth(settings).healthy()).isFalse();
}
}
/*******************************************************************************
** JDK header validation must never expose even an invalid credential.
*******************************************************************************/
@Test
void invalidHeaderDoesNotLeakKey() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
var settings = settings(server, "OPENAI").withApiKey("private\ncredential");
assertThatThrownBy(() -> new OpenAiCompatibleProviderType().discoverModels(settings))
.isInstanceOfSatisfying(ModelProviderException.class, e ->
{
assertThat(e.getMessage()).doesNotContain("private", "credential");
assertThat(e.getCause()).isNull();
});
assertThat(new OpenAiCompatibleProviderType().checkHealth(settings).healthy()).isFalse();
assertThat(server.requests).isEmpty();
}
}
/*******************************************************************************
** Non-streaming calls preserve tools and usage, including cached tokens.
*******************************************************************************/
@Test
void nonStreamingTools() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
server.enqueue(200, """
{"choices":[{"message":{"tool_calls":[
{"id":"one","function":{"name":"lookup","arguments":"{\\"q\\":\\"x\\"}"}},
{"id":"two","function":{"name":"lookup","arguments":"{}"}}]},"finish_reason":"tool_calls"}],
"usage":{"prompt_tokens":12,"completion_tokens":4,"prompt_tokens_details":{"cached_tokens":2}}}
""");
var response = new OpenAiCompatibleModelProvider(settings(server, "OPENAI")).stream(
request().withCapabilities(new ModelCapabilities().withStreaming(false)), t -> {}).await(Duration.ofSeconds(5));
assertThat(response.getToolUses()).extracting(ModelPart::getToolUseId).containsExactly("one", "two");
assertThat(response.getToolUses().getFirst().getInput()).containsEntry("q", "x");
assertThat(response.getUsage().getInputTokens()).isEqualTo(10L);
}
}
/*******************************************************************************
** Model discovery context dialects, Azure path and health without completions.
*******************************************************************************/
@ParameterizedTest
@ValueSource(strings = { "OPENAI", "OPENROUTER", "AZURE_OPENAI", "VLLM", "LLAMA_CPP" })
void discoveryAndHealth(String kind) throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
String models = "{\"data\":[{\"id\":\"a\",\"owned_by\":\"owner\",\"context_length\":64000},{\"id\":\"b\",\"max_model_len\":32000},{\"id\":\"c\",\"meta\":{\"n_ctx_train\":16000}}]}";
server.enqueue(200, models);
var type = new OpenAiCompatibleProviderType();
var settings = settings(server, kind).withApiVersion("2024-10-21");
assertThat(type.discoverModels(settings)).extracting(m -> m.contextWindowTokens()).containsExactly(64000, 32000, 16000);
server.enqueue(200, models);
assertThat(type.checkHealth(settings).message()).isEqualTo("3 models available");
server.enqueue(401, "{\"error\":{\"message\":\"bad key\"}}");
assertThat(type.checkHealth(settings).healthy()).isFalse();
assertThat(server.requests).allSatisfy(r -> assertThat(r.path()).isEqualTo(kind.equals("AZURE_OPENAI") ? "/v1/openai/models?api-version=2024-10-21" : "/v1/models"));
assertThat(type.getKinds()).hasSize(8);
assertThat(type.getModels()).isEmpty();
assertThat(type.getDefaultBaseUrl()).isNull();
assertThat(type.getDefaultApiKeyEnvName()).isNull();
assertThat(type.getLabel()).isEqualTo("OpenAI-compatible");
for(String k : type.getKinds())
{
assertThat(type.getDefaultLocation(k)).isIn("LOCAL", "CLOUD");
type.getDefaultBaseUrl(k);
type.getDefaultApiKeyEnvName(k);
}
assertThat(type.create(null, server.url()).getName()).isEqualTo(type.getType());
}
}
/*******************************************************************************
** Serialize a scripted SSE event.
*******************************************************************************/
static String event(Object value) throws Exception
{
return ("data: " + OpenAiHttp.JSON.writeValueAsString(value) + "\n\n");
}
/*******************************************************************************
** Repeated identities, missing ids and older servers' stop reason are tolerated.
*******************************************************************************/
@Test
void repeatedToolIdentityAndMissingId() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
StringBuilder script = new StringBuilder();
for(String fragment : List.of("{", "\"q\":", "\"hello\"}"))
{
script.append(event(Map.of("choices", List.of(Map.of("delta", Map.of("tool_calls", List.of(
Map.of("index", 0, "id", "repeated", "function", Map.of("name", "lookup", "arguments", fragment)),
Map.of("index", 1, "function", Map.of("name", "lookup", "arguments", fragment)))), "finish_reason", "stop")))));
}
server.enqueue(200, script.toString());
ModelResponse response = new OpenAiCompatibleModelProvider(settings(server, "OLLAMA")).stream(request(), t -> {}).await(Duration.ofSeconds(5));
assertThat(response.getStopReason()).isEqualTo(ModelResponse.STOP_TOOL_USE);
assertThat(response.getToolUses()).extracting(ModelPart::getToolUseId).containsExactly("repeated", "call_1");
assertThat(response.getToolUses()).allSatisfy(tool ->
{
assertThat(tool.getToolName()).isEqualTo("lookup");
assertThat(tool.getInput()).containsExactlyEntriesOf(Map.of("q", "hello"));
});
}
}
/*******************************************************************************
** Invalid JSON becomes bounded input for kernel validation, never NETWORK.
*******************************************************************************/
@ParameterizedTest
@ValueSource(strings = { "{broken", "null", "[]", "{} trailing", "long" })
void malformedArguments(String input) throws Exception
{
String arguments = input.equals("long") ? "x".repeat(250) : input;
try(MockOpenAiServer server = new MockOpenAiServer())
{
server.enqueue(200, event(Map.of("choices", List.of(Map.of("delta", Map.of("tool_calls", List.of(
Map.of("index", 0, "function", Map.of("name", "lookup", "arguments", arguments)))), "finish_reason", "stop")))));
ModelResponse response = new OpenAiCompatibleModelProvider(settings(server, "LLAMA_CPP")).stream(request(), t -> {}).await(Duration.ofSeconds(5));
assertThat(response.getStopReason()).isEqualTo(ModelResponse.STOP_TOOL_USE);
assertThat(response.getToolUses().getFirst().getInput()).containsExactlyEntriesOf(Map.of("_invalid_arguments", arguments.substring(0, Math.min(200, arguments.length()))));
}
}
/*******************************************************************************
** Supplier tokens take precedence over static keys and refresh per request.
*******************************************************************************/
@Test
void bearerSupplierPrecedenceAndRedaction() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
var token = new java.util.concurrent.atomic.AtomicReference<>("first-private-token");
ProviderSettings settings = settings(server, "VERTEX").withBearerTokenSupplier(token::get);
var provider = new OpenAiCompatibleModelProvider(settings);
server.enqueue(200, TEXT);
provider.stream(request(), delta -> {}).await(Duration.ofSeconds(5));
assertThat(server.requests.getFirst().authorization()).isEqualTo("Bearer first-private-token");
token.set("next-private-token");
server.enqueue(403, "{\"error\":{\"type\":\"next-private-token\",\"message\":\"next-private-token\"}}");
assertThatThrownBy(() -> provider.stream(request(), delta -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, error ->
{
assertThat(error.getKind()).isEqualTo(ModelProviderException.Kind.AUTHENTICATION);
assertThat(error.getProviderMessage()).isNull();
assertThat(error.getProviderErrorType()).isNull();
assertThat(error.toString()).doesNotContain("private-token");
});
assertThat(server.requests.get(1).authorization()).isEqualTo("Bearer next-private-token");
assertThat(settings.toString()).doesNotContain("private-token");
assertThat(OpenAiHttp.JSON.writeValueAsString(settings)).doesNotContain("bearerTokenSupplier", "private-token");
}
}
/*******************************************************************************
** Missing or failed dynamic credentials never fall back to a static secret.
*******************************************************************************/
@Test
void unavailableBearerSupplier() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
ProviderSettings settings = settings(server, "VERTEX");
for(String value : java.util.Arrays.asList(null, "", " "))
{
settings.setBearerTokenSupplier(() -> value);
var provider = new OpenAiCompatibleModelProvider(settings);
assertThatThrownBy(() -> provider.stream(request(), delta -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, error -> assertThat(error.getKind()).isEqualTo(ModelProviderException.Kind.AUTHENTICATION));
}
settings.withBearerTokenSupplier(() ->
{
throw (new IllegalStateException("private-token"));
});
var provider = new OpenAiCompatibleModelProvider(settings);
assertThatThrownBy(() -> provider.stream(request(), delta -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, error ->
{
assertThat(error.getKind()).isEqualTo(ModelProviderException.Kind.AUTHENTICATION);
assertThat(error.toString()).doesNotContain("private-token");
assertThat(error.getCause()).isNull();
});
assertThat(server.requests).isEmpty();
}
}
}
@@ -0,0 +1,87 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.testing.AssistantTestFixture;
import com.kingsrook.qbits.assistant.testing.GoldenTasks;
import com.kingsrook.qbits.assistant.testing.TurnRunner;
import com.kingsrook.qqq.backend.core.context.QContext;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Golden fixture task through the real adapter, engine and tool result mapping.
*******************************************************************************/
@Tag("golden")
class OpenAiGoldenTurnTest
{
/*******************************************************************************
** A golden task travels through the engine, real UI tools and a tool round trip.
*******************************************************************************/
@Test
void goldenToolRoundTrip() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer())
{
Map<String, Object> arguments = Map.of("table", "blog_post", "filter", Map.of("booleanOperator", "AND", "criteria",
List.of(Map.of("field", "status", "operator", "EQUALS", "values", List.of("PUBLISHED")))));
Map<String, Object> call = Map.of("index", 0, "id", "count", "function", Map.of("name", "count_records", "arguments", OpenAiHttp.JSON.writeValueAsString(arguments)));
server.enqueue(200, OpenAiContractTest.event(Map.of("choices", List.of(Map.of("delta", Map.of("tool_calls", List.of(call)), "finish_reason", "stop")))));
server.enqueue(200, OpenAiContractTest.event(Map.of("choices", List.of(Map.of("delta", Map.of("content", "There are " + AssistantTestFixture.PUBLISHED_POSTS + " published posts. /app/blog_post"), "finish_reason", "stop")))));
var provider = new OpenAiCompatibleModelProvider(OpenAiContractTest.settings(server, "OLLAMA"));
var config = new AssistantQBitConfig().withProviderName(provider.getName()).withModelProvider(provider);
try
{
var instance = AssistantTestFixture.build(config);
var task = GoldenTasks.all().stream().filter(t -> t.id().equals("count-published-posts")).findFirst().orElseThrow();
var outcome = new TurnRunner(instance, config).run(task.userId(), task.prompt());
assertThat(outcome.errorCode()).isNull();
task.check().accept(outcome);
assertThat(outcome.text()).isEqualTo("There are " + AssistantTestFixture.PUBLISHED_POSTS + " published posts. /app/blog_post");
assertThat(outcome.end()).isNotEmpty();
assertThat(server.requests).hasSize(2);
JsonNode messages = OpenAiHttp.JSON.readTree(server.requests.get(1).body()).path("messages");
JsonNode assistant = messages.get(messages.size() - 2);
assertThat(assistant.path("role").asText()).isEqualTo("assistant");
assertThat(assistant.path("tool_calls")).hasSize(1);
assertThat(assistant.path("tool_calls").get(0).path("id").asText()).isEqualTo("count");
assertThat(assistant.path("tool_calls").get(0).path("function").path("name").asText()).isEqualTo("count_records");
assertThat(messages.get(messages.size() - 1).path("content").asText()).contains("count").doesNotStartWith("ERROR:");
assertThat(messages.get(messages.size() - 1).path("role").asText()).isEqualTo("tool");
assertThat(messages.get(messages.size() - 1).path("tool_call_id").asText()).isEqualTo("count");
}
finally
{
if(config.getRuntime() != null)
{
config.getRuntime().close();
}
QContext.clear();
}
}
}
}
@@ -0,0 +1,216 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.KeyStore;
import java.time.Duration;
import java.util.Set;
import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLContext;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.model.AssistantProvider;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.testing.AssistantTestFixture;
import com.kingsrook.qqq.backend.core.context.QContext;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Private CA coverage against loopback HTTPS; all key material is test-only.
*******************************************************************************/
class OpenAiTlsTest
{
@TempDir
Path temporary;
/*******************************************************************************
** The public test root, never a real deployment CA.
*******************************************************************************/
private String pem() throws Exception
{
try(InputStream input = getClass().getResourceAsStream("/tls/ca.pem"))
{
return (new String(input.readAllBytes(), StandardCharsets.US_ASCII));
}
}
/*******************************************************************************
** Leaf chain signed by the test root, valid for localhost but not its IP.
*******************************************************************************/
private SSLContext serverContext() throws Exception
{
KeyStore store = KeyStore.getInstance("PKCS12");
try(InputStream input = getClass().getResourceAsStream("/tls/server.p12"))
{
store.load(input, "test-only".toCharArray());
}
KeyManagerFactory keys = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
keys.init(store, "test-only".toCharArray());
SSLContext context = SSLContext.getInstance("TLS");
context.init(keys.getKeyManagers(), null, null);
return (context);
}
/*******************************************************************************
** Every operation rejects the unknown CA with a safe, actionable diagnostic.
*******************************************************************************/
@Test
void untrustedCertificate() throws Exception
{
try(MockOpenAiServer server = new MockOpenAiServer(serverContext()))
{
ProviderSettings settings = OpenAiContractTest.settings(server, "OLLAMA");
var type = new OpenAiCompatibleProviderType();
assertThatThrownBy(() -> type.discoverModels(settings)).isInstanceOfSatisfying(ModelProviderException.class, this::trustError);
assertThat(type.checkHealth(settings).healthy()).isFalse();
assertThat(type.checkHealth(settings).message()).contains("NETWORK", "tlsCaBundle");
assertThatThrownBy(() -> type.create(settings).stream(OpenAiContractTest.request(), t -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, this::trustError);
assertThat(server.requests).isEmpty();
}
}
/*******************************************************************************
** No raw handshake details, keys, or certificate contents escape.
*******************************************************************************/
private void trustError(ModelProviderException error)
{
assertThat(error.getKind()).isEqualTo(ModelProviderException.Kind.NETWORK);
assertThat(error.getMessage()).contains("certificate is not trusted", "tlsCaBundle").doesNotContain("synthetic-key", "TEST ONLY", "BEGIN CERTIFICATE");
assertThat(error.getCause()).isNull();
}
/*******************************************************************************
** Shared trust enables all operations while endpoint identification stays on.
*******************************************************************************/
@Test
void trustedHealthDiscoveryChatAndHostnameCheck() throws Exception
{
var config = new AssistantQBitConfig().withTrustedCaBundle("test-root", pem());
try(MockOpenAiServer server = new MockOpenAiServer(serverContext()))
{
ProviderSettings settings = OpenAiContractTest.settings(server, "OLLAMA").withTlsCaBundle("test-root")
.withSslContext(config.getTrustedCaBundles().get("test-root"));
var type = new OpenAiCompatibleProviderType();
String models = "{\"data\":[{\"id\":\"test\"}]}";
server.enqueue(200, models);
assertThat(type.checkHealth(settings).healthy()).isTrue();
server.enqueue(200, models);
assertThat(type.discoverModels(settings)).extracting(m -> m.modelId()).containsExactly("test");
server.enqueue(200, OpenAiContractTest.TEXT);
assertThat(type.create(settings).stream(OpenAiContractTest.request(), t -> {}).await(Duration.ofSeconds(5)).getText()).isEqualTo("OK");
assertThat(server.requests).hasSize(3).allSatisfy(r -> assertThat(r.authorization()).isEqualTo("Bearer synthetic-key"));
settings.withBaseUrl(server.url().replace("localhost", "127.0.0.1"));
assertThatThrownBy(() -> type.discoverModels(settings)).isInstanceOfSatisfying(ModelProviderException.class, this::trustError);
assertThatThrownBy(() -> type.create(settings).stream(OpenAiContractTest.request(), t -> {}).await(Duration.ofSeconds(5)))
.isInstanceOfSatisfying(ModelProviderException.class, this::trustError);
assertThat(server.requests).hasSize(3);
}
}
/*******************************************************************************
** Parse at startup, accept multiple PEMs, omit contexts from serialized beans.
*******************************************************************************/
@Test
void eagerConfigAndSerialization() throws Exception
{
String pem = pem();
Path file = temporary.resolve("bundle.pem");
Files.writeString(file, pem + pem);
var config = new AssistantQBitConfig().withTrustedCaBundleFile("test-root", file);
Files.delete(file);
assertThat(config.getTrustedCaBundles()).containsKey("test-root");
assertThatThrownBy(() -> config.getTrustedCaBundles().clear()).isInstanceOf(UnsupportedOperationException.class);
assertThat(OpenAiHttp.JSON.writeValueAsString(config)).doesNotContain("trustedCaBundles", "BEGIN CERTIFICATE", "test-root");
var settings = new ProviderSettings().withSslContext(config.getTrustedCaBundles().get("test-root"));
assertThat(OpenAiHttp.JSON.writeValueAsString(settings)).doesNotContain("sslContext", "BEGIN CERTIFICATE");
for(String invalid : new String[] { null, "", "private-content", pem + "private-content", "-----BEGIN CERTIFICATE-----bad-----END CERTIFICATE-----" })
{
assertThatThrownBy(() -> config.withTrustedCaBundle("bad", invalid)).isInstanceOf(IllegalArgumentException.class)
.hasMessageContaining("Invalid CA bundle").hasMessageNotContaining("private-content").hasNoCause();
}
assertThatThrownBy(() -> config.withTrustedCaBundle(" ", pem)).hasMessageContaining("CA bundle name");
assertThatThrownBy(() -> config.withTrustedCaBundleFile("missing", file)).hasMessage("Could not read the configured CA bundle file.").hasNoCause();
}
/*******************************************************************************
** Settings saves reject unknown names and HTTP; changing names rebuilds clients.
*******************************************************************************/
@Test
void registryValidationAndClientCache() throws Exception
{
var config = new AssistantQBitConfig().withProviderType(new OpenAiCompatibleProviderType())
.withAllowedBaseUrls(Set.of("https://localhost:8443/v1"))
.withTrustedCaBundle("first", pem()).withTrustedCaBundle("second", pem());
try
{
var instance = AssistantTestFixture.build(config);
QContext.init(instance, AssistantTestFixture.sessionFor(AssistantTestFixture.ADMIN));
var service = config.getRuntime().getProviderService();
var row = new AssistantProvider().withName("Test TLS").withProviderType("openai-compatible").withKind("OLLAMA")
.withBaseUrl("https://localhost:8443/v1").withTlsCaBundle("unknown");
assertThat(service.validate(row)).anyMatch(e -> e.contains("configured on this server"));
assertThatThrownBy(() -> service.settings(row)).hasMessageContaining("TLS CA bundle");
assertThatThrownBy(() -> config.getRuntime().getStore().insert(row)).hasMessageContaining("TLS CA bundle");
row.withTlsCaBundle("first").withBaseUrl(null);
assertThat(service.validate(row)).anyMatch(e -> e.contains("HTTPS"));
row.withBaseUrl("https://localhost:8443/v1");
assertThat(service.validate(row)).isEmpty();
row.withId(config.getRuntime().getStore().insert(row).getId());
assertThat(row.getTlsCaBundle()).isEqualTo("first");
assertThat(service.settings(row).getSslContext()).isSameAs(config.getTrustedCaBundles().get("first"));
var first = service.forRow(row, "test").provider();
assertThat(service.forRow(row, "test").provider()).isSameAs(first);
row.withTlsCaBundle("second");
assertThat(service.forRow(row, "test").provider()).isNotSameAs(first);
row.withTlsCaBundle(null);
assertThat(service.settings(row).getSslContext()).isNull();
assertThat(instance.getTable(AssistantProvider.TABLE_NAME).getField("tlsCaBundle").getMaxLength()).isEqualTo(100);
}
finally
{
if(config.getRuntime() != null)
{
config.getRuntime().close();
}
QContext.clear();
}
}
}
@@ -0,0 +1,251 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.openai.demo;
import java.io.IOException;
import java.math.BigDecimal;
import java.net.InetSocketAddress;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.Set;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.metadata.AssistantMetaDataBuilder;
import com.kingsrook.qbits.assistant.model.AssistantModel;
import com.kingsrook.qbits.assistant.model.AssistantProvider;
import com.kingsrook.qbits.assistant.persistence.AssistantStore;
import com.kingsrook.qbits.assistant.processes.DiscoverModelsProcess;
import com.kingsrook.qbits.assistant.processes.TestConnectionProcess;
import com.kingsrook.qbits.assistant.processes.TestModelConnectionProcess;
import com.kingsrook.qbits.assistant.provider.AssistantProviderType;
import com.kingsrook.qbits.assistant.provider.fake.ScriptedModelProvider;
import com.kingsrook.qbits.assistant.provider.openai.OpenAiCompatibleProviderType;
import com.kingsrook.qbits.assistant.testing.AssistantTestFixture;
import com.kingsrook.qbits.assistant.testing.TurnRunner;
import com.kingsrook.qqq.backend.core.actions.processes.QProcessCallbackFactory;
import com.kingsrook.qqq.backend.core.actions.processes.RunProcessAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.instances.AbstractQQQApplication;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessInput;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.modules.authentication.QAuthenticationModuleCustomizerInterface;
import com.kingsrook.qqq.middleware.javalin.QApplicationJavalinServer;
import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpServer;
/*******************************************************************************
** Memory-backed P-a screenshot demo. All discovery, tests and usage come from
** real application calls to a localhost mock; no external credentials are used.
*******************************************************************************/
public class OpenAiDemoServer extends AbstractQQQApplication
{
private static final String ADMIN = "admin-demo";
private static final String MODEL = "qwen3:30b-a3b";
private static QInstance instance;
/*******************************************************************************
** Give browser sessions the same admin identity used for demo traffic.
*******************************************************************************/
public static class DemoSessionCustomizer implements QAuthenticationModuleCustomizerInterface
{
/*******************************************************************************
**
*******************************************************************************/
@Override
public void customizeSession(QInstance qInstance, QSession qSession, Map<String, Object> context)
{
QSession admin = AssistantTestFixture.sessionFor(ADMIN);
qSession.setUser(admin.getUser());
qSession.setPermissions(admin.getPermissions());
qSession.withSecurityKeyValue(AssistantMetaDataBuilder.allAccessKeyName(AssistantQBitConfig.DEFAULT_OWNER_KEY_TYPE), true);
}
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public QInstance defineQInstance() throws QException
{
return (instance);
}
/*******************************************************************************
** Seed settings, execute the record actions and a turn, then serve Next UI.
*******************************************************************************/
public static void main(String[] args) throws Exception
{
int port = args.length > 0 ? Integer.parseInt(args[0]) : 8099;
HttpServer mock = HttpServer.create(new InetSocketAddress("127.0.0.1", 0), 0);
mock.createContext("/", OpenAiDemoServer::serveMock);
mock.start();
Runtime.getRuntime().addShutdownHook(new Thread(() -> mock.stop(0)));
String baseUrl = "http://127.0.0.1:" + mock.getAddress().getPort() + "/v1";
AssistantQBitConfig config = new AssistantQBitConfig()
.withProviderName(ScriptedModelProvider.DEFAULT_NAME)
.withModelProvider(new ScriptedModelProvider())
.withProviderType(new OpenAiCompatibleProviderType())
.withAllowedBaseUrls(Set.of(baseUrl))
.withSecretResolver(name -> null)
.withAllowedWidgetNames(Set.of());
AssistantProviderType anthropic = optionalAnthropicType();
if(anthropic != null)
{
config.withProviderType(anthropic);
}
instance = AssistantTestFixture.build(config);
Integer providerId;
Integer modelId;
QContext.init(instance, AssistantTestFixture.sessionFor(ADMIN));
try
{
AssistantStore store = config.getRuntime().getStore();
AssistantProvider local = store.insert(new AssistantProvider().withName("Local GPU (Ollama)")
.withProviderType("openai-compatible").withKind("OLLAMA").withLocation("LOCAL").withHipaaEligible(true)
.withBaseUrl(baseUrl).withModel(MODEL).withEnabled(true).withIsDefault(true));
providerId = local.getId();
store.insert(new AssistantProvider().withName("OpenRouter").withProviderType("openai-compatible")
.withKind("OPENROUTER").withLocation("CLOUD").withEnabled(false).withIsDefault(false));
if(anthropic != null)
{
store.insert(new AssistantProvider().withName("Claude (production)").withProviderType(anthropic.getType())
.withModel("claude-sonnet-5-5").withEnabled(false).withIsDefault(false));
}
runProcess(DiscoverModelsProcess.NAME, providerId);
AssistantModel model = store.listModels().stream().filter(m -> providerId.equals(m.getProviderId()) && MODEL.equals(m.getModelId()))
.findFirst().orElseThrow(() -> new QException("Demo model discovery failed."));
modelId = model.getId();
store.update(model.withInputUsdPerMTok(new BigDecimal("0.05")).withOutputUsdPerMTok(new BigDecimal("0.10")));
runProcess(TestConnectionProcess.NAME, providerId);
runProcess(TestModelConnectionProcess.NAME, modelId);
if(!"OK".equals(store.getProvider(providerId).getLastTestStatus())
|| store.listModels().stream().noneMatch(m -> modelId.equals(m.getId()) && "OK".equals(m.getLastTestStatus())))
{
throw (new QException("Demo connection tests failed."));
}
}
finally
{
QContext.clear();
}
TurnRunner.Outcome outcome = new TurnRunner(instance, config).run(ADMIN, "Say hello from the local demo provider.");
if(outcome.errorCode() != null || outcome.text().isBlank())
{
throw (new QException("Demo assistant turn failed: " + outcome.errorCode()));
}
instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("mock").withType(QAuthenticationType.MOCK)
.withCustomizer(new QCodeReference(DemoSessionCustomizer.class)));
instance.setHomeAppName(AssistantMetaDataBuilder.APP_NAME);
new QApplicationJavalinServer(new OpenAiDemoServer()).withPort(port).withServeFrontendNext(true).start();
System.out.println("Assistant home: http://localhost:" + port + "/app/" + AssistantMetaDataBuilder.APP_NAME);
System.out.println("Local provider: http://localhost:" + port + "/app/assistant_provider/" + providerId);
System.out.println("Local model: http://localhost:" + port + "/app/assistant_model/" + modelId);
}
/*******************************************************************************
** Reuse the Anthropic type only when that optional module is on the classpath.
*******************************************************************************/
private static AssistantProviderType optionalAnthropicType() throws ReflectiveOperationException
{
try
{
return ((AssistantProviderType) Class.forName("com.kingsrook.qbits.assistant.provider.anthropic.AnthropicProviderType")
.getDeclaredConstructor().newInstance());
}
catch(ClassNotFoundException e)
{
return (null);
}
}
/*******************************************************************************
** Execute the same streamed ETL process as the record action, skipping UI.
*******************************************************************************/
private static void runProcess(String process, Integer id) throws QException
{
RunProcessInput input = new RunProcessInput();
input.setProcessName(process);
input.setCallback(QProcessCallbackFactory.forPrimaryKey("id", id));
input.setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior.SKIP);
new RunProcessAction().execute(input);
}
/*******************************************************************************
** Repeatable localhost endpoints for startup traffic and screenshot actions.
** Token counts are mock API reports, never measurements of GPU inference.
*******************************************************************************/
private static void serveMock(HttpExchange exchange) throws IOException
{
try(exchange)
{
exchange.getRequestBody().readAllBytes();
String path = exchange.getRequestURI().getPath();
String body;
if("GET".equals(exchange.getRequestMethod()) && "/v1/models".equals(path))
{
exchange.getResponseHeaders().set("Content-Type", "application/json");
body = """
{"object":"list","data":[{"id":"qwen3:30b-a3b","object":"model","owned_by":"local"},
{"id":"gpt-oss:20b","object":"model","owned_by":"local"},
{"id":"qwen3-coder:30b","object":"model","owned_by":"local"},
{"id":"bge-m3","object":"model","owned_by":"local"}]}
""";
}
else if("POST".equals(exchange.getRequestMethod()) && "/v1/chat/completions".equals(path))
{
exchange.getResponseHeaders().set("Content-Type", "text/event-stream");
body = """
data: {"id":"demo-completion","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant","content":"Hello from the local demo provider."}}]}
data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}
data: {"choices":[],"usage":{"prompt_tokens":24,"completion_tokens":8,"total_tokens":32}}
data: [DONE]
""";
}
else
{
exchange.sendResponseHeaders(404, -1);
return;
}
exchange.sendResponseHeaders(200, 0);
exchange.getResponseBody().write(body.getBytes(StandardCharsets.UTF_8));
exchange.getResponseBody().flush();
}
}
}
@@ -0,0 +1,53 @@
# OpenAI-compatible provider registry demo
Run from the repository root in PowerShell with Java 21. This is a manual,
memory-backed screenshot server, not a Surefire test. Nothing is persisted
between runs. No API keys or external model services are needed: the secret
resolver deliberately returns no keys, including when the shell has credentials.
Build the test classpath (the local reactor class directories come first below,
so the demo uses this checkout's code and fixture):
```powershell
.\mvnw.cmd -q -pl qbit-assistant-provider-openai -am test-compile dependency:build-classpath '-Dmdep.includeScope=test' '-Dmdep.outputFile=target/demo-classpath.txt'
if ($LASTEXITCODE -ne 0) { throw 'Demo compilation/classpath generation failed' }
$demoDependencies = (Get-Content qbit-assistant-provider-openai/target/demo-classpath.txt -Raw).Trim()
$demoFrontend = "$env:USERPROFILE/.m2/repository/com/kingsrook/qqq/qqq-frontend-next/1.0.0-RC.18/qqq-frontend-next-1.0.0-RC.18.jar"
$demoClasspath = "qbit-assistant-provider-openai/target/test-classes;qbit-assistant-provider-openai/target/classes;qbit-assistant/target/test-classes;qbit-assistant/target/classes;$demoFrontend;$demoDependencies"
java -cp $demoClasspath com.kingsrook.qbits.assistant.provider.openai.demo.OpenAiDemoServer 8099
```
The frontend artifact is `com.kingsrook.qqq:qqq-frontend-next:1.0.0-RC.18`,
already in the local Maven repository. Adjust `$demoFrontend` if your Maven
local repository is elsewhere. Omit the final port argument for the default
8099, or use another free port (the smoke check used 18099). Stop with Ctrl+C.
Startup prints these URLs (with the selected port):
- Assistant home: `http://localhost:8099/app/assistantAdmin`
- Local provider: `http://localhost:8099/app/assistant_provider/1`
- Priced and tested model: `http://localhost:8099/app/assistant_model/1`
Every browser session is `admin-demo`. Startup inserts an enabled, default,
keyless Local GPU (Ollama) provider, marked LOCAL and HIPAA eligible for the
synthetic demo, and a disabled CLOUD OpenRouter provider whose key is Not set.
If the Anthropic module is explicitly added to the classpath, its provider type
and a disabled Claude (production) row are also included; otherwise it is skipped.
The normal Discover models process fetches four model IDs from the localhost
mock: `qwen3:30b-a3b`, `gpt-oss:20b`, `qwen3-coder:30b`, and `bge-m3`.
A normal update sets qwen3's input/output compute prices to $0.05/$0.10 per
million tokens. The provider and model Test connection processes then each
make a real HTTP completion call, recording two TEST usage rows and the
last-test fields. One assistant turn records a third usage row with purpose
TURN. Discovery timestamps/status also come from the actual process.
Replies and token counts are synthetic mock API responses (24 input / 8 output
tokens per completion), not live GPU measurements or billed cloud usage.
No usage/history rows are manually seeded. The mock remains available for
repeating discovery, connection tests and chat while taking screenshots.
Capture the P-a screens in light and dark at 390 and 1440 px; see
[`docs/screenshots/README.md`](../../../../../../../../../../../docs/screenshots/README.md)
for the planned screenshot prefixes.
@@ -0,0 +1,23 @@
# Test-only TLS fixtures
These certificates and the private key in `server.p12` are synthetic test material.
They must never be used for deployment or trusted outside tests. The PKCS12
password is `test-only`. The CA private key is not retained in the repository.
BouncyCastle was not on the test classpath, so fixtures were generated with the
JDK 21 **keytool executable**, not internal `sun.security` APIs.
The leaf is signed by `QBit TEST ONLY Root CA` and has only `DNS:localhost` in its
SAN; connecting to `127.0.0.1` deliberately fails hostname verification. Both
certificates start on 2020-01-01 and last 36,500 days to avoid date-dependent tests.
Each regeneration creates fresh random keys. Run in a temporary directory, then
copy only `ca.pem` and `server.p12` here:
```sh
keytool -genkeypair -alias ca -keyalg RSA -keysize 2048 -dname 'CN=QBit TEST ONLY Root CA' -ext bc:c=ca:true -ext ku:c=keyCertSign,cRLSign -startdate '2020/01/01 00:00:00' -validity 36500 -keystore ca.p12 -storepass test-only -storetype PKCS12 -noprompt
keytool -exportcert -rfc -alias ca -keystore ca.p12 -storepass test-only -file ca.pem
keytool -genkeypair -alias server -keyalg RSA -keysize 2048 -dname 'CN=localhost' -startdate '2020/01/01 00:00:00' -validity 36500 -keystore server.p12 -storetype PKCS12 -storepass test-only -noprompt
keytool -certreq -alias server -keystore server.p12 -storepass test-only -file server.csr
keytool -gencert -alias ca -keystore ca.p12 -storepass test-only -infile server.csr -outfile server.pem -rfc -startdate '2020/01/01 00:00:00' -validity 36500 -ext san=dns:localhost -ext eku=serverAuth -ext ku=digitalSignature,keyEncipherment
keytool -importcert -alias ca -file ca.pem -keystore server.p12 -storepass test-only -noprompt
keytool -importcert -alias server -file server.pem -keystore server.p12 -storepass test-only -noprompt
```
@@ -0,0 +1,19 @@
-----BEGIN CERTIFICATE-----
MIIDCDCCAfCgAwIBAgIII8Xlo9Lidn4wDQYJKoZIhvcNAQEMBQAwITEfMB0GA1UE
AxMWUUJpdCBURVNUIE9OTFkgUm9vdCBDQTAgFw0yMDAxMDEwNjAwMDBaGA8yMTE5
MTIwODA2MDAwMFowITEfMB0GA1UEAxMWUUJpdCBURVNUIE9OTFkgUm9vdCBDQTCC
ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMyuwvRX9gZCJoJW68JPf8HC
9rA/WAqSwIgwOi6JUVGfRFkp3DZGvfvfw/SiYkED+Zf0AeVrfOZbNZO4dXoe9Rxq
YBu4nr79jCfKnlmGsIr/YmWxePUzixvxJ7suHb4y1uah7C36h1EeQKAEYbpFhI7o
WVQkZonWDr4w0PmcstjS4lIT43lZdbAxX7RRhiBKe9Ph9P+sqbn1Uk4GOPo5YQkg
5eZSPAU4gVh4K07e4aVej+kRHMqMmP4joY4KHBrZXOHKN/mXDGkipys0bf+z7uti
/qowu6lNEdF/IihvCgU/fe5wVFbdh7E5t+mpRo+A9B0YrQAtqkJ6gw+Nrwr2TvEC
AwEAAaNCMEAwHQYDVR0OBBYEFMul052SYQj4mA4NgW+mX5mfSzgyMA4GA1UdDwEB
/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBDAUAA4IBAQCAKxnC
2iBt6cxyh3T/Z11fdBEEFASYU2C/nGqt1FnYhyfR9eluDerNJqsnHmP9pjmf5KAO
bGYiw9WodHEbLyM9etNPJSCJRouCHFmRyWarfQV95NjkMfVMXdA2zNWmWv0vxZ2y
dOSQUP3nCegLW1JqBoDsdJCJvzU8lcuUwVd9BNywcXmrQbL0iHETwUUWtIEACv2A
ja9ZNHYs1oZbaA9YotK3vCcCt0B9xHxMDza9Er7ljTWE6zexTh7IWJ/MbABUdQbQ
SGDVrVFlk2PoDIO5rwRwS8LwaKkdwuPcAHbhBRN3HVyr06SBD7AiVWhUV7g5R+h3
qHqj8SDW3k3QL63f
-----END CERTIFICATE-----
+141
View File
@@ -0,0 +1,141 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2026 Kingsrook, LLC
~
~ 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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-parent</artifactId>
<version>${revision}</version>
</parent>
<artifactId>qbit-assistant-provider-vertex</artifactId>
<packaging>jar</packaging>
<name>QBit Assistant - Vertex provider</name>
<description>Vertex provider using the Anthropic cloud backend</description>
<url>https://github.com/QRun-IO/qbit-assistant</url>
<dependencies>
<dependency>
<groupId>com.anthropic</groupId>
<artifactId>anthropic-java-vertex</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-provider-anthropic</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant-provider-openai</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-backend-core</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-assistant</artifactId>
<type>test-jar</type>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-middleware-javalin</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<!-- live evals call the real API: opt-in only -->
<excludedGroups>${test.excludedGroups}</excludedGroups>
<redirectTestOutputToFile>true</redirectTestOutputToFile>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<executions>
<execution>
<id>prepare-agent</id>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>verify</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
<execution>
<id>check</id>
<goals>
<goal>check</goal>
</goals>
<configuration>
<rules>
<rule>
<element>BUNDLE</element>
<limits>
<limit>
<counter>INSTRUCTION</counter>
<value>COVEREDRATIO</value>
<minimum>0.70</minimum>
</limit>
<limit>
<counter>CLASS</counter>
<value>COVEREDRATIO</value>
<minimum>0.90</minimum>
</limit>
</limits>
</rule>
</rules>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,166 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.vertex;
import java.io.IOException;
import java.time.Duration;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.core.Timeout;
import com.anthropic.vertex.backends.VertexBackend;
import com.google.auth.oauth2.GoogleCredentials;
import com.kingsrook.qbits.assistant.provider.AssistantModelProvider;
import com.kingsrook.qbits.assistant.provider.ModelCapabilities;
import com.kingsrook.qbits.assistant.provider.ModelEventListener;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.provider.StreamHandle;
import com.kingsrook.qbits.assistant.provider.anthropic.AnthropicModelProvider;
import com.kingsrook.qbits.assistant.provider.openai.OpenAiCompatibleModelProvider;
/*******************************************************************************
** Route Claude to the Anthropic backend and other models to Vertex OpenAI.
** One scoped ADC credential supplies both clients; access tokens stay in memory.
*******************************************************************************/
public class VertexModelProvider implements AssistantModelProvider
{
private final AnthropicModelProvider claude;
private final OpenAiCompatibleModelProvider openai;
/*******************************************************************************
** Load Application Default Credentials without exposing credential failures.
*******************************************************************************/
public VertexModelProvider(ProviderSettings settings)
{
this(settings, applicationCredentials());
}
/*******************************************************************************
** Credential injection for deterministic, offline contract tests.
*******************************************************************************/
VertexModelProvider(ProviderSettings settings, GoogleCredentials credentials)
{
GoogleCredentials scoped = credentials.createScoped("https://www.googleapis.com/auth/cloud-platform");
var backend = VertexBackend.builder().googleCredentials(scoped).region(settings.getRegion()).project(settings.getCloudProject());
if(settings.getBaseUrl() != null)
{
backend.baseUrl(settings.getBaseUrl());
}
claude = AnthropicModelProvider.builder().client(AnthropicOkHttpClient.builder().backend(backend.build())
.timeout(Timeout.builder().connect(Duration.ofSeconds(settings.getConnectTimeoutSeconds()))
.request(Duration.ofSeconds(settings.getRequestTimeoutSeconds())).build()).build()).build();
String base = settings.getBaseUrl() == null ? "https://" + settings.getRegion() + "-aiplatform.googleapis.com/v1/projects/"
+ settings.getCloudProject() + "/locations/" + settings.getRegion() + "/endpoints/openapi" : settings.getBaseUrl();
openai = new OpenAiCompatibleModelProvider(new ProviderSettings().withKind("VERTEX").withBaseUrl(base)
.withConnectTimeoutSeconds(settings.getConnectTimeoutSeconds()).withRequestTimeoutSeconds(settings.getRequestTimeoutSeconds())
.withTlsCaBundle(settings.getTlsCaBundle()).withSslContext(settings.getSslContext())
.withBearerTokenSupplier(() -> accessToken(scoped)));
}
/*******************************************************************************
** Resolve ADC lazily when a provider is created, not during registration.
*******************************************************************************/
private static GoogleCredentials applicationCredentials()
{
try
{
return (GoogleCredentials.getApplicationDefault());
}
catch(IOException e)
{
throw (new IllegalStateException("Google Application Default Credentials are unavailable. Configure GOOGLE_APPLICATION_CREDENTIALS or workload identity."));
}
}
/*******************************************************************************
** Refresh expired credentials on every request; never retain a token in settings.
*******************************************************************************/
private static String accessToken(GoogleCredentials credentials)
{
try
{
credentials.refreshIfExpired();
return (credentials.getAccessToken().getTokenValue());
}
catch(IOException e)
{
throw (new IllegalStateException("Could not refresh Google Application Default Credentials."));
}
}
/*******************************************************************************
** Provider identity.
*******************************************************************************/
@Override
public String getName()
{
return ("vertex");
}
/*******************************************************************************
** Route using the registry's model id; caller requests are never mutated.
*******************************************************************************/
private AssistantModelProvider route(String model)
{
return (model != null && model.startsWith("claude-") ? claude : openai);
}
/*******************************************************************************
** Capabilities follow the selected backend.
*******************************************************************************/
@Override
public ModelCapabilities getCapabilities(String modelId)
{
return (route(modelId).getCapabilities(modelId));
}
/*******************************************************************************
** Stream through the existing adapters, preserving their error and tool mapping.
*******************************************************************************/
@Override
public StreamHandle stream(ModelRequest request, ModelEventListener listener)
{
return (route(request.getModel()).stream(request, listener));
}
/*******************************************************************************
** Release the Anthropic client and its executor.
*******************************************************************************/
public void close()
{
claude.close();
}
}
@@ -0,0 +1,157 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.vertex;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.assistant.model.AssistantProvider;
import com.kingsrook.qbits.assistant.provider.AssistantModelProvider;
import com.kingsrook.qbits.assistant.provider.AssistantProviderType;
import com.kingsrook.qbits.assistant.provider.DiscoveredModel;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
/*******************************************************************************
** Google Vertex AI (Claude, Gemini), using server credentials and region-derived endpoints.
*******************************************************************************/
public class VertexProviderType implements AssistantProviderType
{
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getType()
{
return ("vertex");
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getLabel()
{
return ("Google Vertex AI (Claude, Gemini)");
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public List<String> getModels()
{
return (List.of("claude-sonnet-4-5@20250929", "claude-haiku-4-5@20251001", "gemini-2.5-pro", "gemini-2.5-flash"));
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getDefaultApiKeyEnvName()
{
return (null);
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public String getDefaultBaseUrl()
{
return (null);
}
/*******************************************************************************
** Provider registry contract.
*******************************************************************************/
@Override
public boolean requiresBaseUrl(String kind)
{
return (false);
}
/*******************************************************************************
** Validate cloud settings without loading credentials.
*******************************************************************************/
@Override
public List<String> validate(AssistantProvider row)
{
List<String> errors = new ArrayList<>();
if(row.getRegion() == null || row.getRegion().isBlank())
{
errors.add("Region is required for VERTEX.");
}
if(row.getApiKeyEnvName() != null && !row.getApiKeyEnvName().isBlank())
{
errors.add("Leave API key variable empty: Google Vertex AI (Claude, Gemini) uses Google Application Default Credentials (GOOGLE_APPLICATION_CREDENTIALS or workload identity).");
}
if(row.getCloudProject() == null || row.getCloudProject().isBlank())
{
errors.add("GCP project id (cloudProject) is required for VERTEX.");
}
return (errors);
}
/*******************************************************************************
** Cloud providers require resolved region/project settings.
*******************************************************************************/
@Override
public AssistantModelProvider create(String apiKey, String baseUrl)
{
throw (new IllegalArgumentException("Use ProviderSettings with the required cloud region and project."));
}
/*******************************************************************************
** Static defaults; this adapter does not query the Vertex Model Garden.
*******************************************************************************/
@Override
public List<DiscoveredModel> discoverModels(ProviderSettings settings)
{
return (getModels().stream().map(id -> new DiscoveredModel(id, id, null, null)).toList());
}
/*******************************************************************************
** Create the provider with server credentials.
*******************************************************************************/
@Override
public AssistantModelProvider create(ProviderSettings settings)
{
return (new VertexModelProvider(settings));
}
}
@@ -0,0 +1,309 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.vertex;
import java.io.IOException;
import java.time.Clock;
import java.time.Duration;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.GoogleCredentials;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.engine.ProviderService;
import com.kingsrook.qbits.assistant.model.AssistantProvider;
import com.kingsrook.qbits.assistant.provider.ModelMessage;
import com.kingsrook.qbits.assistant.provider.ModelProviderException;
import com.kingsrook.qbits.assistant.provider.ModelRequest;
import com.kingsrook.qbits.assistant.provider.ModelToolDefinition;
import com.kingsrook.qbits.assistant.provider.ProviderSettings;
import com.kingsrook.qbits.assistant.testing.CloudProviderTestServer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static com.kingsrook.qbits.assistant.testing.CloudProviderTestServer.JSON;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Real Vertex Claude and OpenAI-compatible transports using fake ADC tokens.
*******************************************************************************/
class VertexContractTest
{
static final String CLAUDE = "claude-sonnet-4-5@20250929";
static final String GEMINI = "gemini-2.5-flash";
/*******************************************************************************
** Fixed fake token, valid well beyond the test duration.
*******************************************************************************/
static GoogleCredentials credentials()
{
return (GoogleCredentials.create(new AccessToken("fake-google-token", new Date(System.currentTimeMillis() + 3_600_000))));
}
/*******************************************************************************
** Scoped connection settings with a loopback override.
*******************************************************************************/
static ProviderSettings settings(CloudProviderTestServer server)
{
return (new ProviderSettings().withKind("VERTEX").withRegion("us-east5").withCloudProject("test-project").withBaseUrl(server.url())
.withConnectTimeoutSeconds(2).withRequestTimeoutSeconds(5));
}
/*******************************************************************************
** A strict request verifies that only the Claude backend preserves strict.
*******************************************************************************/
static ModelRequest request(String model)
{
return (new ModelRequest().withModel(model).withMaxTokens(1024).withMessages(List.of(ModelMessage.user("Count posts")))
.withTools(List.of(new ModelToolDefinition().withName("count_records").withDescription("Count records").withStrict(true)
.withInputSchema(Map.of("type", "object", "properties", Map.of("table", Map.of("type", "string")), "required", List.of("table"), "additionalProperties", false)))));
}
/*******************************************************************************
** Text and a fragmented tool call in a Vertex OpenAI-compatible stream.
*******************************************************************************/
static String geminiSse(String text, Map<String, Object> input) throws IOException
{
StringBuilder events = new StringBuilder();
events.append("data: ").append(JSON.writeValueAsString(Map.of("choices", List.of(Map.of("delta", Map.of("content", text)))))).append("\n\n");
if(input != null)
{
String arguments = JSON.writeValueAsString(input);
Integer middle = arguments.length() / 2;
events.append("data: ").append(JSON.writeValueAsString(Map.of("choices", List.of(Map.of("delta", Map.of("tool_calls", List.of(
Map.of("index", 0, "id", "count", "type", "function", "function", Map.of("name", "count_records", "arguments", arguments.substring(0, middle)))))))))).append("\n\n");
events.append("data: ").append(JSON.writeValueAsString(Map.of("choices", List.of(Map.of("delta", Map.of("tool_calls", List.of(
Map.of("index", 0, "function", Map.of("arguments", arguments.substring(middle)))))))))).append("\n\n");
}
events.append("data: ").append(JSON.writeValueAsString(Map.of("choices", List.of(Map.of("delta", Map.of(), "finish_reason", input == null ? "stop" : "tool_calls")),
"usage", Map.of("prompt_tokens", 12, "completion_tokens", 7)))).append("\n\ndata: [DONE]\n\n");
return (events.toString());
}
/*******************************************************************************
** Claude path, ADC bearer, Anthropic version, streaming text, tools and usage.
*******************************************************************************/
@Test
void claudeContract() throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
server.sse(CloudProviderTestServer.anthropicSse(CLAUDE, "Checking.", Map.of("table", "blog_post")));
var provider = new VertexModelProvider(settings(server), credentials());
try
{
StringBuilder text = new StringBuilder();
var response = provider.stream(request(CLAUDE), text::append).await(Duration.ofSeconds(10));
assertThat(provider.getName()).isEqualTo("vertex");
assertThat(provider.getCapabilities(CLAUDE).getPromptCaching()).isTrue();
assertThat(text.toString()).isEqualTo("Checking.");
assertThat(response.getToolUses()).singleElement().satisfies(tool ->
{
assertThat(tool.getToolUseId()).isEqualTo("count");
assertThat(tool.getToolName()).isEqualTo("count_records");
assertThat(tool.getInput()).containsEntry("table", "blog_post");
});
assertThat(response.getUsage().getInputTokens()).isEqualTo(12);
assertThat(response.getUsage().getOutputTokens()).isEqualTo(7);
var sent = server.requests.getFirst();
assertThat(sent.path()).isEqualTo("/v1/projects/test-project/locations/us-east5/publishers/anthropic/models/" + CLAUDE + ":streamRawPredict");
assertThat(sent.authorization()).isEqualTo("Bearer fake-google-token");
var body = JSON.readTree(sent.body());
assertThat(body.path("anthropic_version").asText()).isEqualTo("vertex-2023-10-16");
assertThat(body.has("model")).isFalse();
assertThat(body.path("tools").get(0).path("strict").asBoolean()).isTrue();
}
finally
{
provider.close();
}
}
}
/*******************************************************************************
** Gemini, already-prefixed and other ids all use OpenAI without strict.
*******************************************************************************/
@ParameterizedTest
@ValueSource(strings = { "gemini-2.5-flash", "google/gemini-2.5-pro", "other-model" })
void geminiContractAndTokenRefresh(String model) throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
var credentials = new RefreshingCredentials();
String endpoint = "/v1/projects/test-project/locations/us-east5/endpoints/openapi";
var provider = new VertexModelProvider(settings(server).withBaseUrl(server.url() + endpoint), credentials);
try
{
for(int call = 1; call <= 2; call++)
{
server.sse(geminiSse("Checking.", Map.of("table", "blog_post")));
StringBuilder text = new StringBuilder();
ModelRequest request = request(model);
var response = provider.stream(request, text::append).await(Duration.ofSeconds(10));
assertThat(text.toString()).isEqualTo("Checking.");
assertThat(request.getModel()).isEqualTo(model);
assertThat(response.getToolUses()).singleElement().satisfies(tool ->
{
assertThat(tool.getToolName()).isEqualTo("count_records");
assertThat(tool.getInput()).containsEntry("table", "blog_post");
});
assertThat(response.getUsage().getInputTokens()).isEqualTo(12);
assertThat(response.getUsage().getOutputTokens()).isEqualTo(7);
var sent = server.requests.get(call - 1);
assertThat(sent.path()).isEqualTo(endpoint + "/chat/completions");
assertThat(sent.authorization()).isEqualTo("Bearer refreshed-" + call);
var body = JSON.readTree(sent.body());
assertThat(body.path("model").asText()).isEqualTo(model.contains("/") ? model : "google/" + model);
assertThat(body.path("tools").get(0).path("function").has("strict")).isFalse();
if(call == 1)
{
credentials.refresh();
}
}
assertThat(credentials.refreshes).isEqualTo(2);
assertThat(provider.getCapabilities(model).getPromptCaching()).isFalse();
assertThat(provider.getCapabilities(null).getTools()).isTrue();
}
finally
{
provider.close();
}
}
}
/*******************************************************************************
** Start expired so refreshIfExpired must obtain the first token itself.
*******************************************************************************/
static class RefreshingCredentials extends GoogleCredentials
{
private Integer refreshes = 0;
/*******************************************************************************
** An expired fake token cannot authorize the first request.
*******************************************************************************/
RefreshingCredentials()
{
super(new AccessToken("expired", new Date(0)));
}
/*******************************************************************************
** Deterministic replacement tokens, without a token-server request.
*******************************************************************************/
@Override
public AccessToken refreshAccessToken() throws IOException
{
refreshes++;
return (new AccessToken("refreshed-" + refreshes, new Date(System.currentTimeMillis() + 3_600_000)));
}
}
/*******************************************************************************
** ADC refresh failures cannot leak the credential exception's details.
*******************************************************************************/
@Test
void refreshFailureIsSanitized() throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
var credentials = new RefreshingCredentials()
{
/*******************************************************************************
** Simulate a token service failure containing confidential diagnostics.
*******************************************************************************/
@Override
public AccessToken refreshAccessToken() throws IOException
{
throw (new IOException("synthetic-private-token"));
}
};
var provider = new VertexModelProvider(settings(server), credentials);
try
{
assertThatThrownBy(() -> provider.stream(request(GEMINI), delta -> {}).await(Duration.ofSeconds(10)))
.isInstanceOfSatisfying(ModelProviderException.class, error ->
{
assertThat(error.getKind()).isEqualTo(ModelProviderException.Kind.AUTHENTICATION);
assertThat(error.toString()).doesNotContain("synthetic-private-token");
assertThat(error.getCause()).isNull();
});
assertThat(server.requests).isEmpty();
}
finally
{
provider.close();
}
}
}
/*******************************************************************************
** Cloud requirements, static discovery and URL allowlists need no ADC lookup.
*******************************************************************************/
@Test
void settingsValidationAndDefaults() throws Exception
{
var type = new VertexProviderType();
var config = new AssistantQBitConfig().withProviderType(type).withAllowedBaseUrls(Set.of("http://127.0.0.1:1234"));
var service = new ProviderService(config, null, Clock.systemUTC());
var row = new AssistantProvider().withProviderType("vertex");
assertThat(service.validate(row)).anyMatch(error -> error.contains("Region is required")).anyMatch(error -> error.contains("project id"));
row.withRegion(" ").withCloudProject(" ");
assertThat(service.validate(row)).hasSize(2);
row.withRegion("us-east5").withCloudProject("test-project");
assertThat(service.validate(row)).isEmpty();
row.withApiKeyEnvName("GOOGLE_API_KEY");
assertThat(service.validate(row)).anyMatch(error -> error.contains("Application Default Credentials"));
row.withApiKeyEnvName(" ").withBaseUrl("https://unlisted.example");
assertThat(service.validate(row)).anyMatch(error -> error.contains("not allowed"));
row.withBaseUrl("http://127.0.0.1:1234");
assertThat(service.validate(row)).isEmpty();
assertThat(type.getType()).isEqualTo("vertex");
assertThat(type.getKinds()).containsExactly("VERTEX");
assertThat(type.getLabel()).isEqualTo("Google Vertex AI (Claude, Gemini)");
assertThat(type.getDefaultLocation("VERTEX")).isEqualTo("CLOUD");
assertThat(type.getDefaultApiKeyEnvName()).isNull();
assertThat(type.getDefaultBaseUrl()).isNull();
assertThat(type.discoverModels(new ProviderSettings())).extracting(model -> model.modelId()).containsExactlyElementsOf(type.getModels());
assertThat(type.checkHealth(new ProviderSettings()).healthy()).isNull();
assertThatThrownBy(() -> type.create("key", null)).isInstanceOf(IllegalArgumentException.class);
// Exercise endpoint derivation without sending any request to that endpoint.
var provider = new VertexModelProvider(new ProviderSettings().withRegion("us-east5").withCloudProject("test-project"), credentials());
provider.close();
}
}
@@ -0,0 +1,100 @@
/*
* Copyright 2026 Kingsrook, LLC
*
* 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.
*/
package com.kingsrook.qbits.assistant.provider.vertex;
import com.kingsrook.qbits.assistant.AssistantModelRouting;
import com.kingsrook.qbits.assistant.AssistantQBitConfig;
import com.kingsrook.qbits.assistant.testing.AssistantTestFixture;
import com.kingsrook.qbits.assistant.testing.CloudProviderTestServer;
import com.kingsrook.qbits.assistant.testing.GoldenTasks;
import com.kingsrook.qbits.assistant.testing.TurnRunner;
import com.kingsrook.qqq.backend.core.context.QContext;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static com.kingsrook.qbits.assistant.testing.CloudProviderTestServer.JSON;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Golden task through the cloud adapter, turn engine and permissioned UI tools.
*******************************************************************************/
@Tag("golden")
class VertexGoldenTurnTest
{
/*******************************************************************************
** A real count_records round trip returns the tool result to the model.
*******************************************************************************/
@ParameterizedTest
@ValueSource(strings = { VertexContractTest.CLAUDE, VertexContractTest.GEMINI })
void goldenToolRoundTrip(String model) throws Exception
{
try(CloudProviderTestServer server = new CloudProviderTestServer())
{
String answer = "There are " + AssistantTestFixture.PUBLISHED_POSTS + " published posts. /app/blog_post";
boolean claude = model.startsWith("claude-");
server.sse(claude ? CloudProviderTestServer.anthropicSse(model, "", CloudProviderTestServer.countInput()) : VertexContractTest.geminiSse("", CloudProviderTestServer.countInput()));
server.sse(claude ? CloudProviderTestServer.anthropicSse(model, answer, null) : VertexContractTest.geminiSse(answer, null));
var provider = new VertexModelProvider(VertexContractTest.settings(server), VertexContractTest.credentials());
var config = new AssistantQBitConfig().withProviderName(provider.getName()).withModelProvider(provider)
.withModels(new AssistantModelRouting().withMainModel(model));
try
{
var instance = AssistantTestFixture.build(config);
var task = GoldenTasks.all().stream().filter(t -> t.id().equals("count-published-posts")).findFirst().orElseThrow();
var outcome = new TurnRunner(instance, config).run(task.userId(), task.prompt());
assertThat(outcome.errorCode()).isNull();
task.check().accept(outcome);
assertThat(outcome.text()).endsWith(answer);
assertThat(outcome.end()).isNotEmpty();
assertThat(server.requests).hasSize(2);
var messages = JSON.readTree(server.requests.get(1).body()).path("messages");
var assistant = messages.get(messages.size() - 2);
var result = messages.get(messages.size() - 1);
assertThat(assistant.path("role").asText()).isEqualTo("assistant");
if(claude)
{
assertThat(assistant.path("content").toString()).contains("count_records", "count");
assertThat(result.path("role").asText()).isEqualTo("user");
var toolResult = result.path("content").get(0);
assertThat(toolResult.path("type").asText()).isEqualTo("tool_result");
assertThat(toolResult.path("tool_use_id").asText()).isEqualTo("count");
assertThat(toolResult.path("is_error").asBoolean()).isFalse();
assertThat(toolResult.path("content").toString()).contains("count");
}
else
{
assertThat(assistant.path("tool_calls")).hasSize(1);
assertThat(assistant.path("tool_calls").get(0).path("id").asText()).isEqualTo("count");
assertThat(result.path("role").asText()).isEqualTo("tool");
assertThat(result.path("tool_call_id").asText()).isEqualTo("count");
assertThat(result.path("content").asText()).contains("count").doesNotStartWith("ERROR:");
}
}
finally
{
if(config.getRuntime() != null)
{
config.getRuntime().close();
}
provider.close();
QContext.clear();
}
}
}
}
@@ -28,9 +28,9 @@ import com.kingsrook.qqq.backend.core.utils.StringUtils;
** from the provider (no date suffix). Effort is sent explicitly on every
** request, because the models' defaults differ (Sonnet 5.5 defaults to high).
**
** Phase 1 uses only the main slot. Escalation (Opus) and the summary model
** (Haiku: titles, compaction) arrive in phase 2; they are configurable now
** so the admin policy shape is stable.
** With no effective profile, enabled escalation supplies the complex route's
** model and effort. A profile's routing mode takes precedence. The summary
** slot remains available for titles and compaction.
*******************************************************************************/
public class AssistantModelRouting implements Serializable
{
@@ -17,6 +17,10 @@
package com.kingsrook.qbits.assistant;
import javax.net.ssl.SSLContext;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
@@ -26,9 +30,13 @@ import java.util.Set;
import java.util.function.Function;
import java.util.regex.Pattern;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.kingsrook.qbits.assistant.classification.ClassificationSource;
import com.kingsrook.qbits.assistant.classification.ConfiguredClassificationSource;
import com.kingsrook.qbits.assistant.classification.DataClassification;
import com.kingsrook.qbits.assistant.engine.ModelPricing;
import com.kingsrook.qbits.assistant.provider.AssistantModelProvider;
import com.kingsrook.qbits.assistant.provider.AssistantProviderType;
import com.kingsrook.qbits.assistant.provider.TrustedCaBundle;
import com.kingsrook.qbits.assistant.uiapi.UiApiGateway;
import com.kingsrook.qqq.backend.core.actions.ai.AiExposure;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
@@ -69,6 +77,15 @@ public class AssistantQBitConfig implements QBitConfig
@Deprecated(since = "0.1.0-RC.3")
public static final String LEGACY_DEFAULT_OWNER_KEY_TYPE = "assistantUserId";
@JsonIgnore
private final transient Map<String, SSLContext> trustedCaBundles = new LinkedHashMap<>();
private final ConfiguredClassificationSource configuredClassifications = new ConfiguredClassificationSource();
private transient ClassificationSource classificationSource;
private Boolean hipaaMode = false;
private Integer hipaaRetentionDays = 2190;
private String conversationEncryptionKeyEnvName;
private Boolean enabled = true;
private String backendName;
private String providerName = DEFAULT_PROVIDER_NAME;
@@ -184,6 +201,10 @@ public class AssistantQBitConfig implements QBitConfig
requirePositive(errors, "maxTurnsPerUserPerMinute", maxTurnsPerUserPerMinute);
requirePositive(errors, "maxConcurrentTurnsPerUser", maxConcurrentTurnsPerUser);
requirePositive(errors, "conversationRetentionDays", conversationRetentionDays);
if(hipaaRetentionDays != null)
{
requirePositive(errors, "hipaaRetentionDays", hipaaRetentionDays);
}
requirePositive(errors, "toolResultRetentionDays", toolResultRetentionDays);
requirePositive(errors, "approvalRetentionDays", approvalRetentionDays);
requirePositive(errors, "killSwitchPollMillis", killSwitchPollMillis);
@@ -1364,6 +1385,7 @@ public class AssistantQBitConfig implements QBitConfig
}
/*******************************************************************************
** Register a provider type for the provider settings table.
*******************************************************************************/
@@ -1399,7 +1421,14 @@ public class AssistantQBitConfig implements QBitConfig
public Set<String> getEffectiveAllowedApiKeyEnvNames()
{
Set<String> names = new LinkedHashSet<>(allowedApiKeyEnvNames == null ? Set.of() : allowedApiKeyEnvNames);
providerTypes.values().forEach(t -> names.add(t.getDefaultApiKeyEnvName()));
providerTypes.values().forEach(t -> t.getKinds().forEach(k ->
{
String name = t.getDefaultApiKeyEnvName(k);
if(name != null)
{
names.add(name);
}
}));
return (names);
}
@@ -1580,4 +1609,183 @@ public class AssistantQBitConfig implements QBitConfig
return (this);
}
/*******************************************************************************
** Register server-only trust material, parsed eagerly without retaining PEM.
*******************************************************************************/
public AssistantQBitConfig withTrustedCaBundle(String name, String pem)
{
if(name == null || name.isBlank() || name.length() > 100 || !name.equals(name.trim()))
{
throw (new IllegalArgumentException("CA bundle name must be 1 to 100 characters without surrounding whitespace."));
}
trustedCaBundles.put(name, TrustedCaBundle.parse(pem));
return (this);
}
/*******************************************************************************
** Read the bundle at startup; no file content or path enters diagnostics.
*******************************************************************************/
public AssistantQBitConfig withTrustedCaBundleFile(String name, Path pemFile)
{
try
{
return (withTrustedCaBundle(name, Files.readString(pemFile)));
}
catch(IOException | SecurityException e)
{
throw (new IllegalArgumentException("Could not read the configured CA bundle file."));
}
}
/*******************************************************************************
** Server-only contexts; never expose trust material in metadata or JSON.
*******************************************************************************/
@JsonIgnore
public Map<String, SSLContext> getTrustedCaBundles()
{
return (Map.copyOf(trustedCaBundles));
}
/*******************************************************************************
** Getter for hipaaMode
*******************************************************************************/
public Boolean getHipaaMode()
{
return (hipaaMode);
}
/*******************************************************************************
** Setter for hipaaMode
*******************************************************************************/
public void setHipaaMode(Boolean hipaaMode)
{
this.hipaaMode = hipaaMode;
}
/*******************************************************************************
** Fluent setter for hipaaMode
*******************************************************************************/
public AssistantQBitConfig withHipaaMode(Boolean hipaaMode)
{
this.hipaaMode = hipaaMode;
return (this);
}
/*******************************************************************************
** Getter for hipaaRetentionDays
*******************************************************************************/
public Integer getHipaaRetentionDays()
{
return (hipaaRetentionDays);
}
/*******************************************************************************
** Setter for hipaaRetentionDays
*******************************************************************************/
public void setHipaaRetentionDays(Integer hipaaRetentionDays)
{
this.hipaaRetentionDays = hipaaRetentionDays;
}
/*******************************************************************************
** Fluent setter for hipaaRetentionDays
*******************************************************************************/
public AssistantQBitConfig withHipaaRetentionDays(Integer hipaaRetentionDays)
{
this.hipaaRetentionDays = hipaaRetentionDays;
return (this);
}
/*******************************************************************************
** Getter for conversationEncryptionKeyEnvName
*******************************************************************************/
public String getConversationEncryptionKeyEnvName()
{
return (conversationEncryptionKeyEnvName);
}
/*******************************************************************************
** Setter for conversationEncryptionKeyEnvName
*******************************************************************************/
public void setConversationEncryptionKeyEnvName(String conversationEncryptionKeyEnvName)
{
this.conversationEncryptionKeyEnvName = conversationEncryptionKeyEnvName;
}
/*******************************************************************************
** Fluent setter for conversationEncryptionKeyEnvName
*******************************************************************************/
public AssistantQBitConfig withConversationEncryptionKeyEnvName(String conversationEncryptionKeyEnvName)
{
this.conversationEncryptionKeyEnvName = conversationEncryptionKeyEnvName;
return (this);
}
/*******************************************************************************
** Use host classifications when supplied, otherwise the configured stand-in.
*******************************************************************************/
@JsonIgnore
public ClassificationSource getClassificationSource()
{
return (classificationSource == null ? configuredClassifications : classificationSource);
}
/*******************************************************************************
** Install a core-metadata adapter when the host supports it.
*******************************************************************************/
public AssistantQBitConfig withClassificationSource(ClassificationSource source)
{
classificationSource = source;
return (this);
}
/*******************************************************************************
** Classify a table until core classification metadata is available.
*******************************************************************************/
public AssistantQBitConfig withDataClassification(String tableName, DataClassification classification)
{
configuredClassifications.withClassification(tableName, classification);
return (this);
}
/*******************************************************************************
** Override the classification of one field.
*******************************************************************************/
public AssistantQBitConfig withDataClassification(String tableName, String fieldName, DataClassification classification)
{
configuredClassifications.withClassification(tableName, fieldName, classification);
return (this);
}
}
Loaded 100 of 189 files, more files were not shown because too many files have changed in this diff. Show more