跳转到内容

身份

aidy 没有自己的用户数据库。每次请求时,它都通过目录中唯一的 role: identity 操作询问宿主:调用者是谁。

"/api/me": {
"get": {
"x-aidy": { "name": "whoami", "role": "identity" }
}
}

身份操作是无参数、效果为 read 的 GET,每个目录恰好一个。和所有角色操作一样,它没有入口,也从不提供给模型。

{
"subject": "u_123",
"tenant": "t_9",
"name": "Ada Lovelace",
"locale": "zh-CN",
"scopes": ["aidy:admin"]
}
字段 含义
subject 必填。用户在你产品中的稳定 id。
tenant 凭据所在的组织、工作区或账户(如果产品有这个概念)。
name 用户的显示名。
locale BCP 47 语言标签,例如 en 或 zh-CN。
scopes aidy 的 scope。目前只定义了 aidy:admin。

在 Python 中,返回 kit 提供的 Identity 模型:

from aidy import Identity, op
@app.get("/api/me", openapi_extra=op("whoami", role="identity"))
async def whoami(request: Request) -> Identity:
user = current_user(request)
return Identity(subject=user.id, tenant=user.tenant_id, name=user.name, locale="zh-CN")
  1. 请求带着用户的 Authorization 头、Cookie 头或两者到达 aidy。两者都没有时,aidy 返回 401。
  2. aidy 用完全相同的头调用身份操作。这是一次普通请求,不带 Aidy-Assertion。
  3. 宿主返回 401 或 403 时,aidy 返回 401。其他不是合法身份的响应都视为错误。
  4. 身份按凭据哈希缓存 60 秒,一连串请求只会触发一次身份调用。

凭据本身只在请求或运行期间保存在内存中,从不持久化。

会话。 一个会话属于一个 (subject, tenant)。同一用户在两个租户下有两份独立的历史,其他人无法列出、读取、恢复或删除它们。

调用。 aidy 的每次调用都在断言中带有 sub 和 ten claim,宿主用同一凭据解析出的身份来核对它们(见委托)。

设置与反馈。 GET /aidy/v0/settings 读取当前的模型链;PUT 和 DELETE 需要 aidy:admin scope,否则返回 403;GET /aidy/v0/feedback 也是如此,它列出管理员所在租户各会话的评价。设置只包含模型链,知识库在代码中配置。@aidy-dev/react 的 ModelSettings 组件就是对应的管理表单。

按用户配置。 接受函数的运行时选项会收到身份,例如 instructions(也可以是异步函数)和知识库集合:

createAidy({
// ...
instructions: (identity) => `The user's tenant is ${identity.tenant}. Answer in ${identity.locale ?? 'en'}.`,
sources: [knowledge.source({ collections: (identity) => ['docs', `manuals/${identity.tenant}`] })],
});

aidy 同样用调用者的凭据拉取 OpenAPI 文档,所以不同用户的目录可以不同。对无权调用某个操作的用户隐藏它,agent、MCP 客户端和 CLI 就不会向他们提供这个操作。无论如何,你的 API 仍会对每次调用做鉴权。