haive.core.engine.embedding.providers.GoogleVertexAIEmbeddingConfig

Google Vertex AI embedding configuration.

Classes

GoogleVertexAIEmbeddingConfig

Configuration for Google Vertex AI embeddings.

Module Contents

class haive.core.engine.embedding.providers.GoogleVertexAIEmbeddingConfig.GoogleVertexAIEmbeddingConfig

Bases: haive.core.engine.embedding.base.BaseEmbeddingConfig

Configuration for Google Vertex AI embeddings.

This configuration provides access to Google’s Vertex AI embedding models including text-embedding-004, text-multilingual-embedding-002, and others.

Examples

Basic usage:

config = GoogleVertexAIEmbeddingConfig(
    name="vertex_embeddings",
    model="text-embedding-004",
    project="your-project-id",
    location="us-central1"
)

embeddings = config.instantiate()

With custom task type:

config = GoogleVertexAIEmbeddingConfig(
    name="vertex_embeddings",
    model="text-embedding-004",
    project="your-project-id",
    location="us-central1",
    task_type="SEMANTIC_SIMILARITY"
)

Using service account:

config = GoogleVertexAIEmbeddingConfig(
    name="vertex_embeddings",
    model="text-embedding-004",
    project="your-project-id",
    location="us-central1",
    credentials_path="/path/to/service-account.json"
)

embedding_type

Always EmbeddingType.GOOGLE_VERTEX_AI

model

Vertex AI model name (e.g., “text-embedding-004”)

project

Google Cloud project ID

location

Google Cloud location/region

task_type

Task type for embeddings

credentials_path

Path to service account credentials

get_default_model()

Get the default model for Vertex AI embeddings.

Return type:

str

get_model_info()

Get information about the configured model.

Return type:

dict

get_supported_locations()

Get list of supported Google Cloud locations.

Return type:

list[str]

get_supported_models()

Get list of supported Vertex AI embedding models.

Return type:

list[str]

get_task_types()

Get list of supported task types.

Return type:

list[str]

instantiate()

Create a Google Vertex AI embeddings instance.

Returns:

VertexAIEmbeddings instance configured with the provided parameters

Raises:

• ImportError – If langchain-google-vertexai is not installed

• ValueError – If configuration is invalid

Return type:

Any

validate_configuration()

Validate the configuration before instantiation.

Return type:

None

classmethod validate_location(v)

Validate Google Cloud location.

Return type:

Any

classmethod validate_model(v)

Validate the Vertex AI model name.

Return type:

Any

classmethod validate_project(v)

Validate Google Cloud project ID.

Return type:

Any

classmethod validate_task_type(v)

Validate task type.

Return type:

Any