API Overview¶

Full API reference for the VSS Feature Store.

API Structure¶

Caption Retrieval (Read)¶

API	Description	Use Case
search_metadata	Search metadata	Find videos matching specific criteria
get_captions	Retrieve single caption	Get captions for a specific video
get_captions_batch	Batch caption retrieval	Get captions for multiple videos at once

Caption Registration (Write)¶

API	Description	Use Case
register_captions	Register single caption	Register captions for one video
register_captions_batch	Batch caption registration	Register captions for multiple videos at once

Video Management (Video)¶

API	Description	Use Case
get_video	Retrieve single video	Check video metadata
get_all_videos	Retrieve all videos	List all registered videos

Common Workflows¶

Workflow 1: Data Exploration¶

# 1. Search metadata
metadata = api.search_metadata(
    feature_view='caption_summary',
    models=['gpt-4o']
)

# 2. Batch retrieval
captions = api.get_captions_batch(
    feature_view='caption_summary',
    metadata=metadata
)

Workflow 2: Data Registration¶

# 1. Prepare JSON file
batch_data = [...]

# 2. Batch registration
result = api.register_captions_batch(
    feature_view='caption_summary',
    json_file_path='batch.json'
)

Common Parameters¶

feature_view¶

A required parameter used in all APIs:

'video_description': Video segment captions
'audio_transcript': Video segment ASR results
'caption_summary': Video segment summary (Caption + ASR)