Media Encoder2027
Object

UniversalSearchResult

Result object that represents one search result in the universal search API. Search results can refer to any entity within the application. Source Clips, Markers, Commands etc. It is up to the client to interpret the result based on the provided type and payload.

Properties

NameType AccessDescription
String readonly The identifier of the search agent that was used to create this result.
Object readonly Return the facets that are provided by this search result.
Object readonly The hash of this search results. Identical hashes lead to the exact same rendition of an item in the UI.
String readonly The payload of the search result in JSON string format. The payload contains all data that is needed to get the actual referenced object of this search result.
Number readonly The score for the search result in range [01]. Higher numbers indicate a better match. Search agents that only match on exact hits will only return 1.0 as score for best matches.
String readonly The type of this search result. This can be e.g. 'MasterClip' 'Marker'...
Object readonly The hash of the object this search results is referring to. Generally if two search results are referencing the same object regardless of modality or details they will feature an identical universalJoinHash. A good example would be the same project item referenced by metadata and transcript search would lead to the same universalJoinHash.