Search across video files and segments to find relevant content

List of collection IDs to search within.

For text search (scope='file' or 'segment'): All collections must be of collection_type 'media-descriptions', 'rich-transcripts', 'metadata', or 'entities'. For file-level search, 'media-descriptions' and 'rich-transcripts' collections must have 'enable_summary: true' in their config. 'metadata' collections only support scope='file'. 'entities' collections are searchable at the scope matching their extraction level: file-level extraction (enable_video_level_entities or enable_metadata_mode) supports scope='file' only, segment-level extraction (enable_segment_level_entities) supports scope='segment' only.

For face search (scope='face'): All collections must be of collection_type 'face-analysis'.

For moment search (scope='moment'): All collections must be of collection_type 'moments'.

Specifies the type(s) of search to execute. When multiple modalities are specified, a hybrid search is executed that combines results from each modality.

Available modalities:

• general_content: baseline for matching the content of the search item (file/segment) based on visual or spoken content similarity to provided short natural language query string
• speech_lexical: performs keyword based search (e.g. query of president matching president or presidential strings) and exact match (e.g. specifically find mentions of "Barack Obama" or "Donald Trump") against speech content present in search item
• ocr_lexical: performs keyword based search and exact match against screen text content present in search item
• tag_semantic: performs basic word semantic similarity search against tag values associated with search items (e.g. query=animal expected to match tags with value containing dog or cat)
• tag_lexical: performs keyword based search and exact match against tag values associated with search items
• doc_lexical: performs keyword based search and exact match against file-level documents (generated summaries, metadata-collection docs, and entity-collection docs). Only applicable when search scope=file.

Only applicable when search scope=file or scope=segment.

Filter eligible search items by presence of one or more labels in the provided list (otherwise all tags will be considered in search response). Only supported for tag_semantic and tag_lexical search modalities

Specifies the type(s) of search to execute. When multiple modalities are specified, a hybrid search is executed that combines results from each modality.

Available modalities:

• general_content: baseline for matching the content of the search item (file/segment) based on visual or spoken content similarity to provided short natural language query string
• speech_lexical: performs keyword based search (e.g. query of president matching president or presidential strings) and exact match (e.g. specifically find mentions of "Barack Obama" or "Donald Trump") against speech content present in search item
• ocr_lexical: performs keyword based search and exact match against screen text content present in search item
• tag_semantic: performs basic word semantic similarity search against tag values associated with search items (e.g. query=animal expected to match tags with value containing dog or cat)
• tag_lexical: performs keyword based search and exact match against tag values associated with search items
• doc_lexical: performs keyword based search and exact match against file-level documents (generated summaries, metadata-collection docs, and entity-collection docs). Only applicable when search scope=file.

Only applicable when search scope=file or scope=segment.