QueryCaptionType Struct

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

QueryCaptionType.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. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.

public readonly struct QueryCaptionType : IEquatable<Azure.Search.Documents.Models.QueryCaptionType>

type QueryCaptionType = struct

Public Structure QueryCaptionType
Implements IEquatable(Of QueryCaptionType)

Inheritance

ValueType

QueryCaptionType

Implements

IEquatable<QueryCaptionType>

Constructors

QueryCaptionType(String)

Initializes a new instance of QueryCaptionType.

Properties

Extractive	Extracts captions from the matching documents that contain passages relevant to the search query.
None	Do not return captions for the query.

Methods

Equals(QueryCaptionType)	Indicates whether the current object is equal to another object of the same type.
ToString()	Returns the fully qualified type name of this instance.

Operators

Equality(QueryCaptionType, QueryCaptionType)	Determines if two QueryCaptionType values are the same.
Implicit(String to QueryCaptionType)	Converts a String to a QueryCaptionType.
Inequality(QueryCaptionType, QueryCaptionType)	Determines if two QueryCaptionType values are not the same.