Table of Contents
Pinecone credentials
Las credenciales de Pinecone permiten autenticar los módulos que interactúan con la API de Pinecone para la gestión de índices y vectores, utilizando API Keys administradas por proyecto desde la consola oficial de Pinecone.
Esta documentación se basa en el funcionamiento real de Pinecone y en su documentación oficial de gestión de API Keys.
Método de autenticación
API Key por proyecto
Descripción
La autenticación se realiza mediante una API Key asociada a un proyecto de Pinecone. Cada API Key puede configurarse con permisos específicos que determinan qué operaciones están permitidas sobre los recursos del proyecto.
Este método permite:
- Control granular de acceso mediante permisos
- Separación de entornos (producción, testing, desarrollo)
- Uso seguro en entornos productivos
- Integración directa con Saturn Studio
Campos de la credencial
Credential name
Nombre identificador de la credencial dentro de Saturn Studio.
Este valor es solo descriptivo y permite identificar fácilmente la credencial en el futuro.
Ejemplos:
Pinecone Producción Pinecone Testing
API Key
Clave utilizada para autenticar las solicitudes realizadas por Saturn Studio contra la API de Pinecone.
Cómo obtenerla
- Acceder a la consola oficial de Pinecone.
- Seleccionar el proyecto donde se utilizará la integración.
- Ingresar a la sección API Keys del proyecto.
- Crear una nueva API Key.
- Asignar un nombre descriptivo.
- Seleccionar los permisos necesarios según las operaciones que realizará Saturn Studio.
- Confirmar la creación de la API Key.
Importante: Por motivos de seguridad, Pinecone muestra el valor completo de la API Key solo una vez. Si se pierde, debe generarse una nueva.
Verificación de la API Key en Saturn Studio
Al ingresar la API Key en Saturn Studio, el campo incluye un botón Check.
Este botón permite:
- Validar que la API Key sea correcta
- Verificar que los permisos asignados sean suficientes
- Confirmar la conectividad con Pinecone antes de guardar la credencial
Si la verificación es exitosa, la credencial queda lista para ser utilizada por los comandos del módulo.
Environment
Identificador del entorno donde se encuentra desplegado el proyecto de Pinecone.
Este valor es obligatorio para que Saturn Studio pueda comunicarse correctamente con la API.
Cómo obtenerlo
- Acceder a la consola de Pinecone.
- Seleccionar el proyecto.
- Visualizar la información general del proyecto.
- Copiar el valor indicado como Environment.
Ejemplos:
us-east-1
us-west-2
gcp-starter
Index Name
Nombre del índice de Pinecone sobre el cual se ejecutarán las operaciones.
Debe coincidir exactamente con el nombre del índice creado en el proyecto.
Requisitos previos
- Cuenta activa en Pinecone
- Proyecto creado en Pinecone
- API Key activa
- Índice creado en el proyecto
Permisos de las API Keys (según Pinecone)
Las API Keys de Pinecone funcionan mediante permisos explícitos que determinan qué acciones pueden realizarse dentro del proyecto.
Los permisos se asignan al momento de crear la API Key y no pueden modificarse posteriormente. Para cambiar permisos, es necesario generar una nueva clave.
Permisos disponibles
Según la documentación oficial de Pinecone, los permisos se agrupan por tipo de operación:
- Indexes: crear, listar y eliminar índices
- Vectors: insertar, actualizar y eliminar vectores
- Query / Search: realizar búsquedas y consultas
- Project access: acceso general al proyecto
Permisos requeridos para Saturn Studio
Los permisos necesarios dependen de los comandos del módulo Pinecone que se utilicen.
Uso estándar del módulo
Para la mayoría de los flujos en Saturn Studio se recomienda que la API Key tenga al menos:
- Lectura de índices
- Escritura de vectores
- Consulta / búsqueda de vectores
Comandos administrativos
Para comandos que administran recursos (por ejemplo, eliminar un índice), se requieren permisos adicionales:
- Eliminación de índices
Si la API Key no cuenta con los permisos necesarios, el comando fallará aunque la clave sea válida.