CLI を使い始める

runs batches

orc run は orc runs batches create の短縮形で、複数のプロンプト実行requestを非同期バッチとして作成します。引数、flag、本文、非同期動作は同じです。1〜10,000件の requests を指定し、各 custom_id はバッチ内で一意にします。

異なるプロンプトやチャネルは別requestにします。作成の受理は計測の完了を意味しません。返されたbatch IDで orc runs のstatusと結果を確認します。

使い方

terminal
orc run --stdin < batch.json

JSONのrequestをバッチとして送信します。

サブコマンド

create

実行期限は作成時から既定24時間で、--completion-window 48h にすると長い期限を選べます。期限切れ数はexpiredになったrequest数であり、成功数ではありません。

terminal
orc runs batches create [options]

固有のオプション

--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc runs batches create --idempotency-key <value>
--requests

(required) One to 10,000 execution requests. Every custom_id must be unique within this batch. Use separate requests for different prompts or channels.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc runs batches create --requests <value>
--metadata

Optional client metadata stored with the batch. Omit or use null for no supplied metadata.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)

型: string。任意。

terminal
orc runs batches create --metadata <value>
--completion-window

Requested execution window, starting at creation. Defaults to 24h; 48h allows a longer deadline. The expiry count reports requests marked expired, not successful completion.; enum: 24h|48h

型: string。任意。

terminal
orc runs batches create --completion-window <value>

使用例

バッチの入力を用意します。

batch.json
{
  "requests": [
    {
      "custom_id": "measurement-1",
      "params": {
        "prompt_id": "<prompt-id>",
        "model_channel_id": "chatgpt-ui"
      }
    }
  ],
  "completion_window": "24h"
}

バッチの入力を用意します。

完了を待ちます。

terminal
orc run --stdin < batch.json --wait --timeout 5m

完了を待ちます。

再試行

再試行には同じmethod・path・query・正確な本文と --idempotency-key を使います。keyはtrim後1〜255文字で24時間保持します。本文のJSON空白変更も別の本文になり得ます。完了応答は再実行せず返し、異なるrequestとの再利用は 409 idempotency_error、処理中は 409 idempotency_in_progress と Retry-After: 2 を返します。

必要な権限

認証し、対象Workspaceを選択して実行します。対象Workspaceへのアクセスが必要です。

グローバルオプション

orc runs batches では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。