SceneQuery¶

Namespace: VideoCatalogService

Type: Class

Scene query data

Definition¶

[DataContract] public class SceneQuery

Property	Type	Description
`IncludeKeywords`	`String[]`	include these scene keyords only, if empty include all
`IsIncludeKeywordsAND`	`Boolean`	default we select anything that match any of the scene keywords, is this is set we match all the keywords
`IsIncludeExtendedPropertiesAND`	`Boolean`	default we select anything that match any of the extended properties, is this is set we match all the keywords
`DescribeText`	`String`	Visual search (10.4): what the user typed. The program encodes it into `QueryEmbedding` before the search; kept for titles and saved filters.
`QueryEmbedding`	`Byte[]`	Visual search: the encoded query vector (fp16) in the search index's space. Set by the program from `DescribeText`; ranks the candidate thumbnails, best first.
`QueryEmbeddingModelId`	`String`	Visual search: encoder that produced `QueryEmbedding`; must equal the catalog index's model id or the search is refused.
`SimilarToThumbnailId`	`Int64`	Visual search: rank by likeness to this thumbnail's stored vector instead of a description (0 = none). Needs no encoder.
`MaxVisualResults`	`Int32`	Visual search: how many of the best matches to return; 0 = the default (200).
`MaxVisualResultsPerVideo`	`Int32`	Visual search: at most this many scenes from any one video among the matches; 0 = no limit. The frames of one shot score alike, so without it a single video can fill the list.

Field	Type	Description
`IncludeExtendedProperties`	`ExtendedVideoQuery[]`	Match extended properties on thumbnails