com.google.cloud.discoveryengine.v1beta

Class SearchRequest.NaturalLanguageQueryUnderstandingSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec

All Implemented Interfaces:

SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest

public static final class SearchRequest.NaturalLanguageQueryUnderstandingSpec
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

 Specification to enable natural language understanding capabilities for
 search requests.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder Specification to enable natural language understanding capabilities for search requests.
static class	SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition Enum describing under which condition filter extraction should occur.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_EXTRACTION_CONDITION_FIELD_NUMBER
static int	GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	getDefaultInstance()
SearchRequest.NaturalLanguageQueryUnderstandingSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition	getFilterExtractionCondition() The condition under which filter extraction should occur.
int	getFilterExtractionConditionValue() The condition under which filter extraction should occur.
String	getGeoSearchQueryDetectionFieldNames(int index) Field names used for location-based filtering, where geolocation filters are detected in natural language search queries.
com.google.protobuf.ByteString	getGeoSearchQueryDetectionFieldNamesBytes(int index) Field names used for location-based filtering, where geolocation filters are detected in natural language search queries.
int	getGeoSearchQueryDetectionFieldNamesCount() Field names used for location-based filtering, where geolocation filters are detected in natural language search queries.
com.google.protobuf.ProtocolStringList	getGeoSearchQueryDetectionFieldNamesList() Field names used for location-based filtering, where geolocation filters are detected in natural language search queries.
com.google.protobuf.Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder	newBuilder()
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder	newBuilder(SearchRequest.NaturalLanguageQueryUnderstandingSpec prototype)
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder	newBuilderForType()
protected SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(byte[] data)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(ByteBuffer data)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(InputStream input)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec>	parser()
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FILTER_EXTRACTION_CONDITION_FIELD_NUMBER

public static final int FILTER_EXTRACTION_CONDITION_FIELD_NUMBER

See Also:

Constant Field Values

GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER

public static final int GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getFilterExtractionConditionValue in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Returns:

The enum numeric value on the wire for filterExtractionCondition.

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;

Specified by:

getFilterExtractionCondition in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Returns:

The filterExtractionCondition.

getGeoSearchQueryDetectionFieldNamesList

public com.google.protobuf.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][google.cloud.discoveryengine.v1beta.ServingConfig.geo_search_query_detection_field_names].
 

repeated string geo_search_query_detection_field_names = 2;

Specified by:

getGeoSearchQueryDetectionFieldNamesList in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Returns:

A list containing the geoSearchQueryDetectionFieldNames.

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][google.cloud.discoveryengine.v1beta.ServingConfig.geo_search_query_detection_field_names].
 

repeated string geo_search_query_detection_field_names = 2;

Specified by:

getGeoSearchQueryDetectionFieldNamesCount in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Returns:

The count of geoSearchQueryDetectionFieldNames.

getGeoSearchQueryDetectionFieldNames

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][google.cloud.discoveryengine.v1beta.ServingConfig.geo_search_query_detection_field_names].
 

repeated string geo_search_query_detection_field_names = 2;

Specified by:

getGeoSearchQueryDetectionFieldNames in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The geoSearchQueryDetectionFieldNames at the given index.

getGeoSearchQueryDetectionFieldNamesBytes

public com.google.protobuf.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][google.cloud.discoveryengine.v1beta.ServingConfig.geo_search_query_detection_field_names].
 

repeated string geo_search_query_detection_field_names = 2;

Specified by:

getGeoSearchQueryDetectionFieldNamesBytes in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the geoSearchQueryDetectionFieldNames at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteBuffer data)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteBuffer data,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.ByteString data)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.ByteString data,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(byte[] data)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(byte[] data,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(InputStream input)
                                                                     throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(InputStream input,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseDelimitedFrom(InputStream input)
                                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseDelimitedFrom(InputStream input,
                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                                     throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilder()

newBuilder

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilder(SearchRequest.NaturalLanguageQueryUnderstandingSpec prototype)

toBuilder

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder