Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::VertexEmbeddingConfig.
Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#model_id
def model_id() -> ::String
Returns
- (::String) — 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.
#model_id=
def model_id=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.
#task_type
def task_type() -> ::Google::Cloud::VectorSearch::V1::EmbeddingTaskType
Returns
- (::Google::Cloud::VectorSearch::V1::EmbeddingTaskType) — Required. Required: Task type for the embeddings.
#task_type=
def task_type=(value) -> ::Google::Cloud::VectorSearch::V1::EmbeddingTaskType
Parameter
- value (::Google::Cloud::VectorSearch::V1::EmbeddingTaskType) — Required. Required: Task type for the embeddings.
Returns
- (::Google::Cloud::VectorSearch::V1::EmbeddingTaskType) — Required. Required: Task type for the embeddings.
#text_template
def text_template() -> ::String
Returns
- (::String) — 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}".
#text_template=
def text_template=(value) -> ::String
Parameter
- value (::String) — 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}".
Returns
- (::String) — 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}".