VideoDB icon

VideoDB

Interact with the VideoDB API

Overview

This node integrates with the VideoDB API to perform various operations related to video collections. Specifically, the "Search in a Collection" operation allows users to search within a specified video collection using semantic search techniques. This is useful for finding relevant video segments, scenes, or spoken words based on a query string.

Practical scenarios include:

  • Searching for specific spoken phrases or scenes within a large video archive.
  • Filtering video content by semantic relevance to user queries.
  • Enhancing video content management systems by enabling detailed search capabilities.

Properties

Name Meaning
Collection Name or ID Select a video collection from a list or specify its ID via an expression.
Query The search query string used to find matching content within the collection.
Search Type Type of search to perform; currently only "Semantic" search is supported.
Index Type The type of index to search against: either "Spoken Word" (transcribed speech) or "Scene" (video scenes).
Result Threshold Minimum number of results to return (numeric threshold).
Score Threshold Minimum score value that a result must have to be included.
Dynamic Score Percentage A numeric value influencing how scores are dynamically adjusted during search.

Output

The node outputs JSON data containing the raw response from the VideoDB API's search endpoint. This typically includes matched video segments or scenes along with metadata such as relevance scores and timestamps.

If binary data were involved (e.g., video clips), it would be indicated here, but this operation focuses on JSON search results only.

Dependencies

  • Requires an API key credential for authenticating with the VideoDB API.
  • The base URL for the API defaults to https://api.videodb.io but can be customized via credentials.
  • Uses HTTP requests with authentication to communicate with the VideoDB service.

Troubleshooting

  • Common Issues:

    • Invalid or missing API key will cause authentication failures.
    • Specifying a non-existent collection ID will result in empty or error responses.
    • Providing an empty query string will likely return no results or an error.
  • Error Messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • HTTP request failures may indicate network issues or incorrect base URL configuration.
    • If no results are returned, check that the collection contains indexed data matching the query parameters.

Links and References

Discussion