Configuring your existing TopK account
To use Superlinked with TopK, you’ll need to create a TopK account and set up a project. For detailed steps on setting up your TopK account, refer to the Set up your TopK Account section below. Once your TopK project is set up, you’ll need to obtain your API key and region information to configure the authentication settings as described below.Modifications in your configuration
To integrate TopK, you need to add theTopKVectorDatabase
class and include it in the executor. Here’s how you can do it:
Set up your TopK Account
To set up your TopK account and obtain the necessary credentials for Superlinked integration, follow these steps:1
Go to the TopK Console
Navigate to TopK Console and create an account or sign in to your existing account.
2
Create or Select a Project
TopK follows an
Organization > Project > Collection
hierarchical structure.Create a new project or use an existing one within your organization.3
Generate an API Key
Follow the TopK documentation to generate an API key for your project.
Save your API key securely as you’ll need it for your Superlinked configuration.
4
Note your Region
TopK is region-specific. Refer to the TopK documentation for available regions and ensure you use the correct region for your project.
Attempting to access collections or documents outside the specified region will result in a region mismatch error.