Vector Search v1 API - Class VertexEmbeddingConfig (1.0.0-beta01) 

public sealed class VertexEmbeddingConfig : IMessage<VertexEmbeddingConfig>, IEquatable<VertexEmbeddingConfig>, IDeepCloneable<VertexEmbeddingConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Vector Search v1 API class VertexEmbeddingConfig.

Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.

Inheritance

object > VertexEmbeddingConfig

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

VertexEmbeddingConfig()

public VertexEmbeddingConfig()

VertexEmbeddingConfig(VertexEmbeddingConfig)

public VertexEmbeddingConfig(VertexEmbeddingConfig other)
Parameter
Name Description
other VertexEmbeddingConfig

Properties

ModelId

public string ModelId { get; set; }

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.

Property Value
Type Description
string

TaskType

public EmbeddingTaskType TaskType { get; set; }

Required. Required: Task type for the embeddings.

Property Value
Type Description
EmbeddingTaskType

TextTemplate

public string TextTemplate { get; set; }

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}".

Property Value
Type Description
string