Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder (0.71.0)

public static final class SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder> implements SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Specification to enable natural language understanding capabilities for search requests.

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

Inheritance

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

Implements

SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllGeoSearchQueryDetectionFieldNames(Iterable<String> values)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addAllGeoSearchQueryDetectionFieldNames(Iterable<String> values)

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
`values`	`Iterable<String>` The geoSearchQueryDetectionFieldNames to add.

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

addGeoSearchQueryDetectionFieldNames(String value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addGeoSearchQueryDetectionFieldNames(String value)

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
`value`	`String` The geoSearchQueryDetectionFieldNames to add.

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

addGeoSearchQueryDetectionFieldNamesBytes(ByteString value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addGeoSearchQueryDetectionFieldNamesBytes(ByteString value)

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
`value`	`ByteString` The bytes of the geoSearchQueryDetectionFieldNames to add.

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec build()

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec`

buildPartial()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec buildPartial()

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec`

clear()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clear()

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilterExtractionCondition()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearFilterExtractionCondition()

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.Builder`	This builder for chaining.

clearGeoSearchQueryDetectionFieldNames()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearGeoSearchQueryDetectionFieldNames()

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
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clone()

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.NaturalLanguageQueryUnderstandingSpec other)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder mergeFrom(SearchRequest.NaturalLanguageQueryUnderstandingSpec other)

Parameter
Name	Description
`other`	`SearchRequest.NaturalLanguageQueryUnderstandingSpec`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilterExtractionCondition(SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setFilterExtractionCondition(SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition value)

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

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

Parameter
Name	Description
`value`	`SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition` The filterExtractionCondition to set.

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

setFilterExtractionConditionValue(int value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setFilterExtractionConditionValue(int value)

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

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for filterExtractionCondition to set.

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

setGeoSearchQueryDetectionFieldNames(int index, String value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setGeoSearchQueryDetectionFieldNames(int index, String value)

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;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The geoSearchQueryDetectionFieldNames to set.

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)