Class SearchRequest.NaturalLanguageQueryUnderstandingSpec (0.81.0)

Version latest

• 0.79.0 (latest)
• 0.78.0
• 0.77.0
• 0.76.0
• 0.74.0
• 0.72.0
• 0.71.0
• 0.70.0
• 0.69.0
• 0.68.0
• 0.66.0
• 0.64.0
• 0.63.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 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 GeneratedMessage implements SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Specification to enable natural language understanding capabilities for search requests.

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

Inheritance

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

Implements

SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

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

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

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

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

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

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

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

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

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

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

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

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOWED_FIELD_NAMES_FIELD_NUMBER

public static final int ALLOWED_FIELD_NAMES_FIELD_NUMBER

Field Value
Type	Description
int

EXTRACTED_FILTER_BEHAVIOR_FIELD_NUMBER

public static final int EXTRACTED_FILTER_BEHAVIOR_FIELD_NUMBER

Field Value
Type	Description
int

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)

getAllowedFieldNames(int index)

public String getAllowedFieldNames(int index)

Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.

repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedFieldNames at the given index.

getAllowedFieldNamesBytes(int index)

public ByteString getAllowedFieldNamesBytes(int index)

Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.

repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedFieldNames at the given index.

getAllowedFieldNamesCount()

public int getAllowedFieldNamesCount()

Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.

repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of allowedFieldNames.

getAllowedFieldNamesList()

public ProtocolStringList getAllowedFieldNamesList()

Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.

repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the allowedFieldNames.

getDefaultInstanceForType()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec

getExtractedFilterBehavior()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior getExtractedFilterBehavior()

Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is HARD_FILTER. For multi-datastore search, the default behavior is SOFT_BOOST. Location-based filters are always applied as hard filters, and the SOFT_BOOST setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.

.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior	The extractedFilterBehavior.

getExtractedFilterBehaviorValue()

public int getExtractedFilterBehaviorValue()

Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is HARD_FILTER. For multi-datastore search, the default behavior is SOFT_BOOST. Location-based filters are always applied as hard filters, and the SOFT_BOOST setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.

.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for extractedFilterBehavior.

getFilterExtractionCondition()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition getFilterExtractionCondition()

The condition under which filter extraction should occur. Server behavior defaults to DISABLED.

.google.cloud.discoveryengine.v1.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. Server behavior defaults to DISABLED.

.google.cloud.discoveryengine.v1.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

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType()

Returns
Type	Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

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

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException