目录

Developers

接入 Application

Application 适配器是一个小型 manifest,声明桌面应用如何连接到 Bricoop、接受哪些模型,以及 Bricoop 如何检测和配置它。一个 manifest 就能覆盖每一个受支持的 Provider,所以你只需发布一次,每个已连接的 Provider 就都能被该 Application 使用。适配器绝不嵌入 Provider 凭据或 Provider 专属逻辑;它只描述连接中属于 Application 的那一侧。

适配器做什么

适配器告诉 Bricoop 应用把配置存在哪里、用户可以映射哪些模型槽位,以及 Application 期望使用哪些能力。Bricoop 读取 manifest,在用户启用某个 Provider 时修补应用的本地配置文件,并通过本地连接层路由请求。应用仍然像以往一样工作;Bricoop 只把 Provider 端点写进 manifest 声明的槽位里。

开始之前

确认你拥有应用稳定的 lowercase id、它所需的 Bricoop Desktop minimal_client_version、它暴露的模型槽位,以及它写入的 config 路径。你还需要 Application 的 schema_version 和 minimal_application_version,以便 Bricoop 能明确拒绝不兼容的组合。manifest 准备好后,前往 Application manifest 参考。

编写 manifest

把 manifest 写成单个 YAML 文件,声明 id、name、version、schema_version、minimal_client_version、minimal_application_version、model_slots 和 configs。configs 条目告诉 Bricoop 如何在 macOS、Linux 和 Windows 上定位并修补应用的 config。完整的字段参考和完整示例见 Application manifest 页面。

本地测试

运行 Bricoop Desktop,把它指向你的本地 manifest,并确认应用被检测到。启用一个 Provider,通过应用做一次请求往返,并确认响应无错误返回。如果检测失败,请重新检查各平台的 configs[].path 值。

提交拉取请求

当 manifest 在本地可用时,按照 registry 贡献指南 向 bricoop-releases 提交一个可审查的拉取请求。仓库的校验会在 PR 合并前运行,所以在请求审查前修复每一个报告的问题。PR 合并后会发布一个 release manifest,Bricoop Desktop 会自动获取它。若要改为构建 Provider 适配器,请参阅 Provider 总览。

版本: sha256:4e6e6e9b7012905bda860679dafb7e34459289380d801ec69690fd5be7189886 编辑此页