Class SearchRequest.EmbeddingSpec.Builder (0.38.0)

Version 0.38.0

• 0.49.0 (latest)
• 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.EmbeddingSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.EmbeddingSpec.Builder> implements SearchRequest.EmbeddingSpecOrBuilder

The specification that uses customized query embedding vector to do semantic document retrieval.

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

Inheritance

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

Implements

SearchRequest.EmbeddingSpecOrBuilder

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

addAllEmbeddingVectors(Iterable<? extends SearchRequest.EmbeddingSpec.EmbeddingVector> values)

public SearchRequest.EmbeddingSpec.Builder addAllEmbeddingVectors(Iterable<? extends SearchRequest.EmbeddingSpec.EmbeddingVector> values)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector>

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

addEmbeddingVectors(SearchRequest.EmbeddingSpec.EmbeddingVector value)

public SearchRequest.EmbeddingSpec.Builder addEmbeddingVectors(SearchRequest.EmbeddingSpec.EmbeddingVector value)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
value	SearchRequest.EmbeddingSpec.EmbeddingVector

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

addEmbeddingVectors(SearchRequest.EmbeddingSpec.EmbeddingVector.Builder builderForValue)

public SearchRequest.EmbeddingSpec.Builder addEmbeddingVectors(SearchRequest.EmbeddingSpec.EmbeddingVector.Builder builderForValue)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
builderForValue	SearchRequest.EmbeddingSpec.EmbeddingVector.Builder

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

addEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector value)

public SearchRequest.EmbeddingSpec.Builder addEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector value)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameters
Name	Description
index	int
value	SearchRequest.EmbeddingSpec.EmbeddingVector

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

addEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector.Builder builderForValue)

public SearchRequest.EmbeddingSpec.Builder addEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector.Builder builderForValue)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameters
Name	Description
index	int
builderForValue	SearchRequest.EmbeddingSpec.EmbeddingVector.Builder

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

addEmbeddingVectorsBuilder()

public SearchRequest.EmbeddingSpec.EmbeddingVector.Builder addEmbeddingVectorsBuilder()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Returns
Type	Description
SearchRequest.EmbeddingSpec.EmbeddingVector.Builder

addEmbeddingVectorsBuilder(int index)

public SearchRequest.EmbeddingSpec.EmbeddingVector.Builder addEmbeddingVectorsBuilder(int index)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.EmbeddingSpec.EmbeddingVector.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

build()

public SearchRequest.EmbeddingSpec build()

Returns
Type	Description
SearchRequest.EmbeddingSpec

buildPartial()

public SearchRequest.EmbeddingSpec buildPartial()

Returns
Type	Description
SearchRequest.EmbeddingSpec

clear()

public SearchRequest.EmbeddingSpec.Builder clear()

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEmbeddingVectors()

public SearchRequest.EmbeddingSpec.Builder clearEmbeddingVectors()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

clearField(Descriptors.FieldDescriptor field)

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

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

clone()

public SearchRequest.EmbeddingSpec.Builder clone()

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchRequest.EmbeddingSpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.EmbeddingSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEmbeddingVectors(int index)

public SearchRequest.EmbeddingSpec.EmbeddingVector getEmbeddingVectors(int index)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.EmbeddingSpec.EmbeddingVector

getEmbeddingVectorsBuilder(int index)

public SearchRequest.EmbeddingSpec.EmbeddingVector.Builder getEmbeddingVectorsBuilder(int index)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.EmbeddingSpec.EmbeddingVector.Builder

getEmbeddingVectorsBuilderList()

public List<SearchRequest.EmbeddingSpec.EmbeddingVector.Builder> getEmbeddingVectorsBuilderList()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Returns
Type	Description
List<Builder>

getEmbeddingVectorsCount()

public int getEmbeddingVectorsCount()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Returns
Type	Description
int

getEmbeddingVectorsList()

public List<SearchRequest.EmbeddingSpec.EmbeddingVector> getEmbeddingVectorsList()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Returns
Type	Description
List<EmbeddingVector>

getEmbeddingVectorsOrBuilder(int index)

public SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder getEmbeddingVectorsOrBuilder(int index)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder

getEmbeddingVectorsOrBuilderList()

public List<? extends SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder> getEmbeddingVectorsOrBuilderList()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder>

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.EmbeddingSpec other)

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

Parameter
Name	Description
other	SearchRequest.EmbeddingSpec

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.EmbeddingSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

removeEmbeddingVectors(int index)

public SearchRequest.EmbeddingSpec.Builder removeEmbeddingVectors(int index)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

setEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector value)

public SearchRequest.EmbeddingSpec.Builder setEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector value)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameters
Name	Description
index	int
value	SearchRequest.EmbeddingSpec.EmbeddingVector

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

setEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector.Builder builderForValue)

public SearchRequest.EmbeddingSpec.Builder setEmbeddingVectors(int index, SearchRequest.EmbeddingSpec.EmbeddingVector.Builder builderForValue)

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

Parameters
Name	Description
index	int
builderForValue	SearchRequest.EmbeddingSpec.EmbeddingVector.Builder

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchRequest.EmbeddingSpec.Builder

Overrides

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