SearchResult

Represents the search results.

JSON representation
{"id":string,"document":{object (Document)},"chunk":{object (Chunk)},"modelScores":{string:{object (DoubleList)},...},"rankSignals":{object (RankSignals)}}
Fields
id

string

Document.id of the searchedDocument.

document

object (Document)

The document data snippet in the search response. Only fields that are marked asretrievable are populated.

chunk

object (Chunk)

The chunk data in the search response if theSearchRequest.ContentSearchSpec.search_result_mode is set toCHUNKS.

modelScores

map (key: string, value: object (DoubleList))

Output only. Google provided available scores.

rankSignals

object (RankSignals)

Optional. A set of ranking signals associated with the result.

DoubleList

Double list.

JSON representation
{"values":[number]}
Fields
values[]

number

Double values.

RankSignals

A set of ranking signals.

JSON representation
{"defaultRank":number,"customSignals":[{object (CustomSignal)}],"keywordSimilarityScore":number,"relevanceScore":number,"semanticSimilarityScore":number,"pctrRank":number,"topicalityRank":number,"documentAge":number,"boostingFactor":number}
Fields
defaultRank

number

Optional. The default rank of the result.

customSignals[]

object (CustomSignal)

Optional. A list of custom clearbox signals.

keywordSimilarityScore

number

Optional. Keyword matching adjustment.

relevanceScore

number

Optional. Semantic relevance adjustment.

semanticSimilarityScore

number

Optional. Semantic similarity adjustment.

pctrRank

number

Optional. Predicted conversion rate adjustment as a rank.

topicalityRank

number

Optional. Topicality adjustment as a rank.

documentAge

number

Optional. Age of the document in hours.

boostingFactor

number

Optional. Combined custom boosts for a doc.

CustomSignal

Custom clearbox signal represented by name and value pair.

JSON representation
{"name":string,"value":number}
Fields
name

string

Optional. name of the signal.

value

number

Optional. Float value representing the ranking signal (e.g. 1.25 for BM25).

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-26 UTC.