Class SearchRequest.NaturalLanguageQueryUnderstandingSpec (0.44.0)

public static final class SearchRequest.NaturalLanguageQueryUnderstandingSpec extends GeneratedMessageV3 implements SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Specification to enable natural language understanding capabilities for search requests.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.NaturalLanguageQueryUnderstandingSpec

Static Fields

FILTER_EXTRACTION_CONDITION_FIELD_NUMBER

public static final int FILTER_EXTRACTION_CONDITION_FIELD_NUMBER
Field Value
Type Description
int

GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER

public static final int GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstance()
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec

getDescriptor()

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

newBuilder()

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

newBuilder(SearchRequest.NaturalLanguageQueryUnderstandingSpec prototype)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilder(SearchRequest.NaturalLanguageQueryUnderstandingSpec prototype)
Parameter
Name Description
prototype SearchRequest.NaturalLanguageQueryUnderstandingSpec
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec> parser()
Returns
Type Description
Parser<NaturalLanguageQueryUnderstandingSpec>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec

getFilterExtractionCondition()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition getFilterExtractionCondition()

The condition under which filter extraction should occur. Default to [Condition.DISABLED][].

.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;

Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition

The filterExtractionCondition.

getFilterExtractionConditionValue()

public int getFilterExtractionConditionValue()

The condition under which filter extraction should occur. Default to [Condition.DISABLED][].

.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;

Returns
Type Description
int

The enum numeric value on the wire for filterExtractionCondition.

getGeoSearchQueryDetectionFieldNames(int index)

public String getGeoSearchQueryDetectionFieldNames(int index)

Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to ENABLED.

If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.

repeated string geo_search_query_detection_field_names = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The geoSearchQueryDetectionFieldNames at the given index.

getGeoSearchQueryDetectionFieldNamesBytes(int index)

public ByteString getGeoSearchQueryDetectionFieldNamesBytes(int index)

Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to ENABLED.

If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.

repeated string geo_search_query_detection_field_names = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the geoSearchQueryDetectionFieldNames at the given index.

getGeoSearchQueryDetectionFieldNamesCount()

public int getGeoSearchQueryDetectionFieldNamesCount()

Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to ENABLED.

If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.

repeated string geo_search_query_detection_field_names = 2;

Returns
Type Description
int

The count of geoSearchQueryDetectionFieldNames.

getGeoSearchQueryDetectionFieldNamesList()

public ProtocolStringList getGeoSearchQueryDetectionFieldNamesList()

Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to ENABLED.

If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.

repeated string geo_search_query_detection_field_names = 2;

Returns
Type Description
ProtocolStringList

A list containing the geoSearchQueryDetectionFieldNames.

getParserForType()

public Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec> getParserForType()
Returns
Type Description
Parser<NaturalLanguageQueryUnderstandingSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

writeTo(CodedOutputStream output)

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