QueryCaptionResult Class

Definition

Namespace:: Azure.Search.Documents.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.7

Source:: QueryCaptionResult.cs

Source:: QueryCaptionResult.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.

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 class QueryCaptionResult

public class QueryCaptionResult : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Models.QueryCaptionResult>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Models.QueryCaptionResult>

type QueryCaptionResult = class

type QueryCaptionResult = class
    interface IJsonModel<QueryCaptionResult>
    interface IPersistableModel<QueryCaptionResult>

Public Class QueryCaptionResult

Public Class QueryCaptionResult
Implements IJsonModel(Of QueryCaptionResult), IPersistableModel(Of QueryCaptionResult)

Inheritance: Object
QueryCaptionResult

Implements: IJsonModel<QueryCaptionResult> IPersistableModel<QueryCaptionResult> IPersistableModel<T>

Properties

AdditionalProperties	Additional Properties.
Highlights	Same text passage as in the Text property with highlighted phrases most relevant to the query.
Text	A representative text passage extracted from the document most relevant to the search query.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<QueryCaptionResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<QueryCaptionResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<QueryCaptionResult>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<QueryCaptionResult>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<QueryCaptionResult>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to