Skip to main content
An LLM connection stores the tenant-level credentials that link ABBYY Vantage to an external LLM provider. Once configured, a connection is shared across your tenant, and any Document Skill can use it for prompt-based extraction and classification.
LLM connections can currently be used in Document Skills through ABBYY Advanced Designer only. Connections are managed at the tenant level and are available to all skill designers in your organization.
For a conceptual overview and the full list of supported providers, see LLMs in ABBYY Vantage and Supported LLM providers and models.

​
Prerequisites

Before you begin, make sure you have the following.
  • Administrator access to ABBYY Vantage Configuration.
  • An active subscription with your chosen LLM provider.
  • API credentials from that provider:
    • Anthropic - API key from your Anthropic account.
    • Google AI Studio - API key from your Google AI Studio account.
    • Microsoft Foundry - API key, the complete endpoint URL (including the /chat/completions path and API version), and the deployed model name from Azure.
    • Mistral AI - API key from your Mistral AI account.
    • OpenAI - API key from your OpenAI account.

​
Add an LLM connection

1

Open the Connections page

In the left sidebar, under ADMIN, click Configuration (gear icon), and then click Connections.
Connections page in Vantage Configuration
The Connections page lists any existing connections with their Name, Description, Used in Skills, and Last Updated values, along with Add Connection, Test, Edit, and Delete buttons.
2

Select a provider

Click + Add Connection. The Add Connection dialog lists the available providers: Anthropic, Microsoft Foundry, Google AI Studio, Mistral AI, and OpenAI.
Add Connection dialog listing Anthropic, Microsoft Foundry, Google AI Studio, Mistral AI, and OpenAI providers
Select the provider that matches your subscription, and then click Next.
3

Enter the general settings

Give the connection a name and an optional description.
  • Name - A unique name for the connection. This name appears when skill designers select a connection in a Document Skill, so choose something descriptive, such as Production Claude or Mistral AI.
  • Description - Optional context about the connection’s purpose or environment. Don’t include API keys or other credentials.
4

Enter the connection settings

Enter the credentials for your provider. The required fields depend on the provider you selected. For the fields per provider, see Connection settings by provider.
Connection configuration form with General and Connection Settings sections
5

Test the connection

Click Test. Vantage attempts to reach the provider with the credentials you entered.
Testing an LLM connection
A green checkmark confirms the connection works. A red error means the credentials or settings need attention. For help, see Troubleshooting.
6

Save the connection

Once the test succeeds, click Add. The connection appears in the Connections list and is immediately available to all skill designers in your tenant.
Once a skill that references this connection is published, the connection becomes the default in the Vantage Web Portal, under Skill Catalog → [skill] → Parameters. A tenant administrator can override the default per environment without republishing the skill. For more information, see Document skill parameters.

​
Connection settings by provider

The Connection Settings fields differ by provider. Enter the exact model name your account supports. For example models, see Supported LLM providers and models.
Never share API keys or include them in a connection’s description. These credentials grant access to your LLM services and the associated costs.

​
Anthropic

  • Model Name - The Anthropic model to use. Select the model your account supports.
  • API Key - Your Anthropic API key (starts with sk-).

​
Google AI Studio (Gemini)

  • Model Name - The Gemini model to use, for example gemini-2.0-flash.
  • API Key - Your Google AI Studio API key, from Google AI Studio → Get API key.

​
Microsoft Foundry

  • Model Name - The name of your deployed model in Microsoft Foundry, from Azure Portal → your Microsoft Foundry resource → Deployments. This must match the deployment exactly.
  • URL - Your Microsoft Foundry endpoint, from Azure Portal → your Microsoft Foundry resource → Keys and Endpoint. Include the deployment path and API version, for example https://<resource>.cognitiveservices.azure.com/openai/deployments/<model-name>/chat/completions?api-version=2025-01-01-preview.
  • API Key - Your Microsoft Foundry API key, from the same Keys and Endpoint page.

​
Mistral AI

  • Model Name - The Mistral AI model to use. Select the model your account supports.
  • API Key - Your Mistral AI API key.

​
OpenAI ChatGPT

  • Model Name - The OpenAI model to use, for example gpt-4.
  • API Key - Your OpenAI API key (starts with sk-), from OpenAI Platform → API Keys.

​
Manage connections

Connections are shared, so a change affects every skill that uses them. Test after any change.

​
Edit a connection

1

Select the connection

On the Connections page, select the connection, and then click Edit (pencil icon).
2

Update and test

Update the fields, click Test to confirm the connection still works, and then click Save.
Editing a connection affects all skills that use it. Test thoroughly after making changes.

​
Test a connection

On the Connections page, select the connection, and then click Test (refresh icon) to verify the credentials still work. This is useful for routine checks and troubleshooting.

​
Delete a connection

On the Connections page, select the connection, click Delete (trash icon), and then confirm.
You can’t delete a connection that is used in an active skill. Remove the connection from all skills first.

​
Troubleshooting

​
The connection test fails

Check the credentials and settings for the provider.
  • Invalid API key - Confirm you copied the entire key, with no extra spaces. Regenerate the key in the provider’s portal if needed.
  • Invalid endpoint URL (Microsoft Foundry) - Confirm the URL is complete, matches your Azure resource, and has no typos in the deployment path.
  • Wrong model name - Confirm the model or deployment exists and is active, and check spelling and capitalization (case-sensitive).
  • Network issues - Confirm outbound HTTPS is allowed and your Vantage instance can reach the provider.
  • Quota or permissions - Confirm your subscription is active, you’re within rate limits, and the key has the necessary permissions.

​
The connection works in the test but fails in a skill

  • Refresh the Skill Designer page, and re-select the connection in the skill.
  • Confirm the skill is published, not in draft.
  • Check the skill’s error logs for specific messages.

​
API costs are higher than expected

  • Review which skills use the connection, and their processing volume.
  • Use smaller, faster models for simple tasks.
  • Monitor usage and set budget alerts in your provider’s dashboard.

​
Best practices

  • Secure your credentials. Never share API keys or put them in a description. Rotate keys regularly, grant each key the least privilege it needs, and use separate connections for development and production.
  • Name connections clearly. Use names that indicate purpose or environment, such as Production GPT-4 or Development Foundry, rather than Connection 1. Record the environment, use case, and owner in the description.
  • Review connections regularly. Test connections on a schedule and after any credential change, and use the Used in Skills column to find and remove connections no longer in use.
  • Manage cost. Use smaller, faster models for simple tasks, keep prompts efficient, and set budget alerts in your provider’s dashboard.

​
Additional resources