Configura y usa la personalización de código de Gemini Code Assist

En este documento, se describe cómo configurar la personalización de código de Gemini Code Assist conectando Gemini Code Assist a tus repositorios de código privados. Esta función te permite recibir recomendaciones de código, que se basan en las bibliotecas internas, las APIs privadas y el estilo de programación de tu organización.

Antes de comenzar

Elige qué repositorios privados están conectados

Como práctica recomendada, asegúrate de conectar repositorios que cumplan con los siguientes requisitos:

  • Tener un código con un estilo o una estructura similares a los que quieres que escriban los desarrolladores
  • Tener bibliotecas o APIs privadas a las que te gustaría llamar desde tu base de código actual

Elige qué archivos no se indexarán (opcional)

De forma predeterminada, la personalización de código indexa todos los archivos de código admitidos en tus repositorios especificados.

En muchos casos, es posible que tengas archivos o subárboles específicos que no quieras indexar. Por ejemplo:

  • Información altamente sensible con acceso limitado dentro de tu organización
  • Código antiguo o obsoleto
  • Código temporal o generado automáticamente

Para evitar la exposición de código que no deseas indexar, puedes usar patrones de ramas para controlar el acceso a tu índice y usar una rama estable, como main.

Como alternativa, también puedes excluir archivos del índice si creas un archivo .aiexclude.

Crea un índice

La personalización de código se basa en un índice para analizar y analizar tu repositorio en busca de sugerencias y búsquedas de generación de código más rápidas.

Para crear el índice, en un entorno de shell, usa el comando gemini code-repository-indexes create:

gcloud gemini code-repository-indexes create INDEX_NAME \
    --project=PROJECT_ID \
    --location=REGION

Reemplaza lo siguiente:

  • INDEX_NAME: Es el nombre de tu índice. Importante: Registra el nombre de tu índice. Lo necesitarás para varios pasos en este documento.
  • PROJECT_ID: Es el ID de tu proyecto de Google Cloud.
  • REGION: Es una región compatible, como se indica en la sección Antes de comenzar de esta página, que configuraste en Developer Connect en tu proyecto de Google Cloud.

Por lo general, la creación del índice tarda 30 minutos en completarse, pero puede demorar hasta una hora.

Google limita la cantidad de índices del repositorio de código a uno para cada proyecto y organización.

Controla el acceso a tu índice con grupos de repositorios

Un grupo de repositorios es un contenedor para la configuración de indexación, que incluye los repositorios y sus patrones de ramas. Los grupos de repositorios están diseñados para un control detallado de IAM, lo que les brinda a los desarrolladores acceso a los datos indexados de esos grupos, donde tienen el permiso cloudaicompanion.repositoryGroups.use.

Los grupos de repositorios contienen repositorios o vínculos de Developer Connect del mismo proyecto y ubicación.

Los administradores realizan las siguientes acciones:

  • Crea el recurso de índice del repositorio de código.
  • En el mismo proyecto y ubicación, configura una nueva conexión de Developer Connect.
  • Vincula los repositorios de Git en la conexión.
  • Obtén los nombres de los recursos de los vínculos, elige el patrón de rama para indexar cada vínculo y colócalo en uno o varios grupos de repositorios.

Para crear un grupo de repositorios, en un entorno de shell, usa el comando gemini code-repository-indexes repository-groups create:

    gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
        --project=PROJECT_ID \
        --location=REGION \
        --code-repository-index=INDEX_NAME \
        --repositories='[{"resource": "REPOSITORY_RESOURCE_NAME", "branchPattern": "BRANCH_NAMES"}]'

Reemplaza lo siguiente:

  • REPOSITORY_GROUP: Es el nombre del grupo del repositorio, como default.
  • PROJECT_ID: Es el ID de tu proyecto de Google Cloud.
  • REGION: Es una región compatible, como se indica en la sección Antes de comenzar de esta página, que configuraste en Developer Connect en tu proyecto de Google Cloud.
  • INDEX_NAME: Es el nombre del índice que creaste en un paso anterior para crear un índice.
  • REPOSITORY_RESOURCE_NAME: Es el nombre del repositorio dentro de la conexión de Developer Connect. Para encontrar el nombre del repositorio, ve a la página Developer Connect en la consola de Google Cloud y, en la pestaña Repositorios, busca el ID de conexión en la columna Conexión de la tabla. Para copiar el nombre del recurso, haz clic en el menú more_vert para obtener más opciones y selecciona Copiar ruta de acceso del recurso.
  • BRANCH_NAMES: Es el nombre de las ramas que deseas indexar, como main|dev.

También puedes crear un grupo de repositorios con repositorios definidos en un archivo JSON (o YAML) con el siguiente formato:

JSON

[
  {
      "resource": "REPOSITORY_RESOURCE_NAME", "branchPattern": "main|dev"
  },
  {
      "resource": "REPOSITORY_RESOURCE_NAME", "branchPattern": "dev"
  }
]

YAML

- resource: REPOSITORY_RESOURCE_NAME
  branchPattern: main|dev

- resource: REPOSITORY_RESOURCE_NAME
  branchPattern: dev

Para crear un grupo de repositorios basado en un archivo JSON o YAML, en un entorno de shell, usa el comando gemini code-repository-indexes repository-groups create:

JSON

gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME \
    --repositories=FILEPATH.json

YAML

gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME \
    --repositories=FILEPATH.yaml

Otorga un rol de IAM al grupo del repositorio en un proyecto

Solo recibirás sugerencias de repositorios del índice. Cada repositorio pertenece a uno o varios grupos de repositorios. Para acceder a las sugerencias, debes otorgar el rol de IAM de usuario de grupos de repositorios de Cloud AI Companion (roles/cloudaicompanion.repositoryGroupsUser), que contiene el permiso de IAM cloudaicompanion.repositoryGroups.user requerido, al grupo de repositorios de una de las siguientes maneras:

  • Otorga permiso a los principales para acceder a todo el índice.
  • Otorga a los principales acceso a un subconjunto del índice.

Otorga permiso a las principales para acceder a todo el índice

  1. Para vincular una política de IAM a un proyecto, en un entorno de shell, usa el comando projects add-iam-policy-binding:

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member='PRINCIPAL' \
    --role='roles/cloudaicompanion.repositoryGroupsUser'

    Reemplaza lo siguiente:

    • PROJECT_ID: El ID del proyecto en el que se encuentra el grupo del repositorio.
    • PRINCIPAL: Es la dirección de correo electrónico del principal que necesita acceso, por ejemplo, user:test-user@gmail.com para una persona o group:admins@example.com para un grupo.

    Para obtener más información, consulta gcloud projects set-iam-policy

  2. Cuando se te solicite que especifiques una condición, ingresa None.

Otorga acceso a los principales a un subconjunto del índice

Puedes crear varios grupos de repositorios y asignar roles de IAM a diferentes principales de IAM.

Para configurar una política de IAM, debes preparar el archivo JSON o YAML de la política de IAM, que contendrá una lista de los grupos de IAM y los roles asignados. Por ejemplo:

bindings:
- members:
  - group:my-group@example.com
  - user:test-user@example.com
  role: roles/cloudaicompanion.repositoryGroupsUser

Para obtener más detalles y sintaxis, consulta Comprende las políticas de permisos.

Para configurar la política de IAM, en un entorno de shell, usa el comando gemini code-repository-indexes repository-groups set-iam-policy:

gcloud gemini code-repository-indexes repository-groups set-iam-policy GROUP_NAMEPOLICY_FILE \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME

Reemplaza lo siguiente:

Cómo verificar el estado de la indexación

Según la cantidad de repositorios que deseas indexar y su tamaño, la indexación de contenido puede tardar hasta 24 horas. En el caso de los repositorios grandes, la indexación puede tardar más. El indexado se realiza una vez cada 24 horas y detecta cualquier cambio que se haya realizado en el repositorio.

  1. Busca los registros de indexing. Para obtener más información, consulta Lenguaje de consulta de Logging.

    Console

    1. En la consola de Google Cloud, ve al Explorador de registros.

      Ir al Explorador de registros

    2. Usa el filtro de nombres de registro para ver los registros de indexing.

    gcloud

    Para buscar los registros de indexación, en un entorno de shell, usa el comando logging read:

    gcloud logging read "logName="projects/PROJECT_ID/logs/indexing""

    Reemplaza PROJECT_ID por el ID del proyecto en el que se encuentra el grupo de repositorios.

    Por ejemplo, para ver los errores en los registros de indexing, ejecuta el siguiente comando:

    gcloud logging read "logName="projects/PROJECT_ID/logs/indexing" AND severity>=ERROR"

  2. Revisa los estados de indexación asociados, como los siguientes:

    • Inicio de la indexación del repositorio (por ejemplo, Indexing repository REPOSITORY_NAME. Total number of repositories: 10, succeeded: 6, failed: 0.)
    • Fin de la indexación de repositorios individuales, por ejemplo:
      • Listo: Successfully finished indexing repository REPOSITORY_NAME. Total number of repositories: 10, succeeded: 7, failed: 0.
      • Error: Failed to index repository REPOSITORY_NAME. Error: [<error message>]. Total number of repositories: 10, succeeded: 7, failed: 1.
    • Fin de la indexación del repositorio (por ejemplo):
      • Listo: Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 0.
      • Error: Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 1. Repositories that were not successfully fetched will be retried in the next run.

    En los estados del índice, REPOSITORY_NAME es el repositorio que quieres revisar.

  3. Revisa los errores de indexación asociados, como los siguientes:

    • No se pudo recuperar el repositorio.
    • No se pudo mostrar la lista de archivos del repositorio.
    • No se pudo recuperar la información del repositorio del índice.
    • No se pudieron recuperar los archivos del índice.
    • Error interno.

Usa la personalización de código

Una vez que configures la personalización de código, los usuarios comenzarán a ver sugerencias de finalización y generación de código que pueden basarse en el código privado que indexaste, además de los resultados de la detección completa de la base de código.

Desactiva la personalización de código

  1. Para enumerar todos los grupos de repositorios del índice actual, en un entorno de shell, usa el comando gemini code-repository-indexes repository-groups list:

    gcloud gemini code-repository-indexes repository-groups list --location=REGION \
    --project=PROJECT_ID \
    --code-repository-index=INDEX_NAME --uri

    Reemplaza lo siguiente:

    • REGION: Una región compatible, como se indica en la sección Antes de comenzar de esta página, que configuraste en Developer Connect en tu proyecto de Google Cloud.
    • PROJECT_ID: Es el ID de tu proyecto de Google Cloud.
    • INDEX_NAME: Es el nombre del índice que creaste en un paso anterior para crear un índice.

  2. Para borrar un grupo de repositorios del índice actual, usa el comando gemini code-repository-indexes repository-groups delete:

    gcloud gemini code-repository-indexes repository-groups delete REPOSITORY_GROUP \
    --location=REGION \
    --project=PROJECT_ID \
    --code-repository-index=INDEX_NAME

  3. Repite el paso 3 para cada grupo de repositorios hasta que borres todos los grupos de repositorios del índice.

  4. Opcional: Para borrar el índice, en un entorno de shell, usa el comando gemini code-repository-indexes delete:

    gcloud gemini code-repository-indexes delete INDEX_NAME \
    --location=REGION \
    --project=PROJECT_ID

¿Qué sigue?