Google Cloud Vector Search V1 Client - Class VertexEmbeddingConfig (0.2.0)

Reference documentation and code samples for the Google Cloud Vector Search V1 Client class VertexEmbeddingConfig.

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

Generated from protobuf message google.cloud.vectorsearch.v1.VertexEmbeddingConfig

Namespace

Google \ Cloud \ VectorSearch \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ model_id
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.

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

↳ task_type
int

Required. Required: Task type for the embeddings.

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.

Returns
Type
Description
string

setModelId

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

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

Returns
Type
Description
string

setTextTemplate

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTaskType

Required. Required: Task type for the embeddings.

Returns
Type
Description
int
Enum of type EmbeddingTaskType .

setTaskType

Required. Required: Task type for the embeddings.

Parameter
Name
Description
var
int

Enum of type EmbeddingTaskType .

Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: