跳转到主要内容

​
使用 Node.js SDK 运行

当你想从 Node.js 或 TypeScript 调用提示词部署时，请使用官方的 @fetch-hive/sdk 包。SDK 用类型化的客户端包装了公共的 POST /v1/prompt/invoke 端点，处理身份验证，并将流式响应作为 AsyncIterable 公开。

​
安装

npm install @fetch-hive/sdk
# or
yarn add @fetch-hive/sdk
# or
pnpm add @fetch-hive/sdk
该 SDK 针对 Node.js 18+（使用全局 fetch），并开箱即用地附带 TypeScript 类型定义。

​
身份验证

将 FETCH_HIVE_API_KEY 环境变量设置为你的工作区 API 密钥： 
export FETCH_HIVE_API_KEY=fhk_...

import { FetchHive } from '@fetch-hive/sdk';

const client = new FetchHive();
或显式传入密钥： 
const client = new FetchHive({ apiKey: 'fhk_...' });
有关如何创建和轮换密钥，请参阅 API 密钥。

​
基本示例

调用提示词部署并读取最终响应： 
import { FetchHive } from '@fetch-hive/sdk';

const client = new FetchHive();

const result = await client.invokePrompt({
  deployment: 'YOUR_DEPLOYMENT_NAME',
  variant: 'YOUR_VARIANT_NAME',
  inputs: { text: 'Fetch Hive helps teams ship AI products faster.' },
});

console.log(result.response);
invokePrompt 返回一个 Promise，在提示词完成后解析为已解析的 JSON 主体。请参阅 非流式响应结构。

​
方法参考

字段类型必填描述
deploymentstring是提示词部署名称
variantstring否部署变体名称
inputsRecord<string, unknown>否提示词变量的键值对
userstring否在 用户跟踪 中显示的不透明调用方标识符
metadataRecord<string, string | number | boolean | null>否调用方定义的扁平元数据，用于审计和日志过滤。请参阅 调用元数据
SDK 会为 invokePrompt 注入 streaming: false。要使用流式，请使用下面的 invokePromptStream。

​
处理响应

const result = await client.invokePrompt({
  deployment: 'my-prompt',
  variant: 'default',
});

console.log(result.response);     // final text
console.log(result.model);        // model identifier
console.log(result.usage);        // token usage breakdown
console.log(result.request_id);   // use this to look up the run in Logs

​
流式响应

使用 invokePromptStream 在到达时接收 Server-Sent Events。该方法返回一个可使用 for await 消费的 AsyncIterable： 
for await (const chunk of client.invokePromptStream({
  deployment: 'YOUR_DEPLOYMENT_NAME',
  variant: 'YOUR_VARIANT_NAME',
  inputs: { text: 'Fetch Hive helps teams ship AI products faster.' },
})) {
  if (chunk.type === 'response') {
    process.stdout.write(chunk.response ?? '');
  } else if (chunk.type === 'usage') {
    console.log('\n\nUsage:', chunk.usage);
  }
}
该流会产生 调用提示词 → 响应 中记录的相同事件类型：reasoning、response、最终的 usage 事件，或在提供商在流中失败时产生的 error 事件。

​
配置

选项默认值描述
apiKeyprocess.env.FETCH_HIVE_API_KEY来自仪表板的 Bearer 令牌
baseURLhttps://api.fetchhive.com/v1覆盖 API 基础 URL
const client = new FetchHive({
  apiKey: 'fhk_...',
  baseURL: 'https://api.fetchhive.com/v1',
});

​
错误

非 2xx 响应会抛出一个 Error，其消息包含状态码和响应体： 
try {
  const result = await client.invokePrompt({
    deployment: 'my-prompt',
    variant: 'default',
  });
} catch (err) {
  console.error('Fetch Hive error:', err);
}
有关状态码含义，请参阅 错误与速率限制。

​
链接

​
后续步骤