Langkau ke kandungan
MS
Dapatkan kunci API
Semak dokumentasi

Mula di sini

Automasi dengan FlashData CLI

Memvalidasi permintaan, jalankan dari skrip dan baca hasil terpisah dan penerimaan kesalahan.

Pada halaman ini

1. Pilih profil yang telah ada

252 menggunakan CLI yang terpasang, Bash dan jq. XAZ pada Windows, jalankan contoh shell dalam Git Bash. walkthrough ini menggunakan profil penelitian terotentikasi; set FLASHDATA_STATE_DIR ke direktori absolut di mana profil tersebut disimpan.

Guna pengguna OS dan direktori keadaan yang sama pada setiap perintah. FLASHDATA_API_KEY membatalkan kunci yang disimpan; biarkan tidak ditentukan untuk menggunakan profil. CLI tidak memuat berkas .env.

Periksa akses tersimpan
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

Lokasi baku negara

Gunakan --state-dir asli Anda jika Anda memilih lokasi khusus. auth status harus melaporkan data.accessVerified: true. Untuk penyebaran yang tidak diinginkan, impor kunci pemilik melalui stdin dari toko rahasianya.

OSDirektori:
Windows%APPDATA%/FlashData
macOS~/Library/Application Support/FlashData
LinuxXAXDG_STATE_HOME/flashdata atau ~/.local/state/flashdata

2. Sahkan permintaan dan harga

Simpan request.json, kemudian jalankan pemeriksaan bebas di direktori yang sama. cetakan filter trueQ hanya ketika harga sumber tersedia dan saldo meliputi satu pertanyaan. Berhenti di pintu keluar tanpa nol. Pengecekan harga bukan kredit cadangan.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Bash + jq · tidak ada penyerahan dibayar
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. Jalankan dan baca penerimaan

Setelah pemeriksaan lulus, simpan run-search.sh dan jalankan bash run-search.sh. Eksekusi pertama yang berhasil mengirimkan satu pencarian. Kecobaan dari masing-masing percobaan menyimpan filenya dalam direktori cli-run baru; stabil menjalankan ID memungkinkan CLI menggunakan kembali sukses sebelumnya untuk akun yang sama, profil dan direktori negara.

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"

Tahu berkas mana yang akan dibaca

Sampul CLI dan respon sumber berbeda dokumen JSON. Tanpa --output, respon sumber ada dalam data. Contoh ini menggunakan --output, jadi baca source fields dari result.json yang disimpan.

Fijiafrica. kgmBacalah
receipt.json¡runId, dicache, penggunaan dan jalur output. Pembayaran yang telah dicache melaporkan penggunaan asli, bukan biaya baru.
result.jsonSumber, status, hasil dan penggunaan. Untuk Google Search, baca results[].organic[]. Sebuah array kosong dapat menjadi hasil pencarian yang valid.
error.jsonSaat keluar tanpa nol, inspeksi error.code, error.httpStatus, error.retryAfter dan run/job IDs.
Parameter receipt.json · kutipan iuran
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

Pulihkan tanpa pencarian lain

Periksalah yang disimpan sebelum mencoba lagi. Dengan akses ke akun asli, ekspor sukses lari ke nama berkas yang belum ada. Klaim klaim tuis dari rekening percobaan kepada pemilik; tetap mengekspor hasil uji coba sebelumnya dan menggunakan IDs baru untuk tugas pemilik baru. Sebuah permintaan yang diubah di bawah jangka yang sama ID ditolak; menggunakan ID baru hanya untuk tugas baru yang disengaja.

Periksalah, kemudian ekspor sukses yang disimpan
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

Penjadwalan tambahan ketika skrip bekerja

Use --recurring dengan akses pemilik terpasang, satu ID stabil per kejadian terjadwal dan keadaan persisten. Percobaan tidak dapat menjalankan pekerjaan yang berulang. Kau pemilik jadwal, bendera hanya memeriksa akses. Using rouble revolve-tugasl runner untuk penanganan dan restart terjadwal-date.

Opsional UIO: Penyimpanan unduhan pribadi

Untuk youtube download --storage-config storage.json, simpan hanya objek penyimpanan ini sebagai storage.json dan gantikan placeholders lokal. Berkas tersebut harus privat dan dimiliki oleh pengguna yang melaksanakan. WALD menggunakan perintah izin yang cocok sebelum menjalankan unduhan.

storage.json · S3
{
  "storage_type": "s3",
  "storage_url": "YOUR_BUCKET",
  "access_key": "YOUR_ACCESS_KEY",
  "secret_key": "YOUR_SECRET_KEY",
  "region": "us-east-1"
}
Akses file terbatas
chmod 600 storage.json

Panduan yang berkaitan dengan agama