Console
    Start free

    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 searched Document .
    document

    object ( Document )

    The document data snippet in the search response. Only fields that are marked as retrievable are populated.
    chunk

    object ( Chunk )

    The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS .
    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 
 
) 
 } 
 ] 
 , 
 "precomputedExpressionValues" 
 : 
 [ 
 number 
 ] 
 , 
 "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.
    precomputedExpressionValues[]

    number

    Optional. A list of precomputed expression results for a given document, in the same order as requested in SearchRequest.custom_ranking_params.expressions_to_precompute .
    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).
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: