This sample demonstrates how to use Vertex AI text embedding models to calculate embeddings for code blocks and queries for code retrieval tasks.

## Explore further


For detailed documentation that includes this code sample, see the following:

- [Choose an embeddings task type](https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/embeddings/task-types)

## Code sample

### Python


Before trying this sample, follow the Python setup instructions in the
[Vertex AI quickstart using
client libraries](https://docs.cloud.google.com/vertex-ai/docs/start/client-libraries).


For more information, see the
[Vertex AI Python API
reference documentation](https://docs.cloud.google.com/python/docs/reference/aiplatform/latest).


To authenticate to Vertex AI, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    from vertexai.language_models import TextEmbeddingInput, TextEmbeddingModel

    MODEL_NAME = "gemini-embedding-001"
    DIMENSIONALITY = 3072


    def embed_text(
        texts: list[str] = ["Retrieve a function that adds two numbers"],
        task: str = "CODE_RETRIEVAL_QUERY",
        model_name: str = "gemini-embedding-001",
        dimensionality: int | None = 3072,
    ) -> list[list[float]]:
        """Embeds texts with a pre-trained, foundational model."""
        model = TextEmbeddingModel.from_pretrained(model_name)
        kwargs = dict(output_dimensionality=dimensionality) if dimensionality else {}

        embeddings = []
        # gemini-embedding-001 takes one input at a time
        for text in texts:
            text_input = TextEmbeddingInput(text, task)
            embedding = model.get_embeddings([text_input], **kwargs)
            print(embedding)
            # Example response:
            # [[0.006135190837085247, -0.01462465338408947, 0.004978656303137541, ...]]
            embeddings.append(embedding[0].values)

        return embeddings


    if __name__ == "__main__":
        # Embeds code block with a pre-trained, foundational model.
        # Using this function to calculate the embedding for corpus.
        texts = ["Retrieve a function that adds two numbers"]
        task = "CODE_RETRIEVAL_QUERY"
        code_block_embeddings = embed_text(
            texts=texts, task=task, model_name=MODEL_NAME, dimensionality=DIMENSIONALITY
        )

        # Embeds code retrieval with a pre-trained, foundational model.
        # Using this function to calculate the embedding for query.
        texts = [
            "def func(a, b): return a + b",
            "def func(a, b): return a - b",
            "def func(a, b): return (a ** 2 + b ** 2) ** 0.5",
        ]
        task = "RETRIEVAL_DOCUMENT"
        code_query_embeddings = embed_text(
            texts=texts, task=task, model_name=MODEL_NAME, dimensionality=DIMENSIONALITY
        )

## What's next


To search and filter code samples for other Google Cloud products, see the
[Google Cloud sample browser](https://docs.cloud.google.com/docs/samples?product=generativeaionvertexai).