Interface SearchResponse.SearchResultOrBuilder (0.36.0)

Version 0.36.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface SearchResponse.SearchResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsModelScores(String key)

public abstract boolean containsModelScores(String key)

Google provided available scores.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getChunk()

public abstract Chunk getChunk()

The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

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

Returns
Type	Description
Chunk	The chunk.

getChunkOrBuilder()

public abstract ChunkOrBuilder getChunkOrBuilder()

The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

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

Returns
Type	Description
ChunkOrBuilder

getDocument()

public abstract Document getDocument()

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

.google.cloud.discoveryengine.v1alpha.Document document = 2;

Returns
Type	Description
Document	The document.

getDocumentOrBuilder()

public abstract DocumentOrBuilder getDocumentOrBuilder()

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

.google.cloud.discoveryengine.v1alpha.Document document = 2;

Returns
Type	Description
DocumentOrBuilder

getId()

public abstract String getId()

Document.id of the searched Document.

string id = 1;

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

Document.id of the searched Document.

string id = 1;

Returns
Type	Description
ByteString	The bytes for id.

getModelScores() (deprecated)

public abstract Map<String,DoubleList> getModelScores()

Use #getModelScoresMap() instead.

Returns
Type	Description
Map<String,DoubleList>

getModelScoresCount()

public abstract int getModelScoresCount()

Google provided available scores.

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

Returns
Type	Description
int

getModelScoresMap()

public abstract Map<String,DoubleList> getModelScoresMap()

Google provided available scores.

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

Returns
Type	Description
Map<String,DoubleList>

getModelScoresOrDefault(String key, DoubleList defaultValue)

public abstract DoubleList getModelScoresOrDefault(String key, DoubleList defaultValue)

Google provided available scores.

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

Parameters
Name	Description
key	String
defaultValue	DoubleList

Returns
Type	Description
DoubleList

getModelScoresOrThrow(String key)

public abstract DoubleList getModelScoresOrThrow(String key)

Google provided available scores.

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

Parameter
Name	Description
key	String

Returns
Type	Description
DoubleList

hasChunk()

public abstract boolean hasChunk()

The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

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

Returns
Type	Description
boolean	Whether the chunk field is set.

hasDocument()

public abstract boolean hasDocument()

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

.google.cloud.discoveryengine.v1alpha.Document document = 2;

Returns
Type	Description
boolean	Whether the document field is set.