문서 둘러보기
시작하기
요청을 검증하고 스크립트에서 실행하고 별도의 결과와 오류 영수증을 읽습니다.
이 페이지의 내용
1. 기존 프로파일 선택
설치된 CLI, Bash 및 jq를 사용하십시오. Windows에서 쉘 예제를 Git Bash에서 실행합니다. 이 walkthrough는 인증된 연구 프로파일을 사용합니다; 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를 소스 가격만 사용할 수 있고 균형은 하나의 쿼리를 포함합니다. 비제로 출구에서 하차. 가격표는 신용을 예약하지 않습니다.
{
"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를 실행하십시오. 첫 번째 성공적인 실행은 하나의 검색을 제출합니다. 각 시도는 새로운 cli-run 디렉토리에서 파일을 저장합니다. 안정적인 실행 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 | ok, runId, 캐시, 사용 및 출력 경로. 캐시된 영수증은 새로운 책임이 아닌 본래 사용법을 보고합니다. |
| result.json | 근원, 상태, 결과 및 사용법. Google Search를 위해, results[].organic[]를 읽으십시오. 빈 배열은 유효한 검색 결과일 수 있습니다. |
| error.json | 비제로 출구에서 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를 사용하여 설치된 소유자 접근, 예정된 발생 및 지속 상태 당 1개의 안정되어 있는 ID를 사용하십시오. 시험은 재발행 작업을 실행할 수 없습니다. 호스트는 일정을 소유합니다. 플래그는 단지 접근을 확인합니다. 예약된 취급 및 재시작을 위한 완전한 재통합-task runner를 사용하십시오.
옵션: 개인 다운로드 저장
youtube 다운로드 --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