Skip to main content

使用 Ruby SDK 运行

当你想从 Ruby 调用提示词部署时,请使用官方的 fetch_hive gem。SDK 使用符合 Ruby 风格的辅助方法包装了公共的 POST /v1/prompt/invoke 端点,处理身份验证,并将流式响应解析为产出的哈希。

安装

添加到你的 Gemfile
然后运行:
或直接安装:
该 gem 底层使用 faraday,支持 Ruby 3.0+。

身份验证

FETCH_HIVE_API_KEY 环境变量设置为你的工作区 API 密钥(客户端会自动读取它):
或显式传入密钥:
有关如何创建和轮换密钥,请参阅 API 密钥

基本示例

调用提示词部署并读取最终响应:
invoke_prompt 会阻塞直到提示词完成,并将已解析的 JSON 主体作为哈希返回。请参阅 非流式响应结构

方法参考

SDK 会为 invoke_prompt 注入 streaming: false。要使用流式,请使用下面的 invoke_prompt_stream

处理响应

流式响应

使用 invoke_prompt_stream 在到达时接收 Server-Sent Events。该方法将每个已解析的事件哈希产出给块:
该流会产生 调用提示词 → 响应 中记录的相同事件类型:reasoningresponse、最终的 usage 事件,或在提供商在流中失败时产生的 error 事件。 如果你省略块,该方法返回一个可以传递的 Enumerator

配置

错误

非 2xx 响应会引发 RuntimeError,其中包含状态码和响应体。如需处理失败,请捕获异常:
有关状态码含义,请参阅 错误与速率限制

链接

后续步骤