创世纪基金会
API 文档
提供者不可知的人工智能配置和共享公用事业。 配置一次 app 靴子; 通过依赖性注射使用 .
Beta - 不用于生产
这个包在β. 不用于生产。 API表面和行为可能改变. 它只用于评价和发展.
支助提供者:
- 开放AI – 响应 API,通过您的服务器代理( P)
serverEndpoint或直接与apiKey在信任的背景中。 见 开放AI。 。 。 . - Chrome 内置AI - 快速API / 双子纳米( 无 API 键; Chrome 138+)
每个供应商都暴露出能力,例如: interpretCriteria (自然语言到结构化标准). 未来的能力(如汇总)会作为同一界面上的可选方法被添加.
地物旗帜
AI的特性是 默认禁用通过 URL 参数或环境变量启用它们 :
URL 参数 — 附录 ?feature.ai 到任何 URL( 用于不重建测试) :
https://your-app.com/?feature.ai
环境变量 设置 GENX_ENABLE_AI=true 在你的应用软件 .env 没有 URL 参数而永久启用的文件 :
GENX_ENABLE_AI=true
当国旗被关闭时:
createAIProvider()财务报告和审定财务报表getAIProvider()返回一个不开放提供者resolveAIConfig()返回时null- AI组件(例如:.
*-ai-criteria-search, (中文(简体) ),*-ai-indicator不提供
您可以在程序上检查旗帜 :
import { isAIFeatureEnabled, AI_FEATURE_FLAG } from '@genesislcap/foundation-ai';
if (isAIFeatureEnabled()) {
// AI features are enabled
}
安装
添加 @genesislcap/foundation-ai 作为依赖。 运行 npm run bootstrap 在改变依赖关系之后.
{
"dependencies": {
"@genesislcap/foundation-ai": "latest"
}
}
配置
1. 解析配置(Chrome-First或OpenAI)
使用 resolveAIConfig 更喜欢Chrome在可用时,以云提供商为倒置. 论云
配置它返回时没有端点, 所以添加您的代理 serverEndpoint 在创建提供者之前:
import { createAIProvider, resolveAIConfig, AIProvider } from '@genesislcap/foundation-ai';
const resolved = await resolveAIConfig({
provider: 'openai', // default model: gpt-6-luna
preferChrome: true,
});
const aiConfig =
resolved && 'providerType' in resolved && resolved.providerType === 'openai'
? { ...resolved, serverEndpoint: '/gwf/ai-service/api/openai/chat' }
: resolved;
2. DI的注册提供商
将提供者注册在 app 靴子(例如 main.ts:
import { Registration } from '@microsoft/fast-foundation';
this.container.register(
Registration.instance(AIProvider, createAIProvider(aiConfig)),
);
配置一次; 所有组件使用 getAIProvider() 接受同样的情况.
3. 组件用途
import { getAIProvider } from '@genesislcap/foundation-ai';
const aiProvider = getAIProvider();
if (aiProvider?.interpretCriteria) {
const result = await aiProvider.interpretCriteria(input, { fields: fieldMetadata });
}
开放AI
OpenAIAIConfig (单位:千美元)providerType: 'openai') 建立一个 OpenAIProvider 打开 OpenAITransport标准,
快速和聊天,在反应API上。 支持的模型是 SUPPORTED_OPENAI_MODEL_IDS; 默认为
gpt-6-luna。 。 。 .
- 服务器代理( 建议) : 设定
serverEndpoint到您的代理路线。 运输站 回复请求机构; 代理添加 API 密钥, 调用https://api.openai.com/v1/responses财务报告和审定财务报表 返回响应。 钥匙留在服务器上 。 没有默认终点 。 创世纪创建 ai- service 挂载一个在/api/openai/chat(在门后),/gwf/ai-service/api/openai/chat) (中文(简体) ). - 直接 : 设定
apiKey运输公司也叫OpenAI公司 只在信任的背景中使用, 因为 键在客户端.
没有 serverEndpoint 也没有 apiKey,一个请求抛出.
代理服务器发送错误代码
Anthropic、双子座和OpenAI 运输读取 code 从代理JSON的错误机构, { "code": "…", "error": "…" }, (中文(简体) ),
无论情况如何,你都要依此行事
NO_API_KEY, (中文(简体) ),BAD_API_KEY, (中文(简体) ),KEY_UNREADABLE, (中文(简体) ),MODEL_NOT_ALLOWED, (中文(简体) ),BAD_REQUEST, (中文(简体) ),FALLBACKS_NOT_SUPPORTED财务报告和审定财务报表REQUEST_TOO_LARGE是配置错误。 请求没有经过重审AIServiceError被抛出.VENDOR_UNREACHABLE重审了它的地位AIServiceError如果它仍然失败, 会被扔出.- 任何其他代码都按其状态处理,如前.
- 401或403携带创世纪路由器的NAK(
MESSAGE_TYPE: 'MSG_NACK',一个ERROR列表),或为空 机构,是应用程序的路由器,在代理运行前拒绝请求,没有会话,也没有 对 它会扔AIServiceError与SIGNED_OUT或者说ACCESS_DENIED从AI_SERVICE_ACCESS_REFUSALS, (中文(简体) ), 这些不是代理发送的代码。 任何其他无代号的401或403由它的状态处理. - 413个没有
code而空出或非JSON体是代理前的大小盖. 它会扔AIServiceError与REQUEST_TOO_LARGE,而且没有经过重审. AIServiceError.message持有的供应商,地位和代码。 代理是属于自己的error文本打开detail,并登录到控制台.
AI_SERVICE_ERROR_CODES 列出他们 DEFAULT_AI_SERVICE_ERROR_MESSAGES 拥有助理告诉用户的内容
每一个。 这个 error 文本只用于控制台。 一个代理应该使用这些常数而不是重复它们.
手动选择提供者
强迫特定提供者而不是使用 resolveAIConfig数字 :
// OpenAI through your server proxy
Registration.instance(AIProvider, createAIProvider({
providerType: 'openai',
model: 'gpt-6-luna',
serverEndpoint: '/gwf/ai-service/api/openai/chat',
}));
// Chrome only (when available)
Registration.instance(AIProvider, createAIProvider({
providerType: 'chrome',
}));
Chrome内置AI(Prompt API /双子座纳诺)
Chrome供应商使用 提示 API 与双子座纳诺. 它运行在设备上;没有API密钥,也没有数据发送到外部服务.
生产(部署的应用程序)
Chrome 内置的AI 在一个 原产地审判。对于生产领域,用户有 没有 需要启用任何旗帜 :
- 滚动您的域 在快速API原产地审判中.
- 在您的应用程序中添加原产地试验符( meta tag 或头) .
- 当您的应用程序调用时, 模型下载被触发
LanguageModel.create()从用户手势(例如AI指示"安装模型"按钮).
地方发展(当地东道主)
用于测试 localhost,启用这些克罗姆旗帜:
chrome://flags/#optimization-guide-on-device-model→ 已启用chrome://flags/#prompt-api-for-gemini-nano→ 已启用
更换旗后重启克罗姆.
硬件和系统要求
- 操作员: Windows 10/11, macOS 13+, Linux, 或 ChromeOS (Chromebook Plus) (中文(简体) )
- 存储 : 至少22GB免费(用于模型下载)
- GPU : (韩语) >4 GB VRAM,或 CPU : (中文(简体) ) 16GB 内存和4+ 核心
- 网络 : 仅用于初始模型下载的未计量连接; 推断运行离线
见 Chrome 的快速 API 文件 满足全部需求.
语音对文本
软件包包括用于语音输入的Web Speech API工具:
import { isSpeechRecognitionAvailable, startSpeechRecognition } from '@genesislcap/foundation-ai';
if (isSpeechRecognitionAvailable()) {
const stop = startSpeechRecognition(
(transcript, isFinal) => { /* handle transcript */ },
() => { /* on error */ },
);
// Call stop() to end recording
}
许可证
该项目提供前端依赖性,并使用特许部件。 开发期间需要许可证。 联系人 创世纪全球 详细情况.
许可组件
创世纪低码平台