Class SearchRequest.EmbeddingSpec (0.39.0)

public static final class SearchRequest.EmbeddingSpec extends GeneratedMessageV3 implements SearchRequest.EmbeddingSpecOrBuilder

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

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

Inheritance

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

Static Fields

EMBEDDING_VECTORS_FIELD_NUMBER

public static final int EMBEDDING_VECTORS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.EmbeddingSpec getDefaultInstance()
Returns
Type Description
SearchRequest.EmbeddingSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchRequest.EmbeddingSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.EmbeddingSpec.Builder

newBuilder(SearchRequest.EmbeddingSpec prototype)

public static SearchRequest.EmbeddingSpec.Builder newBuilder(SearchRequest.EmbeddingSpec prototype)
Parameter
Name Description
prototype SearchRequest.EmbeddingSpec
Returns
Type Description
SearchRequest.EmbeddingSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.EmbeddingSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.EmbeddingSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.EmbeddingSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.EmbeddingSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.EmbeddingSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.EmbeddingSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.EmbeddingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.EmbeddingSpec> parser()
Returns
Type Description
Parser<EmbeddingSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchRequest.EmbeddingSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.EmbeddingSpec

getEmbeddingVectors(int index)

public SearchRequest.EmbeddingSpec.EmbeddingVector getEmbeddingVectors(int index)

The embedding vector used for retrieval. Limit to 1.

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

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.EmbeddingSpec.EmbeddingVector

getEmbeddingVectorsCount()

public int getEmbeddingVectorsCount()

The embedding vector used for retrieval. Limit to 1.

repeated .google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector embedding_vectors = 1;

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

getParserForType()

public Parser<SearchRequest.EmbeddingSpec> getParserForType()
Returns
Type Description
Parser<EmbeddingSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.EmbeddingSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.EmbeddingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.EmbeddingSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.EmbeddingSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.EmbeddingSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.EmbeddingSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException