com.google.cloud.discoveryengine.v1beta

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 and Description
boolean	containsModelScores(String key) Google provided available scores.
Chunk	getChunk() The chunk data in the search response if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
ChunkOrBuilder	getChunkOrBuilder() The chunk data in the search response if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1beta.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.v1beta.Document.id] of the searched [Document][google.cloud.discoveryengine.v1beta.Document].
com.google.protobuf.ByteString	getIdBytes() [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the searched [Document][google.cloud.discoveryengine.v1beta.Document].
Map<String,DoubleList>	getModelScores() Deprecated.
int	getModelScoresCount() Google provided available scores.
Map<String,DoubleList>	getModelScoresMap() Google provided available scores.
DoubleList	getModelScoresOrDefault(String key, DoubleList defaultValue) Google provided available scores.
DoubleList	getModelScoresOrThrow(String key) Google provided available scores.
boolean	hasChunk() The chunk data in the search response if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
boolean	hasDocument() The document data snippet in the search response.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getId

String getId()

 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.Document].
 

string id = 1;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] of the
 searched [Document][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.Document document = 2;

hasChunk

boolean hasChunk()

 The chunk data in the search response if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
 

.google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
 

.google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
 

.google.cloud.discoveryengine.v1beta.Chunk chunk = 18;

getModelScoresCount

int getModelScoresCount()

 Google provided available scores.
 

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

containsModelScores

boolean containsModelScores(String key)

 Google provided available scores.
 

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

getModelScores

@Deprecated
Map<String,DoubleList> getModelScores()

Deprecated.

Use getModelScoresMap() instead.

getModelScoresMap

Map<String,DoubleList> getModelScoresMap()

 Google provided available scores.
 

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

getModelScoresOrDefault

DoubleList getModelScoresOrDefault(String key,
                                   DoubleList defaultValue)

 Google provided available scores.
 

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;

getModelScoresOrThrow

DoubleList getModelScoresOrThrow(String key)

 Google provided available scores.
 

map<string, .google.cloud.discoveryengine.v1beta.DoubleList> model_scores = 4;