Skip to content

Glossary

Look up the stable public terms used across the Nexus documentation and API.

Updated View as Markdown
Audience: platform-developerPlane: noneAuth: noneStatus: beta

Access and identity

Term Meaning
Better Auth User Nexus 的统一身份记录,可分别通过 Member 或 WorkspaceAccess 获得不同平面的能力。
Organization Member User 在 Organization 中的控制面关系,用于 Console 和 Admin API 权限。
WorkspaceAccess User 在一个 Workspace 的数据面使用权,包含状态、Plan 和 Access 有效期。
externalUserId 应用在 Workspace 内提供的幂等用户标识;与 workspaceId 组成唯一业务键。
ApiKeyBinding 将 Better Auth Inference API Key 绑定到一条 WorkspaceAccess 的数据库事实。

Credentials

Term Meaning
Provider Secret Provider 签发、由平台开发者接入并在 ProviderConnection 中加密保存的上游凭证。
Management Key 应用后端调用 Admin API 的长期凭证,只进入 Admin Plane。
Inference Key 应用用户或可信 User Agent 调用 Gateway 的凭证,只进入 Data Plane。

Provider capacity

Term Meaning
Workspace Provider、Plan、Access、Quota、Usage 与 Audit 的配置和隔离边界。
ProviderConnection Workspace 内一条明确的上游能力连接。
providerConnectionId ProviderConnection 的服务生成、不可变 UUID;它出现在 Gateway Base URL 中。
Protocol Profile Provider Transport 和 Usage Inspector 使用的兼容性配置,不是模型转换规则。
Usage Inspector 判断某类 Provider 请求能否估算和提取 Usage 的独立扩展点。

Plans and quota

Term Meaning
WorkspacePlan Access 绑定的稳定产品套餐,例如 Free 或 Pro。
PlanStrategy Workspace 拥有、可发布和版本化的类型化策略。
PlanStrategyBinding 某个 Plan 在一个生效区间内启用某个 Strategy 版本的关系。
QuotaStrategy 定义周期 Units、Token 倍率、重置周期和最大输出上限的策略。
Quota Unit 非货币的 AI 使用权单位,由 Token Usage 和套餐倍率计算。
QuotaPeriod WorkspaceAccess 在一个周期内的额度与策略快照。
QuotaReservation Provider 调用前创建的并发安全额度预留。
UsageEvent 一次结算或调整产生的不可变 Usage 事实。
Available Units grantedUnits - consumedUnits - reservedUnits

Request lifecycle

Term Meaning
Invocation 一次进入 Gateway 的调用,可关联 User、Access、Connection、Reservation 和 Usage。
Reserve 在调用 Provider 前原子占用预估 Units。
Settle 使用实际 Usage 把 Reservation 转换成 Consumed Units。
Release 没有可计量交付时归还 Reserved Units。
Request ID 跨 Gateway、Usage 与 Audit 关联一次请求的稳定诊断标识。
Navigation

Type to search…

↑↓ navigate↵ selectEsc close