Class VertexEmbeddingConfig (0.1.0)
public final class VertexEmbeddingConfig extends GeneratedMessageV3 implements VertexEmbeddingConfigOrBuilder
Message describing the configuration for generating embeddings for a vector
field using Vertex AI embeddings API.
Protobuf type google.cloud.vectorsearch.v1beta.VertexEmbeddingConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
MODEL_ID_FIELD_NUMBER
public static final int MODEL_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TASK_TYPE_FIELD_NUMBER
public static final int TASK_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TEXT_TEMPLATE_FIELD_NUMBER
public static final int TEXT_TEMPLATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static VertexEmbeddingConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VertexEmbeddingConfig.Builder newBuilder()
newBuilder(VertexEmbeddingConfig prototype)
public static VertexEmbeddingConfig.Builder newBuilder(VertexEmbeddingConfig prototype)
public static VertexEmbeddingConfig parseDelimitedFrom(InputStream input)
public static VertexEmbeddingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VertexEmbeddingConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VertexEmbeddingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VertexEmbeddingConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VertexEmbeddingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VertexEmbeddingConfig parseFrom(CodedInputStream input)
public static VertexEmbeddingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VertexEmbeddingConfig parseFrom(InputStream input)
public static VertexEmbeddingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VertexEmbeddingConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VertexEmbeddingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VertexEmbeddingConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public VertexEmbeddingConfig getDefaultInstanceForType()
getModelId()
public String getModelId()
| Returns |
| Type |
Description |
String |
The modelId.
|
getModelIdBytes()
public ByteString getModelIdBytes()
| Returns |
| Type |
Description |
ByteString |
The bytes for modelId.
|
getParserForType()
public Parser<VertexEmbeddingConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTaskType()
public EmbeddingTaskType getTaskType()
Required. Required: Task type for the embeddings.
.google.cloud.vectorsearch.v1beta.EmbeddingTaskType task_type = 3 [(.google.api.field_behavior) = REQUIRED];
getTaskTypeValue()
public int getTaskTypeValue()
Required. Required: Task type for the embeddings.
.google.cloud.vectorsearch.v1beta.EmbeddingTaskType task_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for taskType.
|
getTextTemplate()
public String getTextTemplate()
Required. Required: Text template for the input to the model. The template
must contain one or more references to fields in the DataObject, e.g.:
"Movie Title: {title} ---- Movie Plot: {plot}"".
string text_template = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The textTemplate.
|
getTextTemplateBytes()
public ByteString getTextTemplateBytes()
Required. Required: Text template for the input to the model. The template
must contain one or more references to fields in the DataObject, e.g.:
"Movie Title: {title} ---- Movie Plot: {plot}"".
string text_template = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for textTemplate.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public VertexEmbeddingConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VertexEmbeddingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public VertexEmbeddingConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
