Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Приклади

Зберігати часові підписи

Заощаджуйте існуючу трек YouTube з текстом, терміном та мовою. Додайте посилання на відео на кожен сегмент для цитувань у відповідь вашого додатка або агента.

На цій сторінці

Перед тим, як початися

Використовуйте ключ з дозволом youtube_captions і доступні кредити. Виберіть Python 3.10+ з запитами, або Bash з cURL 7.76+ і jq. На Windows використовується Git Bash для версії Bash.

1. Виберіть відео та підписку

Створіть папку та заощаджуйте request.json. Відкрийте термінал в цій папці. Замініть video_id з відео 11-character ID, не повний URL.

Цей приклад запитує англійські автоматичні підписи. За допомогою авто=true, зайдіть на машині спочатку, потім введіть. Витратити -orig коди і авто=false залишатися точним. API ніколи не переходить між автоматичними і завантажувацькими запорами.

timestamped-captions/request.json
{
  "source": "youtube_captions",
  "video_id": "FUfGcZ092b0",
  "params": {
    "language": "en",
    "auto": true
  }
}

2. Захоплення і збереження підписів

Виберіть один варіант і зберегти його сценарій біля request.json. Він читає FLASHDATA_API_KEY або просить ключа на приховану підказку. Агенти повинні навантажувати, що змінна навколишнє середовище від свого секретного магазину.

Запустіть з трек-001 як папка виходу. Нова папка надсилає одну запит і зберігає її відповідне використання. Перед створенням captions.json, скрипт виправляє повернутий відео ID, мова, походження підписки та терміни сегменту.

Встановити в середовищі Python
python -m pip install requests
timestamped-captions/captions.py
import argparse
import getpass
import json
import math
import os
import re
from datetime import datetime, timezone
from pathlib import Path

import requests

parser = argparse.ArgumentParser()
parser.add_argument("folder", help="New output folder, or an existing saved caption request")
out = Path(parser.parse_args().folder)

if not out.exists():
    body = Path("request.json").read_bytes()
    request = json.loads(body)
    if (not isinstance(request, dict) or request.get("source") != "youtube_captions"
            or not isinstance(request.get("video_id"), str)
            or not re.fullmatch(r"[A-Za-z0-9_-]{11}", request["video_id"])):
        raise SystemExit("Use youtube_captions and an 11-character video_id")
    options = request.get("params")
    if (not isinstance(options, dict) or not isinstance(options.get("language"), str)
            or not re.fullmatch(r"[A-Za-z0-9-]{1,35}", options["language"])
            or type(options.get("auto")) is not bool):
        raise SystemExit("Set one language code and auto: true or false explicitly")
    key = os.environ.get("FLASHDATA_API_KEY") or getpass.getpass("FlashData API key: ")
    if not key.strip():
        raise SystemExit("An API key is required")
    out.mkdir()
    (out / "request.json").write_bytes(body)
    (out / "requested-at.txt").write_text(
        datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"), encoding="utf-8"
    )
    try:
        response = requests.post(
            "https://data.flashdata.dev/v1/queries/realtime",
            headers={"X-API-Key": key, "Content-Type": "application/json",
                     "Accept": "application/json"},
            data=body, timeout=120, allow_redirects=False,
        )
    except requests.RequestException:
        raise SystemExit(f"Request interrupted. Keep {out} and check History before retrying.")
    (out / "result.json").write_bytes(response.content)
    (out / "response-headers.txt").write_text(
        "\n".join(f"{k}: {v}" for k, v in response.headers.items()), encoding="utf-8"
    )
    (out / "http-status.txt").write_text(str(response.status_code), encoding="utf-8")
else:
    print(f"Reading saved response from {out}; no API call.")

if not (out / "http-status.txt").exists():
    raise SystemExit("Incomplete attempt. Keep the folder and check History before retrying.")
status = (out / "http-status.txt").read_text().strip()
if status != "200":
    raise SystemExit(f"HTTP {status}: inspect {out}/result.json and response-headers.txt")
try:
    data = json.loads((out / "result.json").read_bytes())
except ValueError:
    raise SystemExit("Invalid JSON; inspect the saved result.json")
request = json.loads((out / "request.json").read_bytes())
if not isinstance(data, dict) or data.get("source") != "youtube_captions" or data.get("status") != "done":
    raise SystemExit("Caption request did not finish successfully; inspect result.json")
tracks = data.get("results")
if not isinstance(tracks, list) or len(tracks) != 1 or not isinstance(tracks[0], dict):
    raise SystemExit("Expected one caption track; inspect result.json")
track = tracks[0]
language = request["params"]["language"]
allowed_languages = [language]
if request["params"]["auto"] and not language.endswith("-orig"):
    allowed_languages.append(language + "-orig")
if (track.get("videoId") != request["video_id"]
        or track.get("languageCode") not in allowed_languages
        or track.get("requestedLanguageCode", track.get("languageCode")) != language
        or track.get("isAutoGenerated") is not request["params"]["auto"]):
    raise SystemExit("Returned video, language or caption origin does not match the request")
if not isinstance(track.get("segments"), list):
    raise SystemExit("Expected a segments array; inspect result.json")
