SearchModelFactory.QueryCaptionResult Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type semantic.
public static Azure.Search.Documents.Models.QueryCaptionResult QueryCaptionResult(string text = default, string highlights = default, System.Collections.Generic.IReadOnlyDictionary<string,object> additionalProperties = default);static member QueryCaptionResult : string * string * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Azure.Search.Documents.Models.QueryCaptionResultPublic Shared Function QueryCaptionResult (Optional text As String = Nothing, Optional highlights As String = Nothing, Optional additionalProperties As IReadOnlyDictionary(Of String, Object) = Nothing) As QueryCaptionResultParameters
- text
- String
A representative text passage extracted from the document most relevant to the search query.
- highlights
- String
Same text passage as in the Text property with highlighted phrases most relevant to the query.
- additionalProperties
- IReadOnlyDictionary<String,Object>
Returns
A new QueryCaptionResult instance for mocking.
