ข้ามไปยังเนื้อหา
TH
รับคีย์ API
เรียกดูเอกสาร

เริ่มต้นใช้งาน

ทำงานอัตโนมัติด้วย FlashData CLI

ทําการตรวจสอบการร้องขอ ให้ประมวลผลมันจากสคริปต์ แล้วอ่านผลแยกและตรวจสอบข้อผิดพลาด

ในหน้านี้

1. เลือกโพรไฟล์ที่มีอยู่แล้ว

ใช้การติดตั้ง CLI, Bash ถึง jq. เปิด Windowsสุ่มตัวอย่างเปลือกใน Git Bash. การเดินนี้จะใช้โพรไฟล์ที่ยืนยันแล้ว; ตั้งค่า FLASHDATA_STATE_DIR ไปยังไดเร็กทอรีสมบูรณ์ที่จัดเก็บโพรไฟล์

ใช้แบบเดียวกัน OS ผู้ใช้และไดเรกทอรีสถานะ ในทุกคําสั่ง FLASHDATA_API_KEY ใช้แทนปุ่มบันทึก; ปล่อยให้มันไม่ตั้งค่าใช้โพรไฟล์ เดอะ 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 แล้วเรียกตรวจสอบฟรีในไดเรกทอรีเดียวกัน ตัวกรองการพิมพ์ 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 และทําแผลให้ run-search.sh. การประหารชีวิตที่ประสบความสําเร็จครั้งแรก ส่งการค้นหาหนึ่ง แต่ละความพยายามจะบันทึกแฟ้มต่าง ๆ ของมันในไดเรกทอรี cli-un ตัวใหม่; ตัวคงที่ทํางาน 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 การตอบรับจากแหล่งคือข้อมูล ตัวอย่างนี้ใช้ --outputอ่านแหล่งกําเนิดจากบันทึก result.json.

แฟ้มอ่าน
receipt.jsonโอเค 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 โดยมีเจ้าของที่ติดตั้งไว้หนึ่งตัวมั่นคง ID ต่อเหตุการณ์ที่เกิดขึ้นและสภาพที่ต่อเนื่อง การทดลองไม่สามารถดําเนินการซ้ําได้ โฮสต์ของคุณเป็นเจ้าของตาราง; แฟล็กตรวจสอบเฉพาะสิทธิ์ในการเข้าใช้งาน ใช้ตัวประมวลผลการเกิดขึ้นอีกของทาสก์สําหรับการจัดการวันที่และเริ่มการทํางานใหม่อีกครั้ง

ตัวเลือก: จัดเก็บการดาวน์โหลดส่วนตัว

สําหรับการดาวน์โหลดในยูทูป --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

มัคคุเทศก์ ที่ เกี่ยว ข้อง