Search

What is Search?

Search lets you locate exact moments across thousands of hours of video using natural language or an image reference. Results are split into three specialized buckets—embeddings, transcript, and ocr— So you can quickly see why something matched. The path to use search:

core/search

Running Search

Natural Language Search

To search with natural language:

resp = moonshine.run(
    flow="core/search",
    index="your-index-name",
    query="your search query, ex: red car",
    num_args=10  # optional, defaults to 5
)

Where num_args are the max number of results returned and is optional.

Image Search

To search with an image:

resp = moonshine.run(
    flow="core/search",
    image="./reference.png",  # local path or public URL
    image="path/to/image.jpg",
)

If both an image and query are supplied, the image will take precedence.

Sub-Search

Using a Subindex will isolate a search a subset of the videos in an index. To use it:

resp = moonshine.run(
    flow="core/search",
    index="your-index-name",
    query="your search query, ex: red car",
    subindex=[
        "FHXYU838JHDWK.mp4",
        "AJDIEUJDKSLW.mp4"
    ],
)

where the subindex is a list of video IDs to search within.

Search Response Format

Search returns a list of match objects. The match object schema is:

string

Moonshine-assigned file_ide.g. FHXYU838JHDWK.mp4

int

Start frame number of the match
e.g. 600

int

End frame number of the match
e.g. 725

string

Start timestamp (human-readable)
e.g. 0 min, 22 sec

string

End timestamp (human-readable)
e.g. 0 min, 34 sec

for match in resp["output"]["embeddings"]:
    file_id      = match[0]
    start_frame  = match[1]
    end_frame    = match[2]
    start_time   = match[3]
    end_time     = match[4]

Search JSON

Workflows are in a private beta. Please contact us at team@usemoonshine.com to request access.

.run(flow='core/search', ...) params

string

required

Name/ID of the parent index to search.

string

Natural-language text.
Ignored if image is supplied.

string

Local file path or public URL to an image used as the search reference.

List[str]

An optional list of file_idto narrow the search scope.

int

Max results per result-type bucket.

Get Started

Ingestion

Running Functions

Workflows

What is Search?

Running Search

Natural Language Search

Image Search

Sub-Search

Search Response Format

Search JSON

​What is Search?

​Running Search

​Natural Language Search

​Image Search

​Sub-Search

​Search Response Format

​Search JSON

What is Search?

Running Search

Natural Language Search

Image Search

Sub-Search

Search Response Format

Search JSON