> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchhive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 使用 Ruby SDK 运行

> 使用 fetch_hive gem 从 Ruby 调用提示词部署

# 使用 Ruby SDK 运行

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

## 安装

添加到你的 `Gemfile`：

```ruby theme={null}
gem "fetch_hive"
```

然后运行：

```bash theme={null}
bundle install
```

或直接安装：

```bash theme={null}
gem install fetch_hive
```

该 gem 底层使用 `faraday`，支持 Ruby 3.0+。

## 身份验证

将 `FETCH_HIVE_API_KEY` 环境变量设置为你的工作区 API 密钥（客户端会自动读取它）：

```bash theme={null}
export FETCH_HIVE_API_KEY=fhk_...
```

```ruby theme={null}
require "fetch_hive"

client = FetchHive::Client.new
```

或显式传入密钥：

```ruby theme={null}
client = FetchHive::Client.new(api_key: "fhk_...")
```

有关如何创建和轮换密钥，请参阅 [API 密钥](../workspace/api-keys)。

## 基本示例

调用提示词部署并读取最终响应：

```ruby theme={null}
require "fetch_hive"

client = FetchHive::Client.new

result = client.invoke_prompt(
  deployment: "YOUR_DEPLOYMENT_NAME",
  variant: "YOUR_VARIANT_NAME",
  inputs: { text: "Fetch Hive helps teams ship AI products faster." }
)

puts result["response"]
```

`invoke_prompt` 会阻塞直到提示词完成，并将已解析的 JSON 主体作为哈希返回。请参阅 [非流式响应结构](../api-reference/prompts/invoke#response)。

## 方法参考

| 关键字参数        | 类型       | 必填 | 描述                                                                  |
| ------------ | -------- | -- | ------------------------------------------------------------------- |
| `deployment` | `String` | 是  | 提示词部署名称                                                             |
| `variant`    | `String` | 否  | 部署变体名称                                                              |
| `inputs`     | `Hash`   | 否  | 提示词变量的键值对                                                           |
| `user`       | `String` | 否  | 在 [用户跟踪](../user-tracking/overview) 中显示的不透明调用方标识符                   |
| `metadata`   | `Hash`   | 否  | 调用方定义的扁平元数据，用于审计和日志过滤。请参阅 [调用元数据](../user-tracking/invoke-metadata) |

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

## 处理响应

```ruby theme={null}
result = client.invoke_prompt(deployment: "my-prompt", variant: "default")

puts result["response"]      # final text
puts result["model"]         # model identifier
puts result["usage"]         # token usage breakdown
puts result["request_id"]    # use this to look up the run in Logs
```

## 流式响应

使用 `invoke_prompt_stream` 在到达时接收 Server-Sent Events。该方法将每个已解析的事件哈希产出给块：

```ruby theme={null}
client.invoke_prompt_stream(
  deployment: "YOUR_DEPLOYMENT_NAME",
  variant: "YOUR_VARIANT_NAME",
  inputs: { text: "Fetch Hive helps teams ship AI products faster." }
) do |chunk|
  case chunk["type"]
  when "response"
    print chunk["response"]
    $stdout.flush
  when "usage"
    puts "\n\nUsage: #{chunk['usage']}"
  end
end
```

该流会产生 [调用提示词 → 响应](../api-reference/prompts/invoke#response) 中记录的相同事件类型：`reasoning`、`response`、最终的 `usage` 事件，或在提供商在流中失败时产生的 `error` 事件。

如果你省略块，该方法返回一个可以传递的 `Enumerator`：

```ruby theme={null}
enum = client.invoke_prompt_stream(deployment: "my-prompt", variant: "default")
enum.each { |chunk| handle(chunk) }
```

## 配置

| 选项         | 默认值                            | 描述               |
| ---------- | ------------------------------ | ---------------- |
| `api_key`  | `ENV["FETCH_HIVE_API_KEY"]`    | 来自仪表板的 Bearer 令牌 |
| `base_url` | `https://api.fetchhive.com/v1` | 覆盖 API 基础 URL    |
| `timeout`  | `120`                          | 请求超时（秒）          |

```ruby theme={null}
client = FetchHive::Client.new(
  api_key: "fhk_...",
  base_url: "https://api.fetchhive.com/v1",
  timeout: 60
)
```

## 错误

非 2xx 响应会引发 `RuntimeError`，其中包含状态码和响应体。如需处理失败，请捕获异常：

```ruby theme={null}
begin
  result = client.invoke_prompt(deployment: "my-prompt", variant: "default")
rescue => e
  warn "Fetch Hive error: #{e.message}"
end
```

有关状态码含义，请参阅 [错误与速率限制](../api-reference/errors-and-rate-limits)。

## 链接

* [RubyGems 上的 gem](https://rubygems.org/gems/fetch_hive)
* [GitHub 上的源码](https://github.com/Fetch-Hive/ruby-sdk)

## 后续步骤

* [使用 API 运行](./run-with-api) - 使用 cURL 的相同流程
* [使用 Python SDK 运行](./run-with-python-sdk)
* [使用 Node.js SDK 运行](./run-with-nodejs-sdk)
* [使用 PHP SDK 运行](./run-with-php-sdk)
* [调用提示词](../api-reference/prompts/invoke) - 完整端点参考