About This Task

Adding an integration connects deepset AI Platform with an external model or service provider. Once connected, you can use their services directly in your pipeline components, without passing the API key in the component's configuration.

For more information on integrations, see Secrets and Integrations.

Integration Scope

You can add integrations at either the workspace or organization level:

• Workspace-level integrations are available only to pipelines and indexes within that specific workspace.
• Organization-level integrations are available to all workspaces in the organization.

If the same provider is integrated at both levels, the workspace-level integration takes priority.

Providers

Currently, on the Integrations page you can set up connections with the following model providers:

• Amazon Bedrock and SageMaker
• Azure OpenAI
• Cohere
• Google AI
• Hugging Face (only needed for private models hosted there)
• MongoDB
• NVIDIA
• OpenAI
• SearchAPI
• Together AI
• Voyage AI
• Weights & Biases

Supported integrations with data processing services and data sources are:

• Azure AI Document Intelligence
• DeepL
• Snowflake
• Unstructured

Prerequisites

• Make sure you have an active account with the provider.
• Have your API key or access credentials ready. For help getting credentials, see:
  • User access tokens in Hugging Face.
  • Secret API keys in Open AI
  • Production keys in co:here
  • Model access in Amazon Bedrock
  • Getting access to Azure OpenAI
  • Getting an API key for Gemini API
  • Nvidia personal keys
  • Using Document Intelligence models
  • DeepL API
  • Snowflake website
  • unstructured.io documentation
  • Google Search API
  • VoyageAI
  • MongoDB: Create an API key
  • together.ai Quickstart
  • Weights & Biases: How do I find my API key

Connect to a Provider

Add Workspace-Level Integration

1. Click your profile icon and choose Settings.
2. Go to Workspace>Integrations.
3. Find the provider you want to connect and click Connect next to them.
4. Enter the API key and any other required details.
5. Click Connect. You can use this integration in pipelines and indexes in the current workspace.

Add Organization-Level Integration

1. Click your profile icon and choose Settings.
2. Go to Organization>Integrations.
3. Find the provider you want to connect and click Connect next to them.
4. Enter the API key and any other required details.
5. Click Connect. You can use this integration in pipelines and indexes in all workspaces in the current organization.