Interface VertexEmbeddingConfigOrBuilder (0.1.0)

public interface VertexEmbeddingConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getModelId()

public abstract 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 abstract 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.

getTaskType()

public abstract 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 abstract 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 abstract 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 abstract 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.