segments = []
for cue in track["segments"]:
    if not isinstance(cue, dict):
        raise SystemExit("Expected caption segment objects")
    start, end, text = cue.get("start"), cue.get("end"), cue.get("text")
    if (type(start) not in (int, float) or not math.isfinite(start) or start < 0
            or type(end) not in (int, float) or not math.isfinite(end) or end < start
            or not isinstance(text, str)):
        raise SystemExit("Invalid caption timing or text; inspect result.json")
    segments.append({**cue, "url": f"https://www.youtube.com/watch?v={track['videoId']}&t={math.floor(start)}s"})
captions = {**track, "segments": segments}
record = {"request": request, "requested_at": (out / "requested-at.txt").read_text().strip(),
          "usage": data.get("usage"), "segment_count": len(segments), "result_file": "result.json"}
for filename, value in (("captions.json", captions), ("record.json", record)):
    (out / filename).write_text(json.dumps(value, ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
print(f"Saved {len(segments)} segments to {out}/captions.json")
if not any(cue["text"].strip() for cue in segments):
    print("No caption text to cite. Keep the empty track and report the gap.")
Запуск з своєчасних підписів/
python captions.py track-001

3. Читати текст про час

Успіх друкує Збережені сегменти N до track-001/captions.json. Цей файл зберігає повернуті треки і додає URL до кожного сегмента. record.json містить точний поданий запит, requested_at, використання та segment_count; result.json зберігає оригінальну відповідь API.

Читати локально · без виклику API
python -m json.tool track-001/captions.json
python -m json.tool track-001/record.json

Приклад виходу

Аббревіатура, ілюстративний captions.json. Ваш текст і терміни будуть відрізнятися. languageName може бути null; скрипт зберігає його таким чином.

timestamped-captions/track-001/captions.json
{
  "videoId": "FUfGcZ092b0",
  "languageCode": "en",
  "languageName": null,
  "isAutoGenerated": true,
  "segments": [
    {
      "start": 12.5,
      "end": 16.2,
      "text": "This is an illustrative caption segment.",
      "url": "https://www.youtube.com/watch?v=FUfGcZ092b0&t=12s"
    }
  ]
}

Ввійти відео прохід

Надрукуйте перші три сегменти з їх вихідними посиланнями. запустіть та в кінці залишатися за секундами з оригінальною точністю. Тільки час запуску URL закруглений: 12.5 секунд стає &t=12. Збережено порядок і перекриття термінів.

Заощаджуйте cite.py біля captions.py, потім запустіть його з тієї ж папки.

timestamped-captions/cite.py
import json
from pathlib import Path

captions = json.loads(Path("track-001/captions.json").read_text(encoding="utf-8"))
for cue in captions["segments"][:3]:
    print(f"[{cue['start']}–{cue['end']}s] {cue['text']}")
    print(cue["url"])
    print()
Друк цитування з збережених підписів
python cite.py

Зберігати контекст підписки

Використовуйте текст сегмента як докази для цитування; fullText корисний для читання, але не розташуйте прохід. Перевірити навколишні сегменти до котирування, особливо для автоматичних підписів. Затримайте languageCode і isAutoGenerated так, щоб ваш додаток або агент може виявити вихідний трек.

Зловживання збереженими треками

Виконайте таку ж команду, щоб відновити captions.json від збереженої відповіді, без ключа або нової запиту. Редагування верхнього рівня request.json не змінює запит, що зберігається з трек-001.

Зловживання локально
python captions.py track-001

Виберіть інший трек

Для запиту завантажувального англійського підпису замініть request.json з цією версією та використовуйте трек-002. Змініть мову тільки до коду, який ви хочете отримати, наприклад, en-orig або zh-Hans. Коди кандидата метаданих transcriptLanguages не мають автоматичного або завантаженого треку.

Скрипт очікує одного мовного рядка. Мови масиви мають різну форму відповіді з треками та помилковими помилками; використовувати API посилання на цей робочий процес.

timestamped-captions/request.json
{
  "source": "youtube_captions",
  "video_id": "FUfGcZ092b0",
  "params": {
    "language": "en",
    "auto": false
  }
}
Новий трек · ще один запит API
python captions.py track-002

Якщо заголовки відсутні або нездатні

Що відбулосяЩо робити
Вибраний трек 0Перевірити відео, мову та автопідбірку. Виберіть доступний трек прямо; повторюючи той же запит не створить підписи.
segments: []В наявності немає тексту. Сцена зберігає порожній трек і звітує про зазор. Не перетворюйте його в трафарет або резюме.
Відео, мова або заказка походженняNo captions.json написано. Порівняти збережений запит з result.json перед використанням будь-якого тексту.
Неточні терміни або відсутні сегментиОгляд result.json. Скрипт не зупиняється замість того, щоб призначити придуманий час або безшумно знизивши поганий сегмент.
401 / 403 / 402Перевірити ключ, дозвіл youtube_captions і баланс, відповідно, перед новою спробою.
429Читати Retry-After в response-headers.txt і чекати. Скрипт не автоматично переробляє.
Час, 5xxx, недійсний JSON або неповна папкаЗберігайте спробу і перевірте History до подачі знову. Відновити папку ніколи не надішлемо інший запит.

Заощаджуйте inspect_captions.py beside captions.py, потім запустіть його.

timestamped-captions/inspect_captions.py
from pathlib import Path

for name in ("http-status.txt", "response-headers.txt", "result.json"):
    path = Path("track-001") / name
    print(f"--- {name} ---")
    print(path.read_text(encoding="utf-8", errors="replace") if path.exists() else "Not saved")
Опитування локально
python inspect_captions.py