Class SearchRequest.NaturalLanguageQueryUnderstandingSpec (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 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 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

Implements

SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException