@aio- proxy/ plugin- sdk
与提供商和OAuth插件公司签订延长Aio-prooxy的公共合同.
运行时间兼容性
插件运行时间钩在 aio- proxy Bun 主机内执行 。 阿宝 >=1.4.0 v1 运行时兼容性
目标。 插件作者可能使用以节点为基础的工具进行开发和类型检查,但在节点下执行
或 undici 不属于 v1 兼容承诺 .
已经用这台机器上的签名
OAuth 适配器可以声明 localSignIn?: OAuthLocalSignIn<AccountOptions, Credential> 提供供应商
工具已存在的本地登录,以替代其浏览器 OAuth 流量. source 是一个 LocalizedText
工具的标签,例如 Codex。该能力是可选的;现有的适配器保持其浏览器的流动.
detect(context: OAuthLocalSignInContext)返回时Promise<boolean>并检查存在。 它必须 从不解析主机商店,读取秘密,或返回账户细节. 上下文仅包含signal。 。 。 .read(context: OAuthCredentialImportContext, options: AccountOptions)返回时Promise<OAuthLoginResult<Credential>>。只有在用户明确同意后才能读取主机商店 账户。 上下文供应progress, (中文(简体) ),signal,可选fetch如证书进口一样.write?(context: OAuthLocalSignInContext, next: Credential, previous: Credential)返回时Promise<void>。 。 。 . 仅用于刷新令牌旋转的商店执行; 仅需要一次性的商店省略 证书副本.
对于适配器 write,相同的主机存储内容必须产生来自
read:这个框架比较了读取之间 canonical creditic cluises. 不合成证书
字段,或生成每个读取的随机值.
在原子取代之前, write 必须重新检查主机仍然持有 previous,包括
同样的账户和刷新代号。 如果更改, 则不写就返回 。 完成回写即使
信号在旋转消耗了符号后被中止。 删除提供商从不打电话 write 或更改
店主的店铺 将主机证书保存出日志,痕迹,诊断,出错,以及API响应.
目录模型元数据
ModelDescriptor.modelMetadata 输入模式信息,主机可以合并到上游
元数据层。 内容 DescriptorModelMetadata 类型是已发布的子集 @aio-proxy/types
ModelMetadataInput数字 : name, (中文(简体) ), description, (中文(简体) ), limit, (中文(简体) ), capabilities,以及 cost。 。 。 . extend 仍然是用户配置
特性,而插件无法使用。 未知密钥被剥离; 无效 modelMetadata 数值被删除
因此,其他描述和目录仍然可用.
import type { ModelCatalog } from '@aio-proxy/plugin-sdk';
const catalog: ModelCatalog = {
language: [
{
id: 'upstream-model-id',
displayName: 'Upstream Model',
modelMetadata: {
limit: { context: 200_000, output: 32_000 },
capabilities: { reasoning: true, toolCall: true },
cost: { input: 1, output: 4 },
},
extra: { wireFamily: 'example-v2' },
},
],
image: [],
video: [], // Optional; served by a plugin raw resolver for openai-video.
embedding: [],
speech: [],
transcription: [],
reranking: [],
extra: { catalogRevision: 2 },
};
extra 是不透明的,插件- 私人 JSON 数据。 它取代了以前的免费形式 metadata 打开
ModelDescriptor 财务报告和审定财务报表 ModelCatalog,现在提供原始解析器输入 extra 改为 metadata。 。 。 .
使用 modelMetadata 仅针对主机消费模型元数据以及 extra 用于线条提示或其他插件状态.