Przeglądaj dokumentację
Pierwsze kroki
Potwierdź żądanie, uruchom je ze skryptu i przeczytaj oddzielne rachunki wyników i błędów.
Na tej stronie
1. Wybierz istniejący profil
Użyj zainstalowanego CLI, Bash i jq. Na Windows, uruchom przykłady powłoki w Git Bash. To przejście wykorzystuje uwierzytelniony profil badawczy; ustaw FLASHDATA_STATE_DIR do katalogu absolutnego, w którym profil ten jest przechowywany.
Użyj tego samego użytkownika OS i katalogu stanu na każdym poleceniu. FLASHDATA_API_KEY nadpisuje zapisany klucz; nie włączaj go do używania profilu. CLI nie ładuje plików .env.
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --jsonDomyślne lokalizacje stanu
Użyj oryginalnego --state-dir jeśli wybrałeś własną lokalizację. auth status powinien zgłosić data.accessVerified: true. Dla nienadzorowanego wdrożenia, importować klucz właściciela przez stdin z jego tajnego sklepu.
| OS | Katalog |
|---|---|
| Windows | %APPDATA%/FlashData |
| macOS | ~/Library/Application Support/FlashData |
| Linux | $XDG_STATE_HOME/flashdata lub ~ /.local/state/flashdata |
2. Potwierdzenie wniosku i ceny
Zapisz request.json, a następnie uruchom darmowe kontrole w tym samym katalogu. Filtr drukuje true tylko wtedy, gdy dostępna jest cena źródłowa i saldo obejmuje jedno zapytanie. Zatrzymaj się na niezerowym wyjściu. Kontrola cen nie rezerwuje kredytów.
{
"source": "google_search",
"query": "battery recycling research",
"params": {
"num": 5
}
}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.json3. Uruchom i przeczytaj paragon
Po przejściu kontroli, zapisać run-search.sh i uruchomić bash run-search.sh. Pierwsza pomyślna egzekucja przedstawia jedno wyszukiwanie. Każda próba zapisywania plików w nowym katalogu cli- run; stabilna operacja ID pozwala CLI ponownie wykorzystać wcześniejszy sukces dla tego samego konta, profilu i katalogu stanu.
#!/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"Wiedz, który plik należy przeczytać
Koperta CLI i odpowiedź źródłowa to różne dokumenty JSON. Bez --output, odpowiedź źródłowa jest w danych. Ten przykład wykorzystuje --output, więc odczytuj pola źródłowe z zapisanego result.json.
| Plik | Czytaj |
|---|---|
| receipt.json | ok, runId, cached, use i ścieżka wyjściowa. Kasowany paragon zgłasza oryginalne użycie, a nie nowe obciążenie. |
| result.json | źródło, status, wyniki i wykorzystanie. Dla Google Search, czytaj results[].organic[]. Pusta tablica może być prawidłowym wynikiem wyszukiwania. |
| error.json | Po wyjściu bez zeru należy sprawdzić error.code, error.httpStatus, error.retryAfter i wszelkie run/job IDs. |
{
"schemaVersion": 1,
"ok": true,
"runId": "cli-research-001",
"cached": false,
"data": {
"output": "cli-run.EXAMPLE/result.json"
},
"usage": {
"credits": 0.02
}
}Odzyskiwanie bez kolejnego wyszukiwania
Sprawdź zapisany bieg przed ponowną próbą. Dzięki dostępowi do pierwotnego konta, eksportuj udany bieg do nazwy pliku, który jeszcze nie istnieje. Zatwierdzanie przełączników z konta próbnego na właściciela; zachowanie wcześniej wywiezionych wyników prób i użycie nowego IDs do nowych zadań właściciela. Zmieniony wniosek w tym samym trybie ID został odrzucony; użyć nowego ID tylko dla zamierzonego nowego zadania.
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" --jsonDodaj harmonogram, gdy skrypt działa
Użyj --recurring z zainstalowanym dostępem właściciela, jeden stabilny ID na planowe wystąpienie i stan trwały. Proces nie może się powtarzać. Twój gospodarz jest właścicielem harmonogramu; flaga sprawdza tylko dostęp. Użyj pełnego recurring- task runner do obsługi terminarz- date i restartuje.
Opcjonalnie: prywatne przechowywanie danych do pobrania
Do pobrania w youtube --storage-config storage.json, zapisz tylko ten obiekt pamięci masowej jako storage.json i zastąp lokalnie posiadaczy miejsc. Plik musi być prywatny i należy do użytkownika wykonującego. Przed pobraniem użyj polecenia zgody dopasowania.
{
"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$storagePath = (Resolve-Path -LiteralPath './storage.json').Path
$storageUser = [System.Security.Principal.WindowsIdentity]::GetCurrent().User
$storageAcl = [System.Security.AccessControl.FileSecurity]::new()
$storageAcl.SetOwner($storageUser)
$storageAcl.SetAccessRuleProtection($true, $false)
$storageAcl.AddAccessRule([System.Security.AccessControl.FileSystemAccessRule]::new($storageUser, 'FullControl', 'Allow'))
Set-Acl -LiteralPath $storagePath -AclObject $storageAcl