Create Search Index

Indexes resulting video clips with object, event, text and scene metadata so they are searchable using Lumeo AI Search.

Overview

The "Create Search Index" node indexes resulting video clips with object, event, text and scene metadata so they are searchable using Lumeo AI Search. Add this node after any upstream AI Model, OCR, Caption Generator nodes, and add a Save Clip node downstream of this node that saves to Lumeo Cloud.

Inputs & Outputs

  • Inputs: 1, Media Format: Raw Video
  • Outputs: 1, Media Format: Raw Video
  • Output Metadata: Search Metadata

Properties

PropertyDescriptionTypeDefaultRequired
index_objectsIf enabled, index the objects and their attributes detected in the current frame.booltrueNo
object_typesex. car,person,face.mask. Comma-separated list of object types to index. Empty list indexes all objects. Conditional on index_objects being true.model-labelsnullNo
object_modeObject index mode. Options: Labels (labels): Index each object's labels and attributes; Labels + Signature, once (signature_once): Index each object's labels, attributes and signature once; Labels + Signature, at interval (signature_interval): Index each object's labels, attributes and signature when first seen and at an interval. Conditional on index_objects being true.enumlabelsYes
object_reidIf enabled, indexes specified objects for appearance similarity search (ReID). Requires corresponding ReID model upstream to insert ReID vectors. Conditional on index_objects being true.boolfalseNo
index_eventsIf enabled, index any events inserted into the metadata by upstream Event nodes.booltrueNo
index_textsIf enabled, index the resulting text descriptions from upstream nodes like Caption Generator and OCR.booltrueNo
index_vectorsIf enabled, index the scene extracted from the current image.booltrueNo
vectors_modeScene index mode. Options: Interval (interval); Trigger (trigger); Interval and trigger (interval_and_trigger). Conditional on index_vectors being true.enumintervalYes
trigger_typeIndex the scene automatically when key metadata changes, or using a custom trigger. Options: Auto trigger (auto_trigger); Custom trigger (custom_trigger). Conditional on index_vectors being true.enumauto_triggerYes
triggerCustom trigger condition, if Trigger type is set to Custom trigger. Conditional on index_vectors being true.trigger-conditionnullNo
intervalIndex the scene and/or objects at this interval. Unit: seconds.number1No
object_min_presenceDuration in seconds for which an object must be seen before indexing its signature. Applies to signature_once and signature_interval modes. Unit: seconds.number0No

Output Metadata

The fields below are declared by this node's metadata schema; the JSON values are representative examples.

PathTypeDescription
search.typestringCategory of the search metadata entry.
search.eventsarrayArray of event names collected from upstream metadata for search indexing.
search.objectsarrayArray of object and attribute labels collected for search indexing.
search.textsarrayArray of text records collected for search indexing.
search.trackablesarrayArray of trackable identifiers collected from object attributes for search indexing.
search.text_embeddings[].model_typestringEmbedding model that produced this vector.
search.text_embeddings[].vectorarrayArray of normalized embedding values.
search.vectors[].model_typestringEmbedding model that produced this vector.
search.vectors[].vectorarrayArray of normalized embedding values.

JSON example

{
  "search": {
    "events": [],
    "objects": [],
    "text_embeddings": [
      {
        "model_type": "value",
        "vector": []
      }
    ],
    "texts": [],
    "trackables": [],
    "type": "value",
    "vectors": [
      {
        "model_type": "value",
        "vector": []
      }
    ]
  }
}

Did this page help you?