Configurare e utilizzare la personalizzazione del codice di Gemini Code Assist

Nota: la personalizzazione del codice di Gemini Code Assist è disponibile solo nella versione Enterprise di Gemini Code Assist. Per ulteriori informazioni, vedi Funzionalità supportate da Gemini Code Assist.

Questo documento descrive come configurare la personalizzazione del codice di Gemini Code Assist collegando Gemini Code Assist ai tuoi repository di codice privato. Questa funzionalità ti consente di ricevere consigli sul codice, che si basano sulle librerie interne, sulle API private e sullo stile di programmazione della tua organizzazione.

Prima di iniziare

• Contatta il tuo rappresentante di vendita per ottenere l'accesso a Personalizzazione del codice di Gemini Code Assist.
• Configura Gemini Code Assist.
• Creare o configurare account utente finale. Tutti gli sviluppatori della tua organizzazione che utilizza Gemini Code Assist deve avere un'identità utente in a Google Cloud che dispone dell'autorizzazione per accedere al tuo progetto Google Cloud. Per ulteriori informazioni, vedi Concedi ruoli nella console Google Cloud. Assicurati che ogni utente abbia i seguenti ruoli:
  • Gemini per utente Google Cloud
  • Utente gruppi di repository

• Configura Developer Connect e poi connettiti al tuo repository GitHub.com o GitLab.com:

  • Connettiti a GitHub.
  • Connettiti a GitLab.

  Inoltre, tieni presente che la personalizzazione del codice supporta solo Connessioni Developer Connect nelle seguenti località (regioni):

  • us-central1
  • europe-west1
  • asia-southeast1

• In un ambiente shell, esegui Comando gcloud components update per assicurarti di aver aggiornato tutti i componenti installati del gcloud CLI all'ultima versione. Per questo passaggio, puoi installare e inizializzare gcloud CLI oppure puoi utilizzare Cloud Shell.

  gcloud components update
  

Scegli quali repository privati sono collegati

Come best practice, assicurati di collegare i repository che:

• Prepara un codice con uno stile o una struttura simile a ciò che vuoi agli sviluppatori di Google Cloud.
• Avere API o librerie private che vuoi chiamare dal tuo codebase attuale.

(Facoltativo) Scegli i file che non devono essere indicizzati

Per impostazione predefinita, la personalizzazione del codice indicizza tutti i file di codice supportati nei repository specificati.

In molti casi, potresti avere file o sottoalberi specifici che non vuoi indicizzati. Ad esempio:

• Informazioni altamente sensibili con accesso limitato all'interno della tua organizzazione
• Codice obsoleto o obsoleto
• Codice generato automaticamente o temporaneo

Per impedire l'esposizione del codice che non vuoi indicizzare, puoi utilizzare i pattern di branch per controllare l'accesso all'indice e utilizzare un branch stabile, ad esempio main.

In alternativa, puoi anche escludere i file dall'indice utilizzando creazione di un file .aiexclude.

Creare un indice

La personalizzazione del codice si basa su un indice per analizzare e analizzare il repository suggerimenti per generare codice e ricerche più rapidi.

Per creare l'indice, in un ambiente shell, utilizza il metodo Comando gemini code-repository-indexes create:

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

Sostituisci quanto segue:

• INDEX_NAME: il nome dell'indice.
• PROJECT_ID: l'ID del tuo progetto Google Cloud.
• REGION: una regione supportata, come indicato nella sezione Prima di iniziare di questa pagina, che hai configurato in Developer Connect nel tuo progetto Google Cloud.

In genere, la creazione dell'indice richiede 30 minuti, ma potrebbe essere necessaria fino a un'ora.

Google limita il numero di indici dei repository di codice a uno per ogni progetto e organizzazione. Se hai bisogno di più indici di repository di codice, puoi richiedere una quota più alta.

Controlla l'accesso all'indice utilizzando i gruppi di repository

Per creare un gruppo di repository, in un ambiente shell, utilizza 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"}]'

Nota: puoi utilizzare le espressioni regolari nelle Sintassi RE2 per specificare il ramo nomi.

Sostituisci quanto segue:

• REPOSITORY_GROUP: il nome del gruppo di repository, ad esempio default.
• PROJECT_ID: l'ID del tuo progetto Google Cloud.
• REGION: una regione supportata, come indicato nella sezione Prima di iniziare di questa pagina, che hai configurato in Developer Connect nel tuo progetto Google Cloud.
• INDEX_NAME: il nome dell'indice creato in un passaggio precedente per creare un indice.
• REPOSITORY_RESOURCE_NAME: nome del repository all'interno della connessione Developer Connect. Per trovare il nome del repository, vai alla pagina Developer Connect nella console Google Cloud e nella scheda Repository cerca l'ID connessione nella colonna Connessione della tabella. Per copiare il nome della risorsa, fai clic sul menu more_vert per visualizzare altre opzioni e seleziona Copia percorso risorsa.
• BRANCH_NAMES: nome dei rami che vuoi indicizzare, ad esempio main|dev.

Puoi anche creare un gruppo di repository con i repository definiti in un file JSON (o YAML), nel seguente 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

Per creare un gruppo di repository in base a un file JSON o YAML, in un ambiente shell, utilizza il 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

Concedi il ruolo IAM al gruppo di repository su un progetto

Ricevi suggerimenti solo dai repository nell'indice. Ogni repository appartiene a uno o più gruppi di repository. Per accedere ai suggerimenti, devi concedere al gruppo di repository il ruolo IAM Utente dei gruppi di repository Cloud AI Companion (roles/cloudaicompanion.repositoryGroupsUser), che contiene l'autorizzazione IAM cloudaicompanion.repositoryGroups.user richiesta, in uno dei seguenti modi:

• Concedi alle entità l'autorizzazione ad accedere all'intero indice.
• Concedi alle entità l'accesso a un sottoinsieme dell'indice.

Concedi ai principali l'autorizzazione ad accedere all'intero indice

1. Per associare un criterio IAM per un progetto, in un ambiente shell, utilizza la Comando projects add-iam-policy-binding:

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

   Sostituisci quanto segue:

   • PROJECT_ID: l'ID progetto in cui si trova il repository gruppo.
   • PRINCIPAL: l'indirizzo email dell'entità che richiede l'accesso, ad esempio user:[e-mail] per una persona o group:[e-mail] per un gruppo.

   Per ulteriori informazioni, vedi gcloud projects set-iam-policy

2. Quando ti viene chiesto di specificare una condizione, inserisci None.

Concedi alle entità l'accesso a un sottoinsieme dell'indice

Puoi creare più gruppi di repository e assegnare ruoli IAM a diverse entità IAM.

Per configurare un criterio IAM, devi preparare il file JSON o YAML del criterio IAM, che conterrà un elenco di gruppi IAM e ruoli assegnati. Ad esempio:

bindings:
- members:
  - group:[e-mail]
  - user:[e-mail]
  role: roles/cloudaicompanion.repositoryGroupsUser

Per ulteriori dettagli e sintassi, consulta Informazioni sui criteri di autorizzazione.

Nota: puoi assegnare ruoli personalizzati ai tuoi gruppi IAM, ma il ruolo personalizzato deve contenere tutte le autorizzazioni del ruolo roles/cloudaicompanion.repositoryGroupsUser.

Per impostare il criterio IAM, utilizza la classe in un ambiente shell 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

Sostituisci quanto segue:

• GROUP_NAME: il nome del gruppo di repository che hai creato in passaggio precedente per controllare l'accesso all'indice utilizzando i gruppi di repository.
• POLICY_FILE: il criterio IAM.
• REGION: una regione supportata, come indicato nella sezione Prima di iniziare di questa pagina, che hai configurato in Developer Connect nel tuo progetto Google Cloud.

