Package com.google.cloud.discoveryengine.v1

Interface SearchResponse.SearchResultOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchResponse.SearchResult, SearchResponse.SearchResult.Builder
Enclosing class:
SearchResponse
public static interface SearchResponse.SearchResultOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsModelScores(String key)
    Output only.
    Chunk
    getChunk()
    The chunk data in the search response if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
    ChunkOrBuilder
    getChunkOrBuilder()
    The chunk data in the search response if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
    Document
    getDocument()
    The document data snippet in the search response.
    DocumentOrBuilder
    getDocumentOrBuilder()
    The document data snippet in the search response.
    String
    getId()
    [Document.id][google.cloud.discoveryengine.v1.Document.id] of the searched [Document][google.cloud.discoveryengine.v1.Document].
    com.google.protobuf.ByteString
    getIdBytes()
    [Document.id][google.cloud.discoveryengine.v1.Document.id] of the searched [Document][google.cloud.discoveryengine.v1.Document].
    Map<String,DoubleList>
    getModelScores()
    Deprecated.
    int
    getModelScoresCount()
    Output only.
    Map<String,DoubleList>
    getModelScoresMap()
    Output only.
    DoubleList
    getModelScoresOrDefault(String key, DoubleList defaultValue)
    Output only.
    DoubleList
    getModelScoresOrThrow(String key)
    Output only.
    SearchResponse.SearchResult.RankSignals
    getRankSignals()
    Optional.
    SearchResponse.SearchResult.RankSignalsOrBuilder
    getRankSignalsOrBuilder()
    Optional.
    boolean
    hasChunk()
    The chunk data in the search response if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
    boolean
    hasDocument()
    The document data snippet in the search response.
    boolean
    hasRankSignals()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
       [Document.id][google.cloud.discoveryengine.v1.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1.Document].
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       [Document.id][google.cloud.discoveryengine.v1.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1.Document].
      string id = 1;
      Returns:
      The bytes for id.

    • hasDocument

      boolean hasDocument()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1.Document document = 2;
      Returns:
      Whether the document field is set.

    • getDocument

      Document getDocument()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1.Document document = 2;
      Returns:
      The document.

    • getDocumentOrBuilder

      DocumentOrBuilder getDocumentOrBuilder()
       The document data snippet in the search response. Only fields that are
 marked as `retrievable` are populated.
      .google.cloud.discoveryengine.v1.Document document = 2;

    • hasChunk

      boolean hasChunk()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1.Chunk chunk = 18;
      Returns:
      Whether the chunk field is set.

    • getChunk

      Chunk getChunk()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1.Chunk chunk = 18;
      Returns:
      The chunk.

    • getChunkOrBuilder

      ChunkOrBuilder getChunkOrBuilder()
       The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      .google.cloud.discoveryengine.v1.Chunk chunk = 18;

    • getModelScoresCount

      int getModelScoresCount()
       Output only. Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • containsModelScores

      boolean containsModelScores(String key)
       Output only. Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getModelScores

      @Deprecated Map<String,DoubleList> getModelScores()
      Deprecated.
      Use getModelScoresMap() instead.

    • getModelScoresMap

      Map<String,DoubleList> getModelScoresMap()
       Output only. Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getModelScoresOrDefault

      DoubleList getModelScoresOrDefault(String key, DoubleList defaultValue)
       Output only. Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getModelScoresOrThrow

      DoubleList getModelScoresOrThrow(String key)
       Output only. Google provided available scores.
      map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasRankSignals

      boolean hasRankSignals()
       Optional. A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the rankSignals field is set.

    • getRankSignals

      SearchResponse.SearchResult.RankSignals getRankSignals()
       Optional. A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The rankSignals.

    • getRankSignalsOrBuilder

      SearchResponse.SearchResult.RankSignalsOrBuilder getRankSignalsOrBuilder()
       Optional. A set of ranking signals associated with the result.
      .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];