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

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()
Returns
Type Description
VertexEmbeddingConfig

getDescriptor()

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

newBuilder()

public static VertexEmbeddingConfig.Builder newBuilder()
Returns
Type Description
VertexEmbeddingConfig.Builder

newBuilder(VertexEmbeddingConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static VertexEmbeddingConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VertexEmbeddingConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static VertexEmbeddingConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VertexEmbeddingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static VertexEmbeddingConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VertexEmbeddingConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static VertexEmbeddingConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VertexEmbeddingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static VertexEmbeddingConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VertexEmbeddingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<VertexEmbeddingConfig> parser()
Returns
Type Description
Parser<VertexEmbeddingConfig>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public VertexEmbeddingConfig getDefaultInstanceForType()
Returns
Type Description
VertexEmbeddingConfig

getModelId()

public String getModelId()

Required. Required: ID of the embedding model to use. See https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models for the list of supported models.

string model_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The modelId.

getModelIdBytes()

public ByteString getModelIdBytes()

Required. Required: ID of the embedding model to use. See https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models for the list of supported models.

string model_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for modelId.

getParserForType()

public Parser<VertexEmbeddingConfig> getParserForType()
Returns
Type Description
Parser<VertexEmbeddingConfig>
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];

Returns
Type Description
EmbeddingTaskType

The taskType.

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()

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 VertexEmbeddingConfig.Builder newBuilderForType()
Returns
Type Description
VertexEmbeddingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public VertexEmbeddingConfig.Builder toBuilder()
Returns
Type Description
VertexEmbeddingConfig.Builder

writeTo(CodedOutputStream output)

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