Share via

QueryCaptionResult interface

  • Reference
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

highlights

Same text passage as in the Text property with highlighted phrases most relevant to the query. NOTE: This property will not be serialized. It can only be populated by the server.
text

A representative text passage extracted from the document most relevant to the search query. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

highlights

Same text passage as in the Text property with highlighted phrases most relevant to the query. NOTE: This property will not be serialized. It can only be populated by the server.

highlights?: string

Property Value

string

text

A representative text passage extracted from the document most relevant to the search query. NOTE: This property will not be serialized. It can only be populated by the server.

text?: string

Property Value

string