索引一个媒体资产,并运行你的第一次范围内搜索。
本指南将带你使用 TypeScript SDK,从 API 密钥到获得第一个搜索结果。Documentation Index
Fetch the complete documentation index at: https://docs.sf-voice.sh/llms.txt
Use this file to discover all available pages before exploring further.
pnpm add @sf-voice/media@latest
import { SfVoiceMedia } from "@sf-voice/media";
const client = new SfVoiceMedia({
baseUrl: "https://api.sf-voice.com",
apiKey: process.env.SF_VOICE_API_KEY!,
});
asset_id。使用 asset_class 将应一起搜索的资产分组,
例如某个客户的全部媒体。
const ingest = await client.ingest({
source: "url",
asset_id: "video_123",
asset_class: "customer_acme",
url: "https://example.com/recording.mp4",
media_type: "video",
types: ["video", "audio", "transcript"],
metadata: {
title: "product demo",
customer_id: "acme",
},
});
task_id。
{
"asset_id": "video_123",
"task_id": "task_abc123",
"status": "pending"
}
const task = await client.pollTask(ingest.task_id, {
intervalMs: 2_000,
timeoutMs: 120_000,
});
if (task.status === "failed") {
throw new Error(task.error ?? "ingest task failed");
}
asset_class 内进行搜索,以确保结果仅限于目标客户或分组。
const search = await client.search({
query: "where does the customer mention pricing?",
asset_class: "customer_acme",
types: ["transcript"],
threshold: 0.7,
limit: 10,
});
console.log(search.results);
import { SfVoiceMedia, SfVoiceMediaError } from "@sf-voice/media";
const client = new SfVoiceMedia({
baseUrl: "https://api.sf-voice.com",
apiKey: process.env.SF_VOICE_API_KEY!,
});
try {
const ingest = await client.ingest({
source: "url",
asset_id: "video_123",
asset_class: "customer_acme",
url: "https://example.com/recording.mp4",
media_type: "video",
types: ["video", "audio", "transcript"],
});
const task = await client.pollTask(ingest.task_id);
if (task.status === "failed") {
throw new Error(task.error ?? "ingest task failed");
}
const search = await client.search({
query: "pricing",
asset_class: "customer_acme",
types: ["transcript"],
});
console.log(search.results);
} catch (error) {
if (error instanceof SfVoiceMediaError) {
console.error(error.code, error.status, error.message);
}
throw error;
}