Class SearchResponse.SearchResult.RetrievalSignals (0.95.0)

public static final class SearchResponse.SearchResult.RetrievalSignals extends GeneratedMessage implements SearchResponse.SearchResult.RetrievalSignalsOrBuilder

Contains a set of signals used by the relevance filter.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SearchResponse.SearchResult.RetrievalSignals

Static Fields

RETRIEVAL_SOURCES_FIELD_NUMBER

public static final int RETRIEVAL_SOURCES_FIELD_NUMBER
Field Value
Type Description
int

SEMANTIC_RELEVANCE_SCORE_FIELD_NUMBER

public static final int SEMANTIC_RELEVANCE_SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.SearchResult.RetrievalSignals getDefaultInstance()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchResponse.SearchResult.RetrievalSignals.Builder newBuilder()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

newBuilder(SearchResponse.SearchResult.RetrievalSignals prototype)

public static SearchResponse.SearchResult.RetrievalSignals.Builder newBuilder(SearchResponse.SearchResult.RetrievalSignals prototype)
Parameter
Name Description
prototype SearchResponse.SearchResult.RetrievalSignals
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.SearchResult.RetrievalSignals parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RetrievalSignals parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.SearchResult.RetrievalSignals parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.SearchResult.RetrievalSignals> parser()
Returns
Type Description
Parser<RetrievalSignals>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchResponse.SearchResult.RetrievalSignals getDefaultInstanceForType()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals

getParserForType()

public Parser<SearchResponse.SearchResult.RetrievalSignals> getParserForType()
Returns
Type Description
Parser<RetrievalSignals>
Overrides

getRetrievalSources(int index)

public SearchResponse.SearchResult.RetrievalSignals.RetrievalSource getRetrievalSources(int index)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.RetrievalSource

The retrievalSources at the given index.

getRetrievalSourcesCount()

public int getRetrievalSourcesCount()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of retrievalSources.

getRetrievalSourcesList()

public List<SearchResponse.SearchResult.RetrievalSignals.RetrievalSource> getRetrievalSourcesList()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<RetrievalSource>

A list containing the retrievalSources.

getRetrievalSourcesValue(int index)

public int getRetrievalSourcesValue(int index)

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of retrievalSources at the given index.

getRetrievalSourcesValueList()

public List<Integer> getRetrievalSourcesValueList()

Optional. Indicates how the result was retrieved.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource retrieval_sources = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for retrievalSources.

getSemanticRelevanceScore()

public float getSemanticRelevanceScore()

Optional. Relevance score used by the filter when semantic_relevance_threshold is set.

float semantic_relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The semanticRelevanceScore.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchResponse.SearchResult.RetrievalSignals.Builder newBuilderForType()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchResponse.SearchResult.RetrievalSignals.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder
Overrides

toBuilder()

public SearchResponse.SearchResult.RetrievalSignals.Builder toBuilder()
Returns
Type Description
SearchResponse.SearchResult.RetrievalSignals.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException