Antes de empezar

• Aprovisione una instancia de Milvus o Elasticsearch DB en IBM Cloud antes de ejecutar el bloc de notas.
• Aprovisione una instancia de watsonx.ai Studio para ejecutar el bloc de notas. Para crear una instancia de watsonx.ai Studio, consulte el catálogo de watsonx.ai Studio.
• Asegúrese de que dispone de una clave API para acceder a watsonx Code Assistant y generar explicaciones para las funciones de su código. Las explicaciones se indexan con el código para obtener mejores resultados de búsqueda. Para más información, consulte Crear una clave API IBM Cloud.

Planificación de su índice

Una indexación eficaz es esencial para optimizar el rendimiento de watsonx Code Assistant cuando se utiliza RAG. Ten en cuenta los siguientes factores a la hora de indexar el repositorio o los documentos:

• Asegúrese de que el espacio de almacenamiento en el disco es el doble del tamaño del contenido que se está indexando.

• Indexe repositorios de código cuando reutilice código existente para generar código nuevo, localizando implementaciones de funciones específicas, respondiendo a preguntas sobre cómo hacerlo relacionadas con la base de código. Puede incluir proyectos de código principal y sus dependencias, como la implementación de API.

• Indexe repositorios de documentación como documentación de productos o proyectos, guías técnicas y documentos de diseño si necesita que watsonx Code Assistant responda a consultas basadas en estos documentos.

• No indexe repositorios de código o documentos que se utilicen con poca frecuencia para reducir el uso de almacenamiento y minimizar el tiempo necesario para la creación y el mantenimiento de índices.

• Utilice un índice por repositorio, especialmente para el código fuente, para limitar la búsqueda contextual a repositorios específicos.

• Combine varios repositorios de documentación en un único índice si suele realizar búsquedas en todos los documentos. Puede crear índices separados si se produce un solapamiento significativo de palabras clave entre los repositorios y diferentes equipos o usuarios necesitan buscar el contexto en los repositorios de documentación específicos.

• No fusione código de diferentes repositorios en el mismo índice. El código fusionado reduce la precisión de la generación de respuestas para la solicitud y conduce al acceso no autorizado del código si la restricción de acceso para los usuarios no se implementa correctamente.

• Asegúrese de gestionar correctamente la seguridad y la autorización durante el proceso de indexación. Para diferentes escenarios de uso, véase Escenarios de casos de uso.

• Asegúrese de obtener todas las aprobaciones organizativas necesarias antes de indexar el contenido confidencial o sensible. El código fuente y los documentos que se utilizan para RAG se guardan como texto sin formato y en formato vectorizado en un almacén vectorial fuera de su repositorio GitHub.

Indexación de repositorios de código

1. Inicie sesión en este proyecto: Crear almacenes vectoriales RAG para watsonx Code Assistant.

2. Pulse Crear proyecto.

3. Seleccione una instancia de Cloud Object Storage en el campo Almacenamiento. Si la instancia Cloud Object Storage no está disponible en la lista desplegable, créela.

4. Pulse Crear.

5. Vaya a la pestaña Activos en su proyecto y haga clic en Rellenar cuaderno de la tienda de vectores.

6. Siga las instrucciones del cuaderno Populate vector store para indexar el código o documento.