SemanticSearchOptions.QueryCaption Property

  • Reference

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SemanticSearchOptions.cs
Source:
SemanticSearchOptions.cs

This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-(true/false)' option, such as 'extractive|highlight-true'. Defaults to 'None'.

public Azure.Search.Documents.Models.QueryCaption QueryCaption { get; set; }
member this.QueryCaption : Azure.Search.Documents.Models.QueryCaption with get, set
Public Property QueryCaption As QueryCaption

Property Value

QueryCaption

Applies to