コンテンツへスキップ
JA
APIキーを取得する
ドキュメントを探す

はじめに

FlashData CLI で自動化

リクエストを検証し、スクリプトから実行し、別の結果とエラーのレシートを読み込みます。

このページの内容

1. 既存のプロファイルを選択

インストールしたCLI、Bash、jqを使用してください。 Windows では、Git Bash でシェル例を実行します。 このウォークスルーは、認証された研究プロファイルを使用して、そのプロファイルが保存される絶対ディレクトリにFLASHDATA_STATE_DIRを設定します。

すべてのコマンドで同じ OS ユーザとステートディレクトリを使用します。 FLASHDATA_API_KEYは保存されたキーを上書きします;プロフィールを使用するためにそれをunset残して下さい。 CLI は .env ファイルをロードしません。

保存されたアクセスをチェックする
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

デフォルトの状態の場所

カスタムの場所を選択した場合は、元の--state-dirを使用してください。 auth statusは、data.accessVerified: trueを報告する必要があります。 無人展開のため、その秘密ストアからstdinを介して所有者キーをインポートします。

OSの特長ディレクトリ
Windows%APPDATA%/FlashData
macOS~/Library/Application Support/FlashData
Linux$XDG_STATE_HOME/flashdata または ~/.local/state/flashdata

2. リクエストと価格の検証

request.json を保存し、同じディレクトリに無料のチェックを実行します。 フィルターは、ソース価格が利用可能で、残高が1つのクエリをカバーする場合にのみ、trueを印刷します。 ゼロの出口を止めて下さい。 価格チェックはクレジットを予約しません。

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Bash + jq · 有料の提出なし
set -euo pipefail
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata account balance --profile research --state-dir "$FLASHDATA_STATE_DIR" \
  --json --non-interactive > balance.json
flashdata query --input request.json --dry-run --run-id cli-research-001 \
  --profile research --state-dir "$FLASHDATA_STATE_DIR" \
  --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
  .ok and .data.dryRun and .data.estimateAvailable
  and ($balance[0].ok == true)
  and any(.data.estimate.prices[]?;
    .source == "google_search" and .available == true
    and (.estimatedCredits | type == "number")
    and ($balance[0].data.availableCredits | type == "number")
    and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json

3. 実行して領収書を読みます

チェックパスの後、run-search.shを保存し、bash run-search.shを実行します。 最初の成功した実行は、1つの検索を提出します。 それぞれの試みは、新しい cli-run ディレクトリーに保存されます。 ID は、CLI が同じアカウント、プロファイル、ステートディレクトリーの初期の成功を再利用できるようにします。

run-search.sh
#!/usr/bin/env bash
set -euo pipefail
umask 077
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
dir=$(mktemp -d "cli-run.XXXXXX")
if ! flashdata query --input request.json --run-id cli-research-001 \
  --profile research --state-dir "$FLASHDATA_STATE_DIR" \
  --output "$dir/result.json" --timeout 2m --json --non-interactive \
  > "$dir/receipt.json" 2> "$dir/error.json"; then
  cat "$dir/error.json" >&2
  printf 'Inspect saved run cli-research-001; receipts: %s\n' "$dir" >&2
  exit 1
fi
jq -e '.schemaVersion == 1 and .ok == true' "$dir/receipt.json" >/dev/null
jq -e '.status == "done" and .source == "google_search"' "$dir/result.json" >/dev/null
jq -r '.results[]?.organic[]? | [.title, .link] | @tsv' "$dir/result.json"
jq '{runId, cached, usage}' "$dir/receipt.json"
printf 'Files: %s\n' "$dir"

どのファイルを読むかを知る

CLIの封筒とソースの応答は異なるJSON文書です。 --outputがなければ、ソース応答はデータにあります。 この例では、保存したresult.jsonからソースフィールドを読み込む、--outputを使用しています。

ファイルファイルフィードバック
receipt.jsonok, runId, キャッシュ, 使用法と出力パス. キャッシュされたレシートは、新しい料金ではなく、元の使用状況を報告します。
result.jsonソース、ステータス、結果および使用。 Google Searchは、results[].organic[]を読みます。 空の配列は有効な検索結果になります。
error.json非ゼロ出口では、error.code、error.httpStatus、error.retryAfterおよびrun/job IDsを点検して下さい。
receipt.json・イラスト表現
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

別の検索なしで回復

再試行の前に保存された実行を点検して下さい。 元のアカウントにアクセスすると、まだ存在しないファイル名に成功した実行をエクスポートします。 トライアルアカウントから所有者にスイッチを向け、以前に試用結果をエクスポートし、新しいIDsを新しい所有者のタスクに使用してください。 ID が同じ実行されているリクエストで変更されると、意図的な新しいタスクだけに新しい ID を使用します。

点検し、保存された成功を輸出して下さい
flashdata runs show cli-research-001 --profile research \
  --state-dir "$FLASHDATA_STATE_DIR" --json
flashdata runs show cli-research-001 --result --output recovered.json \
  --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

スクリプトが動作するときにスケジューリングを追加する

--recurringは、インストールされた所有者のアクセス、1つの安定したIDを使用して、スケジュールされた発生と永続的な状態。 試行は再発工事を行わない。 ホストはスケジュールを所有しています。フラグはアクセスのみをチェックします。 スケジュールされた最新の処理と再起動のために、完全な再発タスクランナーを使用してください。

オプション: プライベートダウンロードストレージ

youtubeでは、--storage-config storage.jsonをダウンロードし、このストレージオブジェクトだけをstorage.jsonに保存し、プレースホルダをローカルに置き換えます。 ファイルがプライベートで、実行ユーザが所有している必要があります。 ダウンロードを実行する前に、マッチング権限コマンドを使用します。

storage.json · S3
{
  "storage_type": "s3",
  "storage_url": "YOUR_BUCKET",
  "access_key": "YOUR_ACCESS_KEY",
  "secret_key": "YOUR_SECRET_KEY",
  "region": "us-east-1"
}
ファイルアクセスを制限する
chmod 600 storage.json

関連ガイド