At a glance
ElasticSearch as single search engine in Phraseanet introduces a break in search habits. Although the most common searches are performed the same way that in previous versions of Phraseanet, research equations evolve.
ElasticSearch search engine is free, open source and based on the Lucene project of the Apache Foundation. His advantages:
Syntaxes research evolve. Except for an exact search query or those on reserved values namespaces, search queries are...
The AND (ET in french) is used by default between words in queries. Using a space is similar to an AND.
Dogs AND Cats
Dogs Cats
Chien ET Chat
It allows to alternately search for multiple terms in Records notes.
Dogs OR Cats
Chien OU Chat
For those examples, notes of displayed media contain either the words Dogs or Cats or both of them.
Ordinal operators ALL (TOUT) and LAST (DERNIERS) do not exist in Phraseaent with ElasticSearch search engine.
To display all records for an instance, perform an empty search (click on the Search button the search field empty).
Note
To replace a search query you used to do with the LAST operator LAST, use search on records archived and updated dates.
Alternative operators are not supported in the current implementation of ElasticSearch for Phraseanet.
Note
Truncation activates or deactivates using the checkbox Use truncation in the advanced search window.
No proximity operator (Near, Before and After) is supported in the current implementation of ElasticSearch for Phraseanet.
Three operators of numerical comparisons are available:
Operators smaller than and bigger than only work in searches on numerical or date fields.
These three operators are implemented in searches by fields.
As the namespace Field is implicit, the syntax to indicate in the search field is the field name, the operator and the desired value
It works like “the field value CONTAINS”. Example for searching in a field named Title in the databox structure:
Title: Limelight (similar to field.Title: Limelight)
Title: Rambo (similar to field.Title: Rambo)
The engine performs automatic hyphenation on the empty spaces and characters. The searched term is the first term between the operator and the next space.
Important : To search for an expression contained in a field, surround the searched expression with quotes.
Example :
Title: "For Whom the Bell Tolls"
Title: "Annie Hall"
Note
In research with colons, the search engine use integrated languages analyzers to maximize results.
Operator = (equal) can be used to search for exact match value in a field (including case sensitivity).
Examples :
Title= Limelight
Title= Rio
Title= "The artist"
Title= "Everything You Always Wanted to Know About Sex (But Were Afraid to Ask)"
Note
Research with equal not implement any processing language or syntax.
A search in a date field exploits can be performed with equal or arithmetic comparison operators for a given field.
Examples for a query in a field named Date :
Date < "2016/01/01" (before 2016/01/01)
Date = "2016/01/01" (is 2016/01/01)
Date > "2015/07/01" (strictly after 2015/07/01)
Date >= "2015/12/31" (2015/12/31 or after)
Elasticsearch native metadata created_on and updated_on allow search on dates of additions or of notes changes.
created_on is the native metadata indicating the date of addition of a document in a databox or the creation date of a Phraseanet story.
updated_on is the native metadata indicating the update date of the asset (caption editing, changes on the document).
created_at and updated_at are alias of these metadata.
Examples:
created_on> 2016/04/18 (for records created after 2016/04/18)
updated_on< 2016/03/18 (for records updated before 2016/03/18)
created_on= 2016/04/18 (for records created on 2016/04/18)
created_on= 2016/04 (for records created on April 2016 (> or < do not work))
created_on= 2015 (for records created on 2015 (> or < do not work))
The reserved value _unset_ associated with a field is used to find all the records on which the value of this field has not been filled.
Example “Find all the records whose Title field is not filled in”:
Title=_unset_
Conversely, the reserved value _set_ associated with a field is used to find all the records on which a value has been entered for this field.
Example “Find all the records for which the Title field is filled in”:
Title=_set_
This approach is to query databases and collections through the Phraseanet thesaurus.
This type of research is performed by clicking on a term in the displayed thesaurus in the Thesaurus tab in the work zone or by filling in the search form of a term or phrase into brackets.
Examples:
[Aerospace]
[Hong Kong cinema]
Searches can be restricted to a particular field from the documentary structure by mixing the field query “contains” syntax and the thesaurus query syntax.
PersonInImage:[Members of the House of Windsor]
In the search form, search on the Status can be done with the reserved namespace flag and the name of the status. The state of the status can be true or false.
Example for a status named Checked:
flag.Checked:true (to match records with the Checked status raised)
Search is possible on technical attributes of documents, according to their types.
These attributes are present only if they have been written by the firmware of the device used to capture, the retouching or mounting software.
Operators :, =, <, <=, >= >, can be used.
Examples of metadata attributes for Phraseanet image type documents:
| Metadata | Description of the metadata and example of use |
|---|---|
| meta.Width | Width in pixels meta.Width>3000 |
| meta.Height | Height in pixels meta.Heigh>= 2400 for images whose height is greater than or equal to 2400 px. |
| meta.FocalLength | Focal lenght used for capture |
| meta.Channels | Number of channels used for color coding 1 : Greyscale 3 : RGB color coding 4 : CMYK color coding meta.Channels= 1 (Display all images in greyscale) |
| meta.ColorDepth | Color depth, number of bits used for coding each channel. meta.ColorDepth> 8 (All images with the colors of the code channels are greater than 8 bits) |
| meta.CameraModel | Name of the divice meta.CameraModel: iphone (All images captured using an iphone) |
| meta.FlashFired | Flash trigger. This meta returns true or false. meta.FlashFired= true |
| meta.Aperture | Lens aperture meta.Aperture > 2.8 |
| meta.ShutterSpeed | Recorded shutter speed |
| meta.HyperfocalDistance | Distance for which, since the camera film plane, subjects are net to infinity. |
| meta.ISO | ISO sensitivity meta.ISO < 400 |
| meta.LightValue | Illuminant value |
| meta.ColorSpace | Colorspace for images |
| meta.Orientation | Indication of the orientation of the image |
| meta.Longitude | Longitude recorded by the shooting device |
| meta.Latitude | Latitude recorded by the shooting device |
| meta.MimeType | Mime type of the original document |
| meta.FileSize | Original document file size |
Examples of metadata attributes for Phraseanet audio type documents:
| Metadata | Description of the metadata and example of use |
|---|---|
| meta.Duration | Duration for video in seconds meta.Duration>300 for audio greater than 5 minutes lenght. |
| meta.MimeType | Original document mime type |
| meta.FileSize | Original document file size in bytes |
Examples of metadata attributes for Phraseanet video type documents:
| Metadata | Description of the metadata and example of use |
|---|---|
| meta.Width | Video width in pixels |
| meta.Height | Horizontal lines of vertical resolution (or height number of pixels) meta.Height= 1080 for video in 1080 lines or Full HD |
| meta.Duration | Video duration in seconds |
| meta.FrameRate | Number of frames per second |
| meta.AudioSamplerate | The value of sampling |
| meta.VideoCodec | Image video coding/decoding algorithm in the original file |
| meta.AudioCodec | Audio coding/decoding algorithm in the original file |
| meta.Orientation | Orientation of the device during video capture |
| meta.MimeType | Mime type of the original file |
| meta.Duration | Video duration in seconds meta.Duration>300 for video greater than 5 minutes. |
| meta.MimeType | Original document mime type |
| meta.FileSize | Original document file size in bytes |
Examples of metadata attributes for Phraseanet document type documents:
| meta.MimeType | Mime type of the original file |
|---|---|
| meta.FileSize | Original document file size in bytes |
Syntax is: recordid:the_record_id
Example, to display the record unique number id 804 in a database:
recordid:804
Note
Comparison operators =, < ou > are not implemented.
To search records belonging to a phraseanet collection, use the syntax collection:”the given name for the collection”.
Example:
collection:"Alchemy support"
Important : Respect case sensitivity and the exact name given to the phraseanet collection.
To search records belonging to a database, use the syntax database:”the base alias”.
Example:
database:"Parade Test Database"
Important : Respect case sensitivity and the exact alias name given to the base.
To search for documents by their Universally Unique IDentifier (UUID), use the syntax uuid:”the-Universally-Unique-IDentifier”.
Example:
uuid:"4d006e01-bc38-4aac-9a5b-2c90ffe3a8a2"
Important : Because UIID contains empty characters (dashes) it must be surrounded by quotation marks.
To search for documents by their SHA256 hash keys, use the syntax sha256:thesha256numbersequence.
Example:
sha256:a7f3ec01c4c5efcadc639d494d432006f13b28b9a576afaee4d3b7508c4be074