This feature is in public preview and available only on Standard and Enterprise plans.
Before you begin
Ensure you have the following:1. Create a service account and key
Pinecone will use a service account to access your GCS bucket.- Create a service account for your Pinecone integration.
- Create a service account key. Select JSON as the key type. The key will be downloaded to your computer. You’ll use this key when adding a storage integration in Pinecone.
2. Grant access to the bucket
Add your service account as a principal to the bucket.- For the principal, use your service account email address.
- For the role, select Storage Object Viewer or another role that has permission to list and read objects in a bucket.
3. Add a storage integration
You can add a storage integration in the Pinecone console or with the API.Use the console
In the Pinecone console, add an integration with Google Cloud Storage:- Select your project.
- Go to Manage > Storage integrations.
- Click Add integration.
- Enter a unique integration name.
- Select Google Cloud Storage.
- Open the JSON key file for your service account.
- Copy the contents of the key file and paste them into the Index account key JSON field.
- Click Add integration.
Use the API
This endpoint requires
X-Pinecone-API-Version: unstable. Unstable endpoints can change without notice.gcp_service_account.key_json field. The following example uses jq to safely JSON-encode the key file before sending it:
curl
service-account-key.json with the path to the JSON key file you created, and my-gcs-integration with a unique name for the integration.
The response includes the integration’s id, which you need to import data, and a status of Validated or Invalid. If the service account key is invalid, the request still succeeds and the integration is created with a status of Invalid, so check the status before you import.