Select a documentation version: <button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">15.5.5</button>

- [15.5.5](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/model-endpoint-overview.md.txt)
- [15.5.4](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.4/docs/model-endpoint-overview.md.txt)
- [15.5.2](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.2/docs/model-endpoint-overview.md.txt)

<br />

> [!WARNING]
>
> **Preview
> --- Model endpoint management**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

This page describes a preview that lets you experiment with registering an AI model endpoint
and invoking predictions with Model endpoint management in AlloyDB Omni. To use AI models in
production environments, see [Build generative AI applications using
AlloyDB AI](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/overview-ai) and [Work with vector embeddings](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/work-with-embeddings.md.txt).

To register remote model endpoints with AlloyDB, see [Register and call remote AI models in AlloyDB](https://docs.cloud.google.com/alloydb/docs/ai/model-endpoint-overview.md.txt).

## Overview

The *Model endpoint management* preview lets you register a model endpoint, manage model endpoint metadata in your
database cluster, and then interact with the models using SQL queries. It provides the [`google_ml_integration`](https://docs.cloud.google.com/alloydb/docs/reference/model-endpoint-reference) extension that
includes functions to add and register the model endpoint metadata related to the models, and then use the
models to generate vector embeddings or invoke predictions.

Some of the example model types that you can register using model endpoint management are as follows:

- [Vertex AI](https://docs.cloud.google.com/vertex-ai/docs) text embedding models
- Embedding models provided by third-party providers, such as Anthropic, Hugging Face, or OpenAI.
- Custom-hosted text embedding models
- Generic models with a JSON-based API---for example, `facebook/bart-large-mnli` model hosted on Hugging Face or `gemini-pro` model from the Vertex AI Model Garden

## How it works

You can use model endpoint management to register a model endpoint that complies to the following:

- Model input and output supports JSON format.
- Model can be called using the REST protocol.

When you [register a model endpoint with the model endpoint management](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/model-endpoint-register-model.md.txt), it registers each endpoint with a unique model ID that you provided as a reference to the model. You can use this model ID to query models:

- Generate embeddings to translate text prompts to numerical vectors. You can
  store generated embeddings as vector data when the `pgvector` extension is enabled in the database. For
  more information, see [Query and index embeddings with
  pgvector](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/work-with-embeddings).

- Invoke predictions to call a model using SQL within a transaction.

Your applications can access the model endpoint management using the `google_ml_integration`
extension. This extension provides the following functions:

- The `google_ml.create_model()` SQL function, which is used to register the model endpoint that is used in the prediction or embedding function.
- The `google_ml.create_sm_secret()` SQL function, which uses secrets in the Google Cloud Secret Manager, where the API keys are stored.
- The `google_ml.embedding()` SQL function, which is a prediction function that generates text embeddings.
- The `google_ml.predict_row()` SQL function that generates predictions when you call generic models that support JSON input and output format.
- Other helper functions that handle generating custom URL, generating HTTP headers, or passing transform functions for your generic models.
- Functions to manage the registered model endpoints and secrets.

## Key concepts

Before you start using the model endpoint management, understand the concepts required to connect to and use the models.

### Model provider

*Model provider* indicates the supported model hosting providers. The following
table shows the model provider value you must set based on the model provider
you use:

| Model provider | Set in function as... |
|---|---|
| Vertex AI | `google` |
| Hugging Face models | `custom` |
| Anthropic models | `custom` |
| Other models | `custom` |
| OpenAI | `open_ai` |

The default model provider is `custom`.

Based on the provider type, the supported authentication method differs. The Vertex AI models use the AlloyDB service account to authenticate, while other providers can use the Secret Manager to authenticate. For more information, see [Set up authentication](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/model-endpoint-register-model.md.txt).

### Model type

*Model type* indicates the type of the AI model. The extension supports text embedding as
well as any generic model type. The supported model type you can set when
registering a model endpoint are `text-embedding` and `generic`. Setting model type is
optional when registering generic model endpoints as `generic` is the default model type.

Text embedding models with built-in support
:   The
    model endpoint management provides built-in support for all versions of the
    `textembedding-gecko` model by Vertex AI and the
    `text-embedding-ada-002` model by OpenAI. To register these model endpoints,
    use the `google_ml.create_model()` function. AlloyDB
    automatically sets up default transform functions for these models.
:   The model type for these models is `text-embedding`.

Other text embedding models
:   For other text embedding models, you
    need to create transform functions to handle the input and output formats that
    the model supports. Optionally, you can use the HTTP header generation function
    that generates custom headers required by your model.
:   The model type for these models is `text-embedding`.

Generic models
:   The model endpoint management also supports
    registering of all other model types apart from text embedding models. To
    invoke predictions for generic models, use the
    `google_ml.predict_row()` function. You can set model endpoint metadata,
    such as a request endpoint and HTTP headers that are specific to your model.
:   You cannot
    pass transform functions when you are registering a generic model endpoint. Ensure that
    when you invoke predictions the input to the function is in the JSON format, and
    that you parse the JSON output to derive the final output.
:   The model type for these models is `generic`.

### Authentication

*Auth types* indicate the authentication type that you can use to connect to the
model endpoint management using the `google_ml_integration` extension. Setting
authentication is optional and is required only if you need to authenticate to access your model.

For Vertex AI models, the AlloyDB service account is used for authentication. For other models,
API key or bearer token that is stored as a secret in the
Secret Manager can be used with the `google_ml.create_sm_secret()` SQL
function.

The following table shows the auth types that you can set:

| Authentication method | Set in function as... | Model provider |
|---|---|---|
| AlloyDB service agent | `alloydb_service_agent_iam` | Vertex AI provider |
| Secret Manager | `secret_manager` | third-party providers, such as Anthropic, Hugging Face, or OpenAI |

### Prediction functions

The `google_ml_integration` extension includes the following prediction functions:

`google_ml.embedding()`
:   Used to call a registered text embedding model endpoint to
    generate embeddings. It includes built-in support for the
    `textembedding-gecko` model by Vertex AI and the `text-embedding-ada-002` model by
    OpenAI.
:   For text embedding models without built-in support, the input and output
    parameters are unique to a model and need to be transformed for the function
    to call the model. Create a transform input function to transform input of the
    prediction function to the model specific input, and a transform output
    function to transform model specific output to the prediction function output.

`google_ml.predict_row()`
:   Used to call a registered generic model endpoint, as long as they
    support JSON-based API, to invoke predictions.

### Transform functions

Transform functions modify the input to a format that the model understands, and
convert the model response to the format that the prediction function expects. The
transform functions are used when registering the `text-embedding` model endpoint without
built-in support. The signature of the transform functions depends on the
prediction function for the model type.

You cannot use transform functions when registering a `generic` model endpoint.

The following shows the signatures for the prediction function for text
embedding models:

```sql
// define custom model specific input/output transform functions.
CREATE OR REPLACE FUNCTION input_transform_function(model_id VARCHAR(100), input_text TEXT) RETURNS JSON;

CREATE OR REPLACE FUNCTION output_transform_function(model_id VARCHAR(100), response_json JSON) RETURNS real[];
```

For more information about how to create transform functions, see [Transform functions example](https://docs.cloud.google.com/alloydb/docs/reference/model-endpoint-reference#transform-func-example).

### HTTP header generation function

The HTTP header generation function generates the output in JSON key value pairs
that are used as HTTP headers. The signature of the prediction function defines
the signatures of the header generation function.

The following example shows the signature for the `google_ml.embedding()` prediction function.

```sql
CREATE OR REPLACE FUNCTION generate_headers(model_id VARCHAR(100), input TEXT) RETURNS JSON;
```

For the `google_ml.predict_row()` prediction function, the signature is as follows:

```sql
CREATE OR REPLACE FUNCTION generate_headers(model_id VARCHAR(100), input JSON) RETURNS JSON;
```

For more information about how to create a header generation function, see [Header generation function example](https://docs.cloud.google.com/alloydb/docs/reference/model-endpoint-reference#header-gen-func-example).

## What's next

- [Set up authentication](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/model-endpoint-register-model.md.txt) for model providers.
- [Register a model endpoint with model endpoint management](https://docs.cloud.google.com/alloydb/omni/kubernetes/15.5.5/docs/model-endpoint-register-model.md.txt).
- Learn about the [model endpoint management reference](https://docs.cloud.google.com/alloydb/docs/reference/model-endpoint-reference).