Skip to main content
Version: User Guides (Cloud)

Integrate with Model Providers

A model provider integration connects Zilliz Cloud to a third-party model service and makes the provider’s capabilities available to your project.

An integration:

  • Stores credentials required to access a model provider

  • Explores the model provider’s supported capabilities (for example, text embedding or reranking)

When you need a model provider integration​

You need to create a model provider integration only when you want to use model-based capabilities in Zilliz Cloud:

  • Text Embedding Functions: Convert raw text into dense vectors using external models. For details, refer to Text Embedding Functions.

  • Model-based Rankers: Re-rank search results using external reranking models. For details, refer to Model-based Rankers.

Local features such as BM25, hybrid rankers, and rule-based rankers do not require a model provider integration.

Billing considerations​

Creating a model provider integration itself does not incur charges. However, using external model providers may result in additional costs, including:

  • Charges from the model provider.

  • Data transfer costs when data is sent for embedding or reranking. For details, refer to Data Transfer Cost.

Billing applies only when model-based functions or rankers are executed.

Before you start​

Before creating a model provider integration, make sure that:

  • You have Organization Owner or Project Admin permissions for the target Zilliz Cloud project. If you do not have sufficient permissions, contact your Zilliz Cloud Organization Owner.

  • You have a valid API key for the model provider you want to integrate.

Create a model provider integration​

To create a model provider integration:

1

Log in to the Zilliz Cloud console.

2

On your project page, navigate to Integrations from the left-side navigation pane.

3

Under the Model Providers section, click + Integration.

4

In the dialog box that appears, configure Basic Settings:

  • Model Provider: Select the model provider to integrate with.

  • Integration Name: A unique name for this integration (e.g., test).

  • Integration Description (optional): A description for this integration (e.g., for model provider).

5

Click Next. You'll be redirected to the Credential Information step:

  1. In the API Key field, enter the API key for your model provider access.

  2. Click Validate Integration to check the connection. Once its status changes to Successful, proceed to the next step.

6

Click Add.

Once created, the integration becomes available for use by model-based functions and rankers.

Manage integrations​

After an integration is created, you can manage it from the Integrations page:

  • Obtain your integration ID

    The integration ID will be required when using a text embedding function or a reranking function.

  • View integration details

  • Edit the integration name or description

  • Remove the integration when it is no longer needed

📘Notes

If an integration is removed or becomes invalid, collections or rankers that reference it may fail during insert or search operations until the integration is updated or replaced.

Next steps​

After creating a model provider integration, you can:

  • Use it with a Text Embedding Function to convert text into dense vectors

  • Use it with Model-based Rankers to re-rank search results

For detailed instructions, refer to: