Class SearchRequest.EmbeddingSpec (0.31.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

Static Fields

EMBEDDING_VECTORS_FIELD_NUMBER

public static final int EMBEDDING_VECTORS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchRequest.EmbeddingSpec getDefaultInstance()
Returns
TypeDescription
SearchRequest.EmbeddingSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchRequest.EmbeddingSpec.Builder newBuilder()
Returns
TypeDescription
SearchRequest.EmbeddingSpec.Builder

newBuilder(SearchRequest.EmbeddingSpec prototype)

public static SearchRequest.EmbeddingSpec.Builder newBuilder(SearchRequest.EmbeddingSpec prototype)
Parameter
NameDescription
prototypeSearchRequest.EmbeddingSpec
Returns
TypeDescription
SearchRequest.EmbeddingSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.EmbeddingSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchRequest.EmbeddingSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.EmbeddingSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.EmbeddingSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchRequest.EmbeddingSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.EmbeddingSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.EmbeddingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.EmbeddingSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchRequest.EmbeddingSpec getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVectorOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchRequest.EmbeddingSpec.Builder newBuilderForType()
Returns
TypeDescription
SearchRequest.EmbeddingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.EmbeddingSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchRequest.EmbeddingSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchRequest.EmbeddingSpec.Builder toBuilder()
Returns
TypeDescription
SearchRequest.EmbeddingSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException