Chuyển đến nội dung
VI
Lấy khóa API
Duyệt tài liệu

Bắt đầu

Tự động hóa bằng FlashData CLI

Kiểm tra yêu cầu, chạy nó từ văn lệnh và đọc kết quả riêng và biên nhận lỗi.

Trên trang này

1. Chọn hồ sơ đã có

Sử dụng CLI, Bash và jq. Vào WindowsChạy ví dụ vỏ sò ở Git Bash. Điều này đi qua sử dụng một hồ sơ nghiên cứu xác thực; set FLASHDATA_STATE_DIR tới thư mục tuyệt đối nơi cất giữ hồ sơ đó.

Dùng cùng một cách OS người dùng và thư mục tiểu dụng trên mỗi lệnh. FLASHDATA_API_KEY Ghi đè các phím đã lưu; để nó bỏ đặt để dùng hồ sơ đó. CLI không tải tập tin .env.

Kiểm tra truy cập đã lưu
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

Vị trí trạng thái mặc định

Hãy dùng bản gốc của bạn. --state-dir nếu bạn chọn một địa điểm riêng. auth status nên báo cáo data.accessVerified: true. Nếu không được giám sát, hãy nhập mật khẩu phím chủ qua stdin từ cửa hàng bí mật của nó.

OSThư mục
Windows%APPDATA%/FlashData
macOS~/Library/Application Support/FlashData
Linux$XDG_STATE_HOME/flashdata hay ~/.local/state/flashdata

2. Kiểm tra yêu cầu và giá cả

Lưu request.json, sau đó kiểm tra miễn phí trong cùng một thư mục. In bộ lọc true Chỉ khi nào có giá gốc và mức số dư bao gồm một yêu cầu. Dừng ở lối ra không bằng không. kiểm tra không tiết kiệm được tín dụng.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Bash + jq · Không được trả lương
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. Chạy và đọc biên lai

Sau khi kiểm tra xong, tiết kiệm run-search.sh và chạy đập run-search.sh. Cuộc hành hình thành công đầu tiên là một cuộc tìm kiếm. Mỗi lần cố lưu tập tin của nó vào một thư mục chạy cli mới; chạy ổn định ID Cho phép CLI Dùng lại thành công trước đó cho cùng tài khoản, hồ sơ và thư mục nhà nước.

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"

Biết phải đọc tập tin nào

Hạt CLI phong bì và câu trả lời nguồn khác nhau JSON tài liệu. Không có --output, câu trả lời nguồn là dữ liệu. Ví dụ này sử dụng --outputVậy hãy đọc các trường nguồn được lưu. result.json.

Tập tinĐọc
receipt.jsonOK, runId, bộ nhớ tạm, sử dụng và đường dẫn xuất. Một biên nhận lưu tạm báo cáo cách sử dụng gốc, chứ không phải một tính phí mới.
result.jsonNguồn, trạng thái, kết quả và cách sử dụng. Vì Google SearchĐọc results[].organic[]. Một danh sách rỗng có thể là kết quả tìm kiếm hợp lệ.
error.jsonTrên lối ra không số, thanh tra error.code, error.httpStatus, error.retryAfter và bất kỳ run/job IDs.
receipt.json Trích dẫn
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

Phục hồi mà không tìm kiếm một lần nào khác

Kiểm tra lại lần chạy đã lưu trước khi thử lại. Với quyền truy cập tài khoản gốc, xuất một tên tập tin không tồn tại thành công. Xác nhận công tắc từ tài khoản thử nghiệm cho người sở hữu; giữ lại kết quả thử trước đó xuất ra và sử dụng mới IDs cho nhiệm vụ sở hữu mới. Name ID bị từ chối; sử dụng một mới ID Chỉ cho một nhiệm vụ mới có chủ đích.

Kiểm tra, sau đó xuất ra một thành công đã lưu
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

Thêm kế hoạch khi văn lệnh hoạt động

Dùng --recurring với quyền truy cập người sở hữu đã cài đặt, một ổn định ID mỗi lần có lịch trình và trạng thái kiên trì. Một phiên tòa không thể lặp lại được. Máy chủ của bạn là chủ của lịch trình; cờ chỉ kiểm tra quyền truy cập. Sử dụng máy chạy lặp lại đầy đủ để xử lý và khởi động lại lịch sử.

Tùy chọn:

Cho bạn tải về ống --storage-config storage.jsonChỉ lưu vật chứa này khi storage.json và thay thế người giữ chỗ tại địa phương. Tập tin phải được riêng tư và sở hữu bởi người dùng thực hiện. Dùng lệnh cho phép khớp trước khi tải về.

storage.json · S3
{
  "storage_type": "s3",
  "storage_url": "YOUR_BUCKET",
  "access_key": "YOUR_ACCESS_KEY",
  "secret_key": "YOUR_SECRET_KEY",
  "region": "us-east-1"
}
Hạn chế truy cập tập tin
chmod 600 storage.json

Hướng dẫn liên quan