Search Behavior and Commands for KMC and for the Sphinx API

Printer-friendly version

For information pertaining Kaltura Elastic-Based Search, please see the Kaltura Search Module User Guide and/or the Kaltura Search Module Administration Guide.

 

The following topics are described:

Search Behavior in the KMC

  1. The Kaltura search engine will match the search term within the KMC search box against the following entry attributes:
    • Entry Name 
    • Entry ID
    • Entry Tags
    • Entry Description
    • Entry Reference ID
    • Entry owner ID
    • Entry ID of origin entry for clips created in Kaltura
    • any Entry custom data fields of type: text that was set to be searchable
  2. Search criteria may include alphanumeric as well as special characters such as: `, ~, @, #, $, %, ^, &, (, ), -, _, =, +, [, ], {, }, ;, :, ', \, |, /, ?, <, >. 
  3. The spacebar is treated as an AND search operand.
    For example, searching for” hello world” will result with all entries that include both the word hello and the word world in one of the searchable entry attributes.
  4. The comma (,) character is treated as an OR search operand.
    For example, searching for hello, world will result with all entries that include either the word hello, or the word world in one of the searchable entry attributes.
  5. The exclamation (!) character is treated as an AND NOT search operand.
    For example, searching for hello! world should result with all entries that include the word hello but do not include the word world. The (!) character should be attached to the wanted results, in this example the word "hello".

     

    NOTE: The ! at the beginning of the search criteria is not supported within this AND NOT operand context.  To search for words that start/end with, or contain the ! character, you have to enter \! (backslash then exclamation mark) in the search field.  
    For example, if you want to search for entries that include the word !hello or hello!, enter the following terms within the KMC search box: \!hello or hello\!

  6. The exact match search is not available as a search operand. The  quote ("") characters are NOT treated as an EXACT MATCH search operand. 
    For example, searching for "hello world" will not yield any results.
  • Partial search – Kaltura does not support a partial word search. For example, searching for the the word ‘helloworld’ is resulted in a search but searching for ‘hello’ or ‘world’ will not produce the desired reuslt.
  • Kaltura supports a partial wildcard search. You can append a search word with 3 or more characters with an asterisk * at the end of the word. For example, searching for the string hello* should result in all words beginning with hello, including helloworld.  The asterisk only works as a wildcard at the end of a term. It cannot be used as a wildcard at the beginning or in the middle of a term.

It is possible to escape the * a and ! characters and treat them as literals using a backslash. 

Search Behavior for the Kaltura API

Operators

The following special operators can be used in a free text search field in the Kaltura API:

  • Exclamation mark (!) - AND NOT . Note that AND NOT is not a unary NOT operator. A positive search word must appear before the AND phrase. See here for additional information.
  • Double Quotes ("") - are treated as an EXACT MATCH search operand.
  • Backslash (\) - escape. To search for the character ! you have to enter \! in the search field.
  • Comma (,) - OR
  • Spacebar - AND

Blend Chars

Blended characters are indexed both as separators and valid characters. For instance, assume that & is configured as blended and AT&T occurs in an indexed document. Three different keywords will get indexed, namely "at&t", treating blended characters as valid, plus "at" and "t", treating them as separators.

The following blend chars are configured for the API search.

!, $, ', (, ), *, -, /, :, ;, <, =, #, [, \, ], ^, `, {, |, }, ~, %, &, +, >, ?, @, _

These blend characters may be used as delimiters or as characters.

 

For more information, see the article How to perform AND, OR, NOT and Exact Match searches Using the Kaltura API with Shpinx.

FAQ Type: