दस्तावेज़ देखें
शुरू करें
एक अनुरोध को मान्य करें, इसे स्क्रिप्ट से चलाएं और अलग परिणाम और त्रुटि रसीदें पढ़ें।
इस पेज पर
1. मौजूदा प्रोफ़ाइल का चयन करें
स्थापित CLI, Bash और jq का उपयोग करें। Windows पर, Git Bash में शैल उदाहरण चलाते हैं। इस walkthrough एक प्रामाणिक अनुसंधान प्रोफ़ाइल का उपयोग करता है; सेट FLASHDATA_STATE_DIR to the निरपेक्ष निर्देशिका जहां उस प्रोफ़ाइल को संग्रहीत किया जाता है।
प्रत्येक कमांड पर उसी OS उपयोगकर्ता और राज्य निर्देशिका का उपयोग करें। FLASHDATA_API_KEY बचाया कुंजी ओवरराइड करता है; प्रोफ़ाइल का उपयोग करने के लिए इसे बिना सेट छोड़ दें। CLI लोड नहीं करता है।
: "${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 की रिपोर्ट करनी चाहिए। एक unattended तैनाती के लिए, अपने गुप्त स्टोर से stdin के माध्यम से मालिक की कुंजी आयात करें।
| OS | निर्देशिका |
|---|---|
| Windows | %APPDATA%/FlashData |
| macOS | ~/Library/Application Support/FlashData |
| Linux | $XDG_STATE_HOME/flashdata या ~ /.local/state/flashdata |
2. अनुरोध और मूल्य को मान्य करें
request.json को सेव करें, फिर उसी डायरेक्टरी में मुफ्त चेक चलाएं। फ़िल्टर केवल true को प्रिंट करता है जब एक स्रोत मूल्य उपलब्ध होता है और शेष राशि एक क्वेरी को कवर करती है। एक nonzero निकास पर बंद करो। एक मूल्य जांच क्रेडिट को आरक्षित नहीं करता है।
{
"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. भागो और पढ़ने के लिए रसीद
चेकों के पास होने के बाद, run-search.sh को बचाएं और bash run-search.sh चलाएं। पहला सफल निष्पादन एक खोज प्रस्तुत करता है। प्रत्येक प्रयास अपनी फ़ाइलों को एक नई clirun निर्देशिका में बचाता है; स्थिर रन ID CLI को उसी खाते, प्रोफ़ाइल और राज्य निर्देशिका के लिए पहले की सफलता का पुन: उपयोग करने देता है।
#!/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 | गैर-zero निकास पर, error.code, error.httpStatus, error.retryAfter और किसी भी run/job IDs का निरीक्षण करें। |
{
"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_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