All Products
Search
Document Center

Tablestore:SearchHit

Last Updated:Feb 06, 2025

SearchHit specifies the returned matched rows. The return value exists only when you use the highlight or KNN vector query feature.

Data structure

message SearchHit {
    optional double score = 3;
    optional HighlightResult highlight_result = 4;
    repeated SearchInnerHit search_inner_hits = 5;
    optional int32 nested_doc_offset = 6;
}

Parameter

Type

Required

Description

score

double

No

The relevance score.

highlight_result

HighlightResult

No

The highlighted results of a non-Nested field.

search_inner_hits

SearchInnerHit

No

The hit rows of a Nested field.

nested_doc_offset

int32

No

The start position of the child rows to return if the Nested field consists of multiple child rows.