Share via

QueryAnswerResult interface

  • Reference
Package:
@azure/search-documents

An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected.

Properties

highlights

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

The key of the document the answer was extracted from. NOTE: This property will not be serialized. It can only be populated by the server.
score

The score value represents how relevant the answer is to the query relative to other answers returned for the query. NOTE: This property will not be serialized. It can only be populated by the server.
text

The text passage extracted from the document contents as the answer. 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 text 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

key

The key of the document the answer was extracted from. NOTE: This property will not be serialized. It can only be populated by the server.

key: string

Property Value

string

score

The score value represents how relevant the answer is to the query relative to other answers returned for the query. NOTE: This property will not be serialized. It can only be populated by the server.

score: number

Property Value

number

text

The text passage extracted from the document contents as the answer. NOTE: This property will not be serialized. It can only be populated by the server.

text: string

Property Value

string