> ## 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 包装了公共的 [`POST /v1/workflow/invoke`](../api-reference/workflows/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

run = client.invoke_workflow(
  deployment: "YOUR_DEPLOYMENT_NAME",
  variant: "YOUR_VARIANT_NAME",
  inputs: { topic: "State of enterprise AI in 2026" }
)

puts run["run_status"]
puts run["output"]
```

请参阅 [直接响应结构](../api-reference/workflows/invoke#response)。

## 方法参考

| 关键字参数          | 类型        | 必填 | 描述                                                                  |
| -------------- | --------- | -- | ------------------------------------------------------------------- |
| `deployment`   | `String`  | 是  | 工作流部署名称                                                             |
| `variant`      | `String`  | 否  | 部署变体名称                                                              |
| `inputs`       | `Hash`    | 否  | **Start** 步骤定义的变量的键值对                                               |
| `async_mode`   | `Boolean` | 否  | 当为 `true` 时，立即返回，并通过签名回调投递结果                                        |
| `callback_url` | `String`  | 否  | 当 `async_mode: true` 时必填 - 运行完成时调用的 HTTPS 回调 URL                    |
| `user`         | `String`  | 否  | 在 [用户跟踪](../user-tracking/overview) 中显示的不透明调用方标识符                   |
| `metadata`     | `Hash`    | 否  | 调用方定义的扁平元数据，用于审计和日志过滤。请参阅 [调用元数据](../user-tracking/invoke-metadata) |

`invoke_workflow` 会为你构建请求体。当你传入 `async_mode: true` 时，SDK 会发送：

```json theme={null}
{
  "async": { "enabled": true, "callback_url": "https://example.com/webhook" }
}
```

## 处理响应

```ruby theme={null}
run = client.invoke_workflow(deployment: "my-workflow", variant: "default")

puts run["run_status"]    # "completed" | "failed" | "running" | "queued"
puts run["output"]        # final workflow output
puts run["request_id"]    # use this to look up the run in Logs
```

## 回调投递

传入 `async_mode: true` 以立即返回，并让 Fetch Hive 在运行完成时调用你的回调 URL：

```ruby theme={null}
run = client.invoke_workflow(
  deployment: "YOUR_DEPLOYMENT_NAME",
  variant: "YOUR_VARIANT_NAME",
  inputs: { topic: "State of enterprise AI in 2026" },
  async_mode: true,
  callback_url: "https://example.com/callback"
)

puts "Queued: #{run['run_status']}"
puts "Webhook secret: #{run['webhook_secret']}"
```

请保存 `webhook_secret`，以便你能验证传入回调的签名。请参阅 [回调投递与 Webhook 触发](./async-and-webhooks) 了解验证流程和签名负载结构。

## 配置

| 选项         | 默认值                            | 描述                            |
| ---------- | ------------------------------ | ----------------------------- |
| `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: 600
)
```

## 错误

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

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

有关工作流特有的失败案例，请参阅 [错误处理](./error-handling)；有关 HTTP 状态码含义，请参阅 [错误与速率限制](../api-reference/errors-and-rate-limits)。

## 链接

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

## 后续步骤

* [回调投递与 Webhook 触发](./async-and-webhooks) - 验证回调签名
* [使用 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/workflows/invoke) - 完整端点参考