Przejdź do treści
PL
Uzyskaj klucz API
Przeglądaj dokumentację

Przykłady

Pobieranie napisów z terminami

Zapisz istniejący utwór nagrywania YouTube z tekstem, czasem i językiem. Dodaj link wideo do każdego segmentu dla cytowania w aplikacji lub odpowiedzi agenta.

Na tej stronie

Zanim zaczniesz

Użyj klucza z pozwoleniem youtube_captions i dostępnymi kredytami. Wybierz Python 3.10 + z życzeniami lub Bash z cURL 7.76 + i jq. Na Windows, użyj Git Bash dla wersji Bash.

1. Wybierz ścieżkę nagrywania i nagrywania

Utwórz folder timestamped- captions i zapisz tam request.json. Otwórz terminal w tym folderze. Zastąp video_id znakiem 11- ID, a nie pełną URL.

Ten przykład wymaga angielskich napisów automatycznych. Z auto = true, en próbuje en- orig najpierw, a następnie en. Kody explicit -orig i auto = false pozostają dokładne. API nigdy nie przełącza się pomiędzy podpisami automatycznymi i podręcznymi.

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

2. Pobierz i zapisać podpisy

Wybierz jedną wersję i zapisz jej skrypt obok request.json. Odczytuje FLASHDATA_API_KEY lub prosi o klucz w ukrytym trybie. Agenci powinni załadować tę zmienną środowiskową ze swojego tajnego sklepu.

Uruchom z track- 001 jako folder wyjściowy. Nowy folder wysyła jedno zapytanie i zapisuje zgłoszone użycie. Przed utworzeniem captions.json, skrypt weryfikuje zwrócony film ID, język, pochodzenie podpisków i czas trwania segmentu.

Zainstaluj w środowisku 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.")
Uruchom od timestamped- napisy /
python captions.py track-001

3. Przeczytaj tekst oznaczony terminowo

Odciski sukcesu Uratowano segmenty N do track-001/captions.json. Plik ten zachowuje zwrócony utwór i dodaje URL do każdego segmentu. record.json zawiera dokładnie przedstawiony wniosek, requested_at, użycie i segment_count; result.json zachowuje oryginalną odpowiedź API.

Czytaj lokalnie · nie ma połączenia API
python -m json.tool track-001/captions.json
python -m json.tool track-001/record.json

Przykład wyjścia

Skrócony, ilustracyjny captions.json. Twój tekst i czas będą się różnić. languageName może być null; skrypt tak to zachowuje.

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"
    }
  ]
}

Cytuj przejście wideo

Wydrukuj pierwsze trzy segmenty za pomocą ich połączeń źródłowych. Rozpocząć i zakończyć pobyt w sekundach z ich oryginalną precyzją. Tylko czas rozpoczęcia URL jest zaokrąglony w dół: Sekundy 12.5 stają się & t=12s. Zachowane są kolejność segmentów i nakładające się na siebie terminy.

Zapisz cite.py obok captions.py, a następnie uruchom go z tego samego folderu.

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()
Wydrukuj cytaty z zapisanych napisów
python cite.py

Zachowaj kontekst zapisu

Użyj tekstu segmentu jako dowodu cytowania; fullText jest przydatny do odczytu, ale nie znajduje przejścia. Sprawdź otaczające segmenty przed cytowaniem, szczególnie dla automatycznego napisy. Zachowaj languageCode i isAutoGenerated, aby Twoja aplikacja lub agent mógł zidentyfikować ścieżkę źródłową.

Ponownie użyj zapisanego utworu

Uruchom to samo polecenie, aby odbudować captions.json z zapisanej odpowiedzi, bez klucza lub nowego zapytania. Edycja poziomu górnego request.json nie zmienia żądania przechowywanego za pomocą track- 001.

Ponowne wykorzystanie lokalnie
python captions.py track-001

Wybierz inną ścieżkę

Aby zażądać uploader- dostarczone angielskie podpisy, zastąpić request.json z tej wersji i używać track- 002. Zmień język tylko do kodu, który zamierzasz odzyskać, takich jak en- orig lub zh- Hans. Metadane transcriptLanguages wymienia kody kandydatów, nie to, czy każdy z nich ma automatyczny lub załadowany utwór.

Skrypt oczekuje jednego łańcucha językowego. Tablice językowe mają inny kształt odpowiedzi z utwory i błędy w języku przelotowym; do tego przepływu pracy należy użyć odniesienia API.

timestamped-captions/request.json
{
  "source": "youtube_captions",
  "video_id": "FUfGcZ092b0",
  "params": {
    "language": "en",
    "auto": false
  }
}
Nowy utwór · inny API wniosek
python captions.py track-002

Jeżeli brakuje podpisy lub nie można ich wykorzystać

Co się stało?Co zrobić
Wybrany utwór jest niedostępnySprawdź wybór wideo, języka i auto. Wybierz dostępny utwór wyraźnie; powtarzanie tego samego żądania nie będzie tworzyć podpisy.
segments: []Istniejący utwór nie może zawierać tekstu. Skrypt zapisuje pusty utwór i zgłasza lukę. Nie należy zmieniać go w transkrypcję lub streszczenie.
Niewłaściwe pochodzenie wideo, języka lub napisuNie jest napisane captions.json. Porównaj zapisane żądanie z result.json przed użyciem jakiegokolwiek tekstu.
Nieprawidłowy czas lub brakujące segmentySprawdź result.json. Skrypt zatrzymuje się zamiast przypisywania wymyślonych znaczników czasu lub cichego upuszczania złego segmentu.
401 / 403 / 402Przed nową próbą należy sprawdzić klucz, pozwolenie youtube_captions i saldo.
429Przeczytaj Retry-After w response-headers.txt i czekaj. Skrypt nie próbuje ponownie automatycznie.
Timeout, 5xx, nieprawidłowy JSON lub niekompletny folderPrzed ponownym złożeniem należy zachować próbę i sprawdzić History. Ponowne użycie folderu nigdy nie wysyła kolejnego zapytania.

Zapisz inspect_captions.py obok captions.py, a następnie uruchom go.

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")
Sprawdzić lokalnie
python inspect_captions.py