CDS Videos

Search guide

This guide explains how to perform search queries on CDS Videos using easy to understand examples.

Simple search (one or multiple terms)

Example: dark matter

Results will match records with the terms dark or matter in any field.

You can require presence of both terms using either the + or AND operator:

Examples: +dark +matter or dark AND matter

You can require absence of one or more terms using either the - or NOT operator:

Examples: -dark +matter or NOT dark AND matter

Phrase search

Example: "dark matter"

Results will match records with the phrase dark matter in any field.

Field search

Example: title.title:matter

Results will match records with the term matter in the field title. If you want to search for multiple terms in the title you must group the terms using parenthesis:

Example: title.title:(dark matter)

See the field reference below for the full list of fields you can search.

Combined simple, phrase or field search

Example: +title.title:"dark matter" -title.title:experiment or title.title:(-dark +matter)

You can combine simple, phrase and field search to construct advanced search queries.

Range search

Example: date:[2015-01-01 TO 2015-03-31] (note, you must capitalize TO).

Results will match any record with a publication date between 2015-01-01 and 2015-03-31 (both dates inclusive).

Use square brackets ([]) for inclusive ranges and use curly brackets ({}) for exclusive ranges.

Examples of other ranges:

  • date:{* TO 2017-01-01} - All days until 2017.
  • date:[2017-01-01 TO *] - All days from 2017.

Examples of searches on video files characteristics

File formats

Results will match records with files in AVI, MPEG, MP4 and MOV format, respectively.

Results will match records with files in MPEG format and size less than 100 MB (note that size is recorded in bytes).

Aspect ratio

Results will match records with files in MPEG format and aspect ratio 4:3 and 16:9, respectively.

Ranking/Sorting

By default all searches are sorted according to an internal ranking algorithm that scores each match against your query. In both the user interface and REST API, it's possible to sort the results by:

  • Most recent
  • Least recent
  • Title (in ascending order)
  • Title (in descending order)

Missing values

It is possible to search for records that either are missing a value or have a value in a specific field using the _exists_ and _missing_ field names.

Example: _missing_:location AND title.title:"Passport Big Bang" (records with Passport Big Bang in the title without location)

Example: _exists_:related_links (all records with related links)

Advanced concepts

Boosting

You can use the boost operator ^ when one term is more relevant than another. For instance, you can search for all records with the phrase Dark matter in either title or description field, but rank records with the phrase in the title field higher:

Example: title:"dark matter"^5 description:"dark matter"

Note: ^ is followed by a positive floating point number specifying the boost value compared to the default 1.

Fuzziness

You can search for terms similar to but not exactly like your search term using the fuzzy operator ~.

Example: drak~

Results will match records with terms similar to drak which would e.g. also match dark.

Proximity searches

A phrase search like "president visit" by default expect all terms in exactly the same order, and thus for instance would not match a record containing the phrase "Visit of his excellency the President of...". A proximity search allows that the terms are not in the exact order and may include other terms inbetween. The degree of flexiblity is specified by an integer afterwards:

Example: "president visit"~10

Wildcards

You can use wildcards in search terms to replace a single character (using ? operator) or zero or more characters (using * operator).

Example: title.title:(crab cavit*)

The result will match videos with title referring to cavities also in languages other than english.

Wildcard searches can be slow and should normally be avoided if possible.


Fields reference

The table below lists the data type of each field. Below is a quick description of what each data type means and what is possible.

  • string: Field does not require exact match (example field: title.title).
  • CV: Controlled vocabularies but take only a specific list of values.
  • datetime: An ISO8601 date or datetime, e.g. 2017-12-31 (range queries possible).
  • boolean: true or false.

In case of multiple subfields, (\*) applies to all of them

Field name Type Notes
category string Category of the project
contributors.\* string Contributors name, affiliation, role
contributors.affiliations string Affiliation(s) for the purpose of this specific record
contributors.name string Full name of person. Personal name format: family, given
contributors.role CV See "Contributor roles (CV)" below.
copyright.\* string Copyright
copyright.holder string The party holding the legal copyright to the record
copyright.year string The year during which the claimed copyright for the CreativeWork was first asserted
date datetime Date of the video recording or other event in the lifecycle of the resource
description string An account of the resource. Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource
duration string Duration
language CV A language of the resource, e.g. en for english, fr for french, es for spanish
license.\* string License
license.license string License name
license.credit string Credit
license.url string Credit
location string Place or location
publication_date datetime When the record is published
recid number Record identifier
related_links.\* string Related links
related_links.name string Related link name
related_links.url string Related URL
report_number string Report number
title.title string A name given to the resource. Typically, a Title will be a name by which the resource is formally known
type string Type of the project

Contributor roles (CV)

  • Animations by
  • Camera Operator
  • Comments by
  • Co-Producer
  • Creator
  • Credits
  • Director
  • Editor
  • Music by
  • Narrator
  • Photography
  • Producer
  • Reporter
  • Screenwriter
  • Speaker
  • Translator