Skip to content

docs(ai-gateway): document TypeSafe structured evaluations - #297

Merged
yardend-wix merged 5 commits into
mainfrom
docs/ai-gateway-videos-and-evaluations
Oct 4, 2026
Merged

yardend-wix merged 5 commits into
mainfrom
docs/ai-gateway-videos-and-evaluations

Conversation

@yardend-wix

@yardend-wix yardend-wix commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

JSDoc-only change to AiGatewayModule. No runtime or type changes.

  • Structured evaluations. feat(ai-gateway): add TypeSafe connection provider #288 added connection({ provider: "typesafe" }) with a single intro sentence, so the published page names the provider without saying what it does or how to call it. This PR replaces that sentence with a Structured evaluations section and an example that shows the answer shape, where to find confidence, and a threshold applied in code. The section covers:
    • the jev model, and that the gateway rejects "jev-latest", which the package README uses
    • experimental_evaluate, which needs ai 7.0.105 or later
    • the three question types and their answer shapes
  • Authentication modes. The section from docs(ai-gateway): publish AI Gateway module reference #231 said there's no permission difference between modes. That's wrong for most new apps: they're created with Core integrations restricted, and public apps then reject user-token gateway calls with 403 (core_integration_policy.py in apper), while service-role calls from a backend function always pass. The original wording is kept; only that sentence and the service-role bullet change. Every example connects with base44.asServiceRole.aiGateway, matching the gateway's Builder capability guides; agent tools still run through base44.entities in the caller's scope.

Video isn't covered on purpose. The video API is open to all apps, but it isn't documented on the public site yet.

Docs

npm run create-docs renders the new Structured evaluations subsection and the example on interfaces/ai-gateway.mdx. The page on docs.base44.com updates on the next push-docs to mintlify-docs.

Checks

  • Examples executed end to end as deployed backend functions on a production test app: service-role connection, user-scope 403, chat with a tool loop and streaming, Jev evaluate.

  • eslint, npm run test:types, vitest run tests/unit/ai-gateway.test.ts

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.52-pr.297.e5cedd8

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.52-pr.297.e5cedd8"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.52-pr.297.e5cedd8"
  }
}

Preview published to npm registry — try new features instantly!

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@yardend-wix yardend-wix changed the title docs(ai-gateway): document videos and TypeSafe structured evaluations docs(ai-gateway): document TypeSafe structured evaluations and service-role use Sep 29, 2026
yardend-wix and others added 2 commits September 29, 2026 16:56
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…permission claim

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@yardend-wix yardend-wix changed the title docs(ai-gateway): document TypeSafe structured evaluations and service-role use docs(ai-gateway): document TypeSafe structured evaluations Oct 4, 2026
@yardend-wix
yardend-wix merged commit 3491a07 into main Oct 4, 2026
6 checks passed
@yardend-wix
yardend-wix deleted the docs/ai-gateway-videos-and-evaluations branch October 4, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-draft PR has auto-drafted documentation suggestions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants