Обзор документации
Руководства
Добавьте метаданные в плейлист, список чтения или набор данных приложения, сохраняя при этом свою первоначальную запись IDs и каждый результат.
На этой странице
От ваших записей до обогащенного набора данных
Начните с трех записей, ссылающихся на два видео. Запросите каждое отдельное видео один раз, затем присоедините метаданные ко всем трем записям. Этот рабочий процесс использует небольшой запрос Batch и сохраняет видимые неуспешные элементы.
| Выводные поля | Цель |
|---|---|
| record_id · input | Ваша первоначальная запись и поля в первоначальном порядке. |
| video_id · query_index · job_id | Отслеживайте каждую запись до запроса, который ее произвел. |
| status · metadata · result_file | Завершенный результат или явный результат pending/failed/read-error. |
1. Проверьте свои инструменты и доступ
Используйте FlashData CLI v1.2.1 на PATH и Node.js 22+. Запустите новую папку с существующими учетными данными владельца и разрешением youtube_metadata. Bash и PowerShell используют одни и те же команды ниже.
Сохраняйте один и тот же профиль и аккаунт на протяжении всего времени. Для именованного профиля установите FLASHDATA_PROFILE в этом терминале, чтобы коллектор также использовал его. Агенты могут загрузить FLASHDATA_API_KEY из своего секретного магазина.
flashdata --version
node --version
flashdata auth status --json
mkdir video-enrichment
cd video-enrichmentПроверить баланс и емкость
Подтвердите доступ владельца, разрешение youtube_metadata и место для двух партийных предметов и ожидающих работы. Если временный доступ по-прежнему активен, заявляйте об этом или используйте рецепт одновидео. Проанализируйте оценку сухого цикла на этапе 3 перед отправкой.
flashdata account balance --json
flashdata account limits --json2. Подготовьте свои входные записи
Сохраните это как videos.json. Замените значения своей собственной записью IDs и 11-символом YouTube видео IDs. Дополнительные поля остаются в локальном отображении и не отправляются в FlashData. Разрешается повторное видео IDs; record_id должен быть уникальным.
[
{
"record_id": "lesson-intro",
"video_id": "jNQXAC9IVRw",
"collection": "Course"
},
{
"record_id": "playlist-song",
"video_id": "dQw4w9WgXcQ",
"collection": "Playlist"
},
{
"record_id": "saved-intro",
"video_id": "jNQXAC9IVRw",
"collection": "Reading list"
}
]Скачать prepare.mjs
Создайте prepare.mjs рядом с videos.json в папке с видеообогащением. Скопируйте полный код ниже и сохраните его.
Сценарий проверяет каждую строку перед созданием prepared/. Он дублирует видео IDs для этого запроса метаданных, сохраняя при этом ваши оригинальные записи и заказ.
// prepare.mjs — local preparation; sends no API requests.
import { mkdir, readFile, writeFile } from 'node:fs/promises';
const rows = JSON.parse((await readFile('videos.json', 'utf8')).replace(/^\uFEFF/, ''));
if (!Array.isArray(rows) || rows.length === 0) throw new Error('Supply a nonempty array of records.');
const recordIds = new Set(), videoIndexes = new Map(), queries = [];
const mapping = rows.map((input, index) => {
if (!input || typeof input !== 'object' || Array.isArray(input)
|| typeof input.record_id !== 'string' || !input.record_id.trim()
|| recordIds.has(input.record_id) || typeof input.video_id !== 'string'
|| !/^[A-Za-z0-9_-]{11}$/.test(input.video_id)) {
throw new Error('Invalid or duplicate record_id, or invalid video_id at row ' + (index + 1));
}
recordIds.add(input.record_id);
if (!videoIndexes.has(input.video_id)) {
videoIndexes.set(input.video_id, queries.length);
queries.push({ source: 'youtube_metadata', video_id: input.video_id,
params: { include_formats: false } });
}
return { input, query_index: videoIndexes.get(input.video_id) };
});
// Existing preparation is kept intact. Use it to resume, or choose a new folder.
await mkdir('prepared');
await writeFile('prepared/batch.json', JSON.stringify(queries, null, 2), { flag: 'wx' });
await writeFile('prepared/input-map.json', JSON.stringify(mapping, null, 2), { flag: 'wx' });
console.log(JSON.stringify({ inputRecords: rows.length, uniqueQueries: queries.length,
reusedVideoIds: rows.length - queries.length }, null, 2));Создайте список запросов локально
После сохранения prepare.mjs запустите его один раз. inputRecords: 3, uniqueQueries: 2 и reusedVideoIds: 1 Держите prepared/batch.json и prepared/input-map.json неизменными для этого запуска. Если готовый/уже существует, повторно используйте его для возобновления; используйте новую папку для другого набора данных.
node prepare.mjs3. Просмотр и отправка уникальных видео
Сухой запуск проверяет фактическое количество запросов, текущие цены и лимиты счета. Просмотрите его, а затем отправьте один раз. Выборка имеет два платежных запроса, хотя вход имеет три записи.
Храните submission.json и государственный каталог CLI. Повторно использовать один и тот же запуск ID и ввод после прерывания. Новый запуск ID создает новую работу; проверьте неопределенное представление перед повторным использованием.
flashdata batch submit --input prepared/batch.json --dry-run --jsonflashdata batch submit --input prepared/batch.json --run-id video-metadata-001 --output submission.json --json4. Собирайте и присоединяйтесь к результатам
Сохраните collect.mjs ниже, затем запустите его. Коллекционер выжидает до двух минут за незавершенную работу, проверяет, что результаты принадлежат запрашиваемому видео, и присоединяет каждый результат к оригинальным записям. Управляйте одним коллекционером за раз.
Запустите его снова, чтобы возобновить ту же работу IDs. Он повторно использует проверенные локальные результаты и не отправляет никаких новых запросов. Код выхода 1 означает, что некоторые результаты по-прежнему требуют внимания; проверьте их, а не повторно отправляйте список.
Скачать collect.mjs
Создайте collect.mjs в той же папке с видеообогащением, рядом с submission.json и prepared/. Скопируйте полный код ниже и сохраните его.
// collect.mjs — reads saved jobs; never submits another query.
import { execFileSync } from 'node:child_process';
import { mkdir, readFile, writeFile, rename } from 'node:fs/promises';
const readJSON = async file => JSON.parse((await readFile(file, 'utf8')).replace(/^\uFEFF/, ''));
const cli = (...args) => JSON.parse(execFileSync('flashdata', [
...args, '--json', '--non-interactive', '--timeout', '2m',
], { encoding: 'utf8', stdio: ['ignore', 'pipe', 'pipe'], maxBuffer: 16 * 1024 * 1024 }));
const inputs = await readJSON('prepared/batch.json');
const mapping = await readJSON('prepared/input-map.json');
const saved = await readJSON('submission.json');
const receipts = (saved.submission ?? saved).queries;
if (!Array.isArray(inputs) || !inputs.length || !Array.isArray(receipts)
|| receipts.length !== inputs.length || new Set(receipts.map(r => r.id)).size !== receipts.length
|| inputs.some(q => q.source !== 'youtube_metadata') || !Array.isArray(mapping) || !mapping.length
|| mapping.some(row => !Number.isInteger(row.query_index)
|| inputs[row.query_index]?.video_id !== row.input?.video_id)) {
throw new Error('Input/receipt mismatch. Keep the original prepared files and receipt.');
}
await mkdir('results', { recursive: true });
const binding = JSON.stringify({ inputs, mapping, receipts });
try { await writeFile('results/input-receipts.json', binding, { flag: 'wx' }); }
catch (error) {
if (error.code !== 'EEXIST') throw error;
if (await readFile('results/input-receipts.json', 'utf8') !== binding) {
throw new Error('Inputs or receipts changed. Restore the original files.');
}
}
const rows = inputs.map((input, query_index) => ({ query_index,
video_id: input.video_id, job_id: receipts[query_index].id, status: 'unread' }));
const saveRows = async (path, values) => {
await writeFile(path + '.next', values.map(row => JSON.stringify(row)).join('\n') + '\n');
await rename(path + '.next', path);
};
for (const row of rows) {
try {
if (!/^[a-zA-Z0-9_-]+$/.test(row.job_id ?? '')) throw new Error('Invalid job ID.');
const file = 'results/' + row.job_id + '.json';
let result;
try { result = await readJSON(file); }
catch (error) { if (error.code !== 'ENOENT') throw error; }
if (!result) {
let job;
try { job = cli('jobs', 'wait', row.job_id).data; }
catch { job = cli('jobs', 'get', row.job_id).data; }
if (job.videoId !== row.video_id || job.source !== 'youtube_metadata') {
throw new Error('Job/input mismatch. Inspect the saved input and receipt.');
}
row.status = job.status;
row.error = job.error ?? null;
if (job.status === 'completed') {
cli('jobs', 'result', row.job_id, '--output', file);
result = await readJSON(file);
}
}
if (result) {
if (result.status !== 'done' || result.source !== 'youtube_metadata'
|| result.results?.length !== 1 || result.results[0].videoId !== row.video_id) {
throw new Error('Result/video mismatch. Inspect the saved JSON before continuing.');
}
Object.assign(row, { status: 'completed', metadata: result.results[0], error: null,
credits: result.usage?.credits ?? null, result_file: file });
}
} catch (error) {
row.status = 'read_error';
row.error = error.stderr?.toString().trim() || error.message;
}
await saveRows('metadata.ndjson', rows); // One outcome and charge per unique query.
await saveRows('enriched.ndjson', mapping.map(({ input, query_index }) => {
const { credits, ...outcome } = rows[query_index]; // Do not duplicate a charge across input records.
return { record_id: input.record_id, input, ...outcome };
}));
}
const failed = rows.filter(row => ['failed', 'cancelled'].includes(row.status));
await writeFile('failed-videos.json', JSON.stringify(failed, null, 2));
console.table(rows.map(({ video_id, job_id, status }) => ({ video_id, job_id, status })));
console.log('Saved enriched.ndjson, metadata.ndjson and results/*.json.');
if (rows.some(row => row.status !== 'completed')) process.exitCode = 1;Бегите или возобновляйте сборщика
Бегите от видеообогащения после сохранения collect.mjs. Сохраняйте оригинальный профиль CLI и каталог состояния.
node collect.mjsОжидаемые файлы
| Файл | Используйте его для |
|---|---|
| enriched.ndjson | Один ряд на оригинальную запись, включая дубликаты и сбои. Импорт record_id. |
| metadata.ndjson | Один ряд на уникальный запрос, с работой ID, файлом результата и фактическими кредитами. Посчитайте использование здесь один раз. |
| results/*.json | Сырые успешные ответы плюс сохраненный привязка input/receipt. |
| failed-videos.json | Подтверждены задания failed/cancelled для проверки. Рабочие места в ожидании и ошибках чтения исключены из этого списка. |
5. Используйте обогащенные записи в своем приложении
Сохраните inspect.mjs в видеообогащении, рядом с enriched.ndjson, а затем запустите его из этой папки. Ожидайте три оригинальных записи и два уникальных запроса. Вставляйте заполненные строки record_id, сохраняйте поля ввода и сохраняйте незавершенные строки в своем отчете об импорте. Прочитайте заголовок и продолжительность из метаданных; используйте video_id для ссылок или более позднего запроса подписей.
// inspect.mjs — inspect your dataset without another API call.
import { readFile } from 'node:fs/promises';
const rows = (await readFile('enriched.ndjson', 'utf8')).trim().split('\n').map(JSON.parse);
console.table(rows.map(row => ({ record_id: row.record_id, video_id: row.video_id,
collection: row.input.collection, status: row.status, title: row.metadata?.title ?? null })));
console.log('Original records:', rows.length);
console.log('Unique queries:', new Set(rows.map(row => row.query_index)).size);node inspect.mjsПродолжить тему, которая требует внимания
Экономьте результаты в течение периода хранения 24-часа. Для периодических обновлений используйте новую папку с моментальным снимком и запускайте ID только тогда, когда вы собираетесь платить за свежие данные; сохраняйте стабильность record_id в своем приложении.
| Итоги | Следующее действие |
|---|---|
| pending / processing | Позже снова запустите коллекционер. Выполняйте ту же работу, что и IDs. |
| failed / cancelled | Обзор failed-videos.json и ошибки в работе. Исправьте причину, прежде чем намеренно запросить это видео снова. |
| read_error | Исправьте доступ, привязку ввода или сохраненный результат. Держите необработанный файл для проверки; ошибка чтения не означает, что нужен новый запрос. |
| Результаты представления неизвестны | Проверьте локальный запуск и History, прежде чем отправлять снова. |
flashdata runs show video-metadata-001 --json