• INDEX_NAME: il nome dell'indice che hai creato in un passaggio precedente per creare un indice.

  Per ulteriori informazioni, consulta gcloud gemini code-repository-indexes repository-groups set-iam-policy.

Controllare lo stato di indicizzazione

A seconda del numero di repository da indicizzare e delle relative dimensioni, l'indicizzazione dei contenuti può richiedere fino a 24 ore. Per i repository di grandi dimensioni, l'indicizzazione può richiedere più tempo. L'indicizzazione viene eseguita una volta ogni 24 ore, accettando eventuali modifiche create nel repository.

1. Nella console Google Cloud, vai alla Esplora log:

   Vai a Esplora log

2. Utilizza il filtro dei nomi dei log per visualizzare i log di indexing o cerca l'indicizzazione con il comando seguente:

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

   Sostituisci PROJECT_ID con l'ID progetto in cui in cui si trova il gruppo di repository.

   Ad esempio, per visualizzare gli errori nei log indexing, esegui questo comando: :

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

   Per ulteriori informazioni, consulta Linguaggio delle query di Logging.

3. Esamina gli stati di indicizzazione associati, ad esempio:

   • Inizio dell'indicizzazione del repository, ad esempio Indexing repository REPOSITORY_NAME. Total number of repositories: 10, succeeded: 6, failed: 0.
   • Fine dell'indicizzazione di singoli repository, ad esempio:
     • Operazione riuscita: Successfully finished indexing repository REPOSITORY_NAME. Total number of repositories: 10, succeeded: 7, failed: 0.
     • Errore: Failed to index repository REPOSITORY_NAME. Error: [<error message>]. Total number of repositories: 10, succeeded: 7, failed: 1.
   • Fine dell'indicizzazione del repository, ad esempio:
     • Operazione riuscita: Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 0.
     • Errore: 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.

   Negli stati dell'indice, REPOSITORY_NAME è il repository che vuoi esaminare.

4. Esamina gli errori di indicizzazione associati, ad esempio:

   • Impossibile recuperare il repository.
   • Impossibile elencare i file di repository.
   • Impossibile recuperare le informazioni del repository dall'indice.
   • Impossibile recuperare file dall'indice.
   • Errore interno.

Utilizzare la personalizzazione del codice

Una volta configurata la personalizzazione del codice, gli utenti inizieranno a vedere suggerimenti di completamento e generazione del codice che potrebbero essere basati sul codice privato che hai indicizzato, oltre ai risultati della consapevolezza completa del codebase.

Disattiva la personalizzazione del codice

1. Per elencare tutti i gruppi di repository per l'indice attuale, in un ambiente shell, utilizza la 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
   

   Sostituisci quanto segue:

   • REGION: una regione supportata, come indicato nella sezione Prima di iniziare di questa pagina, che hai configurato in Developer Connect nel tuo progetto Google Cloud.
   • PROJECT_ID: il tuo ID progetto Google Cloud.
   • INDEX_NAME: nome dell'indice che hai creato in un passaggio precedente per creare un indice.

2. Per eliminare un gruppo di repository dall'indice corrente, utilizza il 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. Ripeti il passaggio 3 per ogni gruppo di repository finché non avrai eliminato tutti i gruppi di repository dall'indice.

4. (Facoltativo) Per eliminare l'indice, in un ambiente shell, utilizza il comando gemini code-repository-indexes delete:

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

Passaggi successivi

• Inizia a utilizzare Gemini Code Assist:
  • VS Code: codifica con Gemini Code Assist
  • IntelliJ: codifica con Gemini Code Assist
  • Editor di Cloud Shell: codifica con Gemini Code Assist
  • Cloud Workstations: Codifica con Gemini Code Assist
• Scopri di più su Developer Connect.
• Scopri come e quando Gemini per Google Cloud utilizza i tuoi dati.