public static final class SearchResponse.SearchResult.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder> implements SearchResponse.SearchResultOrBuilder
Represents the search results.Protobuf type
google.cloud.discoveryengine.v1.SearchResponse.SearchResult| Modifier and Type | Method and Description |
|---|---|
SearchResponse.SearchResult |
build() |
SearchResponse.SearchResult |
buildPartial() |
SearchResponse.SearchResult.Builder |
clear() |
SearchResponse.SearchResult.Builder |
clearChunk()
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].
|
SearchResponse.SearchResult.Builder |
clearDocument()
The document data snippet in the search response.
|
SearchResponse.SearchResult.Builder |
clearId()
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the
searched [Document][google.cloud.discoveryengine.v1.Document].
|
SearchResponse.SearchResult.Builder |
clearModelScores() |
SearchResponse.SearchResult.Builder |
clearRankSignals()
Optional.
|
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].
|
Chunk.Builder |
getChunkBuilder()
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].
|
SearchResponse.SearchResult |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Document |
getDocument()
The document data snippet in the search response.
|
Document.Builder |
getDocumentBuilder()
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.
|
Map<String,DoubleList> |
getMutableModelScores()
Deprecated.
|
SearchResponse.SearchResult.RankSignals |
getRankSignals()
Optional.
|
SearchResponse.SearchResult.RankSignals.Builder |
getRankSignalsBuilder()
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.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number) |
boolean |
isInitialized() |
SearchResponse.SearchResult.Builder |
mergeChunk(Chunk value)
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].
|
SearchResponse.SearchResult.Builder |
mergeDocument(Document value)
The document data snippet in the search response.
|
SearchResponse.SearchResult.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SearchResponse.SearchResult.Builder |
mergeFrom(com.google.protobuf.Message other) |
SearchResponse.SearchResult.Builder |
mergeFrom(SearchResponse.SearchResult other) |
SearchResponse.SearchResult.Builder |
mergeRankSignals(SearchResponse.SearchResult.RankSignals value)
Optional.
|
SearchResponse.SearchResult.Builder |
putAllModelScores(Map<String,DoubleList> values)
Output only.
|
SearchResponse.SearchResult.Builder |
putModelScores(String key,
DoubleList value)
Output only.
|
DoubleList.Builder |
putModelScoresBuilderIfAbsent(String key)
Output only.
|
SearchResponse.SearchResult.Builder |
removeModelScores(String key)
Output only.
|
SearchResponse.SearchResult.Builder |
setChunk(Chunk.Builder builderForValue)
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].
|
SearchResponse.SearchResult.Builder |
setChunk(Chunk value)
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].
|
SearchResponse.SearchResult.Builder |
setDocument(Document.Builder builderForValue)
The document data snippet in the search response.
|
SearchResponse.SearchResult.Builder |
setDocument(Document value)
The document data snippet in the search response.
|
SearchResponse.SearchResult.Builder |
setId(String value)
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the
searched [Document][google.cloud.discoveryengine.v1.Document].
|
SearchResponse.SearchResult.Builder |
setIdBytes(com.google.protobuf.ByteString value)
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the
searched [Document][google.cloud.discoveryengine.v1.Document].
|
SearchResponse.SearchResult.Builder |
setRankSignals(SearchResponse.SearchResult.RankSignals.Builder builderForValue)
Optional.
|
SearchResponse.SearchResult.Builder |
setRankSignals(SearchResponse.SearchResult.RankSignals value)
Optional.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>public SearchResponse.SearchResult.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>public SearchResponse.SearchResult getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchResponse.SearchResult build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchResponse.SearchResult buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchResponse.SearchResult.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.Builder>public SearchResponse.SearchResult.Builder mergeFrom(SearchResponse.SearchResult other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.Builder>public SearchResponse.SearchResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.Builder>IOExceptionpublic String getId()
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the searched [Document][google.cloud.discoveryengine.v1.Document].
string id = 1;getId in interface SearchResponse.SearchResultOrBuilderpublic 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;getIdBytes in interface SearchResponse.SearchResultOrBuilderpublic SearchResponse.SearchResult.Builder setId(String value)
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the searched [Document][google.cloud.discoveryengine.v1.Document].
string id = 1;value - The id to set.public SearchResponse.SearchResult.Builder clearId()
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the searched [Document][google.cloud.discoveryengine.v1.Document].
string id = 1;public SearchResponse.SearchResult.Builder setIdBytes(com.google.protobuf.ByteString value)
[Document.id][google.cloud.discoveryengine.v1.Document.id] of the searched [Document][google.cloud.discoveryengine.v1.Document].
string id = 1;value - The bytes for id to set.public 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;hasDocument in interface SearchResponse.SearchResultOrBuilderpublic 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;getDocument in interface SearchResponse.SearchResultOrBuilderpublic SearchResponse.SearchResult.Builder setDocument(Document value)
The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
.google.cloud.discoveryengine.v1.Document document = 2;public SearchResponse.SearchResult.Builder setDocument(Document.Builder builderForValue)
The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
.google.cloud.discoveryengine.v1.Document document = 2;public SearchResponse.SearchResult.Builder mergeDocument(Document value)
The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
.google.cloud.discoveryengine.v1.Document document = 2;public SearchResponse.SearchResult.Builder clearDocument()
The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
.google.cloud.discoveryengine.v1.Document document = 2;public Document.Builder getDocumentBuilder()
The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
.google.cloud.discoveryengine.v1.Document document = 2;public 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;getDocumentOrBuilder in interface SearchResponse.SearchResultOrBuilderpublic 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;hasChunk in interface SearchResponse.SearchResultOrBuilderpublic 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;getChunk in interface SearchResponse.SearchResultOrBuilderpublic SearchResponse.SearchResult.Builder setChunk(Chunk value)
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;public SearchResponse.SearchResult.Builder setChunk(Chunk.Builder builderForValue)
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;public SearchResponse.SearchResult.Builder mergeChunk(Chunk value)
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;public SearchResponse.SearchResult.Builder clearChunk()
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;public Chunk.Builder getChunkBuilder()
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;public 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;getChunkOrBuilder in interface SearchResponse.SearchResultOrBuilderpublic int getModelScoresCount()
SearchResponse.SearchResultOrBuilderOutput only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getModelScoresCount in interface SearchResponse.SearchResultOrBuilderpublic 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];
containsModelScores in interface SearchResponse.SearchResultOrBuilder@Deprecated public Map<String,DoubleList> getModelScores()
getModelScoresMap() instead.getModelScores in interface SearchResponse.SearchResultOrBuilderpublic 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];
getModelScoresMap in interface SearchResponse.SearchResultOrBuilderpublic 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];
getModelScoresOrDefault in interface SearchResponse.SearchResultOrBuilderpublic 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];
getModelScoresOrThrow in interface SearchResponse.SearchResultOrBuilderpublic SearchResponse.SearchResult.Builder clearModelScores()
public SearchResponse.SearchResult.Builder removeModelScores(String key)
Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
@Deprecated public Map<String,DoubleList> getMutableModelScores()
public SearchResponse.SearchResult.Builder putModelScores(String key, DoubleList value)
Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public SearchResponse.SearchResult.Builder putAllModelScores(Map<String,DoubleList> values)
Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public DoubleList.Builder putModelScoresBuilderIfAbsent(String key)
Output only. Google provided available scores.
map<string, .google.cloud.discoveryengine.v1.DoubleList> model_scores = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public 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];
hasRankSignals in interface SearchResponse.SearchResultOrBuilderpublic 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];
getRankSignals in interface SearchResponse.SearchResultOrBuilderpublic SearchResponse.SearchResult.Builder setRankSignals(SearchResponse.SearchResult.RankSignals value)
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];
public SearchResponse.SearchResult.Builder setRankSignals(SearchResponse.SearchResult.RankSignals.Builder builderForValue)
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];
public SearchResponse.SearchResult.Builder mergeRankSignals(SearchResponse.SearchResult.RankSignals value)
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];
public SearchResponse.SearchResult.Builder clearRankSignals()
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];
public SearchResponse.SearchResult.RankSignals.Builder getRankSignalsBuilder()
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];
public 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];
getRankSignalsOrBuilder in interface SearchResponse.SearchResultOrBuilderCopyright © 2026 Google LLC. All rights reserved.