# Interface VertexEmbeddingConfigOrBuilder (0.15.0)

0.15.0 (latest) 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

    public interface VertexEmbeddingConfigOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for textTemplate. |