Share via

QueryCaption Class

  • 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.2
Source:
QueryCaption.cs
Source:
QueryCaption.cs

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.

Configuration for how semantic search captions search results.

C# 
public class QueryCaption
Inheritance
Object
QueryCaption

Constructors

QueryCaption(QueryCaptionType)

Initializes a new instance of the QueryCaption class.

Properties

CaptionType

A value that specifies whether Captions should be returned as part of the search response.

The default value is None.
HighlightEnabled

If CaptionType is set to Extractive, setting this to true enables highlighting of the returned captions. It populates Highlights.

The default value is true.
MaxCharLength

A value that specifies the maximum character length for captions returned as part of the search response. Optional and defaults to null.

Applies to

Product Versions
Azure SDK for .NET Latest, Preview