QueryCaptionResult interface

Package:: @azure/search-documents

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.

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.

Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

highlights

Same text passage as in the Text property with highlighted phrases most relevant to the query.

highlights?: string

Property Value

string

text

A representative text passage extracted from the document most relevant to the search query.

text?: string

Property Value

string