You can manage Automated Embedding from the Atlas UI.
Enable or Disable Automated Embedding
To enable Automated Embedding, you must create a MongoDB Vector Search index with
the autoEmbed type. To learn more, see Create an Automated
Embedding Index.
To disable Automated Embedding at the organization level, use an Atlas Resource Policy. You can disable Automated Embedding entirely or disable it with project-level exceptions.
To disable Automated Embedding entirely, use the following syntax in your Atlas Resource Policy:
forbid ( principal, action == ResourcePolicy::Action::"search.index.modify", resource ) when { context.search.index.isAutoEmbed };
To disable Automated Embedding with exceptions for specific projects,
use the following syntax in your Atlas Resource Policy. Replace each <project-id> with
the ID of the project to exempt. To find your project ID, see:
Manage Project Settings.
forbid ( principal, action == ResourcePolicy::Action::"search.index.modify", resource ) when { context.search.index.isAutoEmbed } unless { resource in ResourcePolicy::Project::"<project-id-1>" || resource in ResourcePolicy::Project::"<project-id-2>" };
When active, these policies prevent new autoEmbed type indexes
from being created. Indexes created before the resource policy was
activated are not affected and must be deleted manually to maintain
compliance.
To apply this policy to your organization:
To enable Automated Embedding, you must do the following:
Create a Voyage AI API key for indexing operations.
To learn more, see Model API Keys.
Create a Voyage AI API key for query operations.
To learn more, see Model API Keys.
Configure mongot to use the API keys.
To learn more, see Voyage AI API Keys.
Create an autoEmbed type MongoDB Vector Search index.
To learn more, see Create an Automated Embedding Index.
View Automated Embedding Usage
To view aggregated token usage and embedding model requests for Automated Embedding service:
Log in to Atlas.
In Atlas, go to the Search & Vector Search page for your cluster.
You can go the MongoDB Search page from the Search & Vector Search option, or the Data Explorer.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Search & Vector Search under the Database heading.
If your project has multiple clusters, select the cluster you want to use from the Select cluster dropdown, then click Go to Atlas Search.
The Search & Vector Search page displays.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Data Explorer under the Database heading.
Expand the database and select the collection.
Click the Indexes tab for the collection.
Click the Search and Vector Search link in the banner.
The Search & Vector Search page displays.
Click Usage under Automated Embedding.
The Automated Embedding Usage page displays. The Automated Embedding Usage page displays the following information:
Section | Description |
|---|---|
Usage Summary | Overview of your Automated Embedding usage, including total tokens used and remaining free tokens. |
Usage by Model | Breakdown of token usage by embedding model. |
Usage by Operation | Breakdown of token usage by operation type (indexing and querying). |
Log in to Atlas.
View the token usage and embedding model requests for Automated Embedding.
The Usage page displays usage metrics for all model API keys in your organization. The page provides the following tabs:
Usage Activity: Shows detailed usage metrics and charts for your organization.
Free Usage: Shows free quota consumption by model.
To learn more, see Usage Page Features.
View Rate Limits
To view rate limits for Automated Embedding:
Log in to Atlas.
Go to the Search & Vector Search page for your project.
If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
In the sidebar, click Search & Vector Search under the Database header.
The Search & Vector Search page displays.
Log in to Atlas.
Increase Rate Limits
If you are on the Free Tier and need to increase rate limits for Automated Embedding, add a payment method to upgrade to a paid tier. To learn more, see Set Payment Method.
If you are on a Paid Tier, MongoDB automatically increases rate limits as your usage increases. If you still need a higher rate limit, contact MongoDB Support.