Configuring Elastic Cloud Vector Database Connector
The Elastic Cloud Vector Database Connector allows you to integrate Elastic Cloud as a vector database for storing and retrieving vectorized data in your pipelines. This guide explains the configuration options available when setting up an Elastic Cloud vector database connector.
Configuration Fields
Field Summary
Field | Description | Required |
---|---|---|
Name | A descriptive name to identify the connector within Vectorize | Yes |
Host | The Elastic Cloud instance URL | Yes |
Port | The port number for your Elastic Cloud instance | Yes |
API Key | The API Key for authentication | Yes |
Finding Required Information in Elastic Cloud
Host and Port
To find your Elastic Cloud host and port:
- Log in to your Elastic Cloud account
- Navigate to the dashboard for your Elastic Cloud deployment
- Look for the endpoint information, which typically includes the host and port
- Note that the format
Parsing Elastic Cloud Endpoint
If your Elastic Cloud endpoint looks like this:
https://d93e6bcb1cb445e08847f62640e71a36.es.us-west-2.aws.elastic.cloud:443
You can break it down as follows:
-
Host:
d93e6bcb1cb445e08847f62640e71a36.es.us-west-2.aws.elastic.cloud
This is the part of the URL betweenhttps://
and the port number (:443
) -
Port:
443
This is the number after the colon at the end of the URL
When configuring your Elastic Cloud Vector Database Connector, you would enter:
- Host:
d93e6bcb1cb445e08847f62640e71a36.es.us-west-2.aws.elastic.cloud
- Port:
443
API Key
To generate an API Key:
- In your Elastic Cloud dashboard, go to the "Security" or "API Keys" section
- Create a new API key with appropriate permissions
- Copy the generated API key and store it securely, as it may not be displayed again
Configuring the Integration
- From the main menu, click on Vector Databases
- Click New Vector Database Integration
- Select the Elastic Cloud card
- Fill in the required fields:
- Enter a descriptive name for the connector
- Input your Elastic Cloud Host URL
- Specify the Port number
- Enter your API Key
- Click Create Elastic Integration to test and save your configuration
Usage in Pipelines
When configuring a pipeline, you can select this Elastic Cloud integration as the vector database output. Vectorize will then write the vectorized data to your specified Elastic Cloud instance.
Troubleshooting
If you encounter issues while creating the integration:
- Verify that your Host URL and Port are correct and accessible
- Ensure that your API Key is valid and has the necessary permissions
- Check your network settings to make sure your environment can connect to the Elastic Cloud instance
For further assistance, please refer to the Elastic Cloud documentation or contact Vectorize support.