Questo documento descrive come configurare la personalizzazione del codice di Gemini Code Assist collegando Gemini Code Assist ai tuoi repository di codice privati. Questa funzionalità ti consente di ricevere suggerimenti sul codice, che attingono dalle librerie interne, dalle API private e dallo stile di programmazione della tua organizzazione.
Prima di iniziare
- Configura Gemini Code Assist con un abbonamento Enterprise.
- Crea o configura gli account utente finale. Ogni sviluppatore della tua organizzazione che utilizza Gemini Code Assist deve avere un'identità utente in Google Cloud che disponga dell'autorizzazione per accedere al tuo progetto Google Cloud . Per saperne di più, consulta Concedere ruoli nella console Google Cloud . Assicurati che ogni utente abbia i seguenti ruoli:
Configura Developer Connect, quindi connettiti al tuo repository GitHub.com, GitLab.com o Bitbucket.org:
GitHub
GitLab
Bitbucket
Inoltre, tieni presente che la personalizzazione del codice supporta solo le connessioni Developer Connect nelle seguenti località (regioni):
us-central1
europe-west1
asia-southeast1
In un ambiente shell, esegui il comando
gcloud components update
per assicurarti di aver aggiornato tutti i componenti installati di gcloud CLI all'ultima versione. Per questo passaggio, puoi installare e inizializzare gcloud CLI oppure puoi utilizzare Cloud Shell Editor.gcloud components update
Scegli quali repository privati sono connessi
Come best practice, assicurati di collegare repository che:
- Avere un codice con uno stile o una struttura simili a quelli che vuoi che i tuoi sviluppatori scrivano.
- Disponi di librerie o API private che vuoi chiamare dal tuo codebase attuale.
(Facoltativo) Scegliere i file non indicizzati
Per impostazione predefinita, l'indicizzazione della personalizzazione del codice include tutti i file di codice supportati nei repository specificati.
Per evitare l'esposizione di codice che non vuoi indicizzare, puoi utilizzare i pattern dei rami per
controllare l'accesso all'indice e utilizzare un ramo stabile, ad esempio main
.
In alternativa, puoi anche escludere i file dall'indice
creando un file .aiexclude
.
Crea un indice
La personalizzazione del codice si basa su un indice per analizzare il repository al fine di fornire suggerimenti e ricerche più rapidi per la generazione del codice.
Interfaccia a riga di comando gcloud
Per creare l'indice, in un ambiente shell, utilizza il
comando gemini code-repository-indexes create
:
gcloud gemini code-repository-indexes create INDEX_NAME \
--project=PROJECT_ID \
--location=REGION
Terraform
resource "google_gemini_code_repository_index" "example" {
location = "REGION"
code_repository_index_id = "INDEX_NAME"
}
Sostituisci quanto segue:
INDEX_NAME
: il nome dell'indice. Importante: registra il nome dell'indice. Ti servirà per diversi passaggi di questo documento.PROJECT_ID
: il tuo ID 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 del repository di codice a uno per ogni progetto e organizzazione.
Controllare l'accesso all'indice utilizzando i gruppi di repository
Un gruppo di repository è un container per la configurazione dell'indicizzazione, che include
i repository e i relativi pattern di ramificazione. I gruppi di repository sono progettati per
un controllo IAM granulare, che consente agli sviluppatori di accedere ai dati
indicizzati di questi gruppi, per i quali dispongono dell'autorizzazione
cloudaicompanion.repositoryGroups.use
.
I gruppi di repository contengono repository Developer Connect o link dello stesso progetto e della stessa località.
Gli amministratori eseguono le seguenti azioni:
- Crea la risorsa Indice del repository di codice.
- Nello stesso progetto e nella stessa posizione, configura una nuova connessione Developer Connect.
- Collega i repository Git nella connessione.
Recupera i nomi delle risorse dei link, scegli il pattern del ramo da indicizzare per ogni link e inseriscilo in uno o più gruppi di repository.
Interfaccia a riga di comando gcloud
Per creare un gruppo di repository, in un ambiente shell, utilizza il
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"}]'
Terraform
resource "google_gemini_repository_group" "example" {
location = "REGION"
code_repository_index = "INDEX_NAME"
repository_group_id = "REPOSITORY_GROUP"
repositories {
resource = "REPOSITORY_RESOURCE_NAME"
branch_pattern = "BRANCH_NAMES"
}
}
Sostituisci quanto segue:
REPOSITORY_GROUP
: il nome del gruppo di repository, ad esempiodefault
.PROJECT_ID
: il tuo ID 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 che hai 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
: il nome dei rami che vuoi indicizzare, ad esempiomain|dev
.
Puoi anche creare un gruppo di repository con repository definiti in un file JSON (o YAML), formattato come segue:
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
Se preferisci, puoi criptare e controllare i tuoi dati con una chiave di crittografia gestita dal cliente (CMEK) tramite Cloud Key Management Service. Per scoprire di più sull'utilizzo di una chiave CMEK, consulta Criptare i dati con le chiavi di crittografia gestite dal cliente.
Concedi il ruolo IAM al gruppo di repository in 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 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.
Concedere alle entità di servizio l'autorizzazione ad accedere all'intero indice
Per associare un criterio IAM a un progetto, in un ambiente shell, utilizza il 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 gruppo di repository.PRINCIPAL
: l'indirizzo email del principal che deve accedere, ad esempiouser:test-user@gmail.com
per un singolo utente ogroup:admins@example.com
per un gruppo.
Per ulteriori informazioni, vedi
gcloud projects set-iam-policy
.Quando ti viene chiesto di specificare una condizione, inserisci
None
.
Concedere alle entità l'accesso a un sottoinsieme dell'indice
Puoi creare più gruppi di repository e assegnare ruoli IAM a diverse entità IAM.
Interfaccia a riga di comando gcloud
Per configurare una policy IAM, devi preparare il file JSON o YAML della policy IAM, che conterrà un elenco di gruppi IAM e ruoli assegnati. Ad esempio:
bindings:
- members:
- group:my-group@example.com
- user:test-user@example.com
role: roles/cloudaicompanion.repositoryGroupsUser
Per ulteriori dettagli e sintassi, vedi Informazioni sui criteri di autorizzazione.
Per impostare il criterio IAM, in un ambiente shell, utilizza il 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 un 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 progettoGoogle Cloud .INDEX_NAME
: il nome dell'indice che hai creato in un passaggio precedente per creare un indice.Per ulteriori informazioni, vedi
gcloud gemini code-repository-indexes repository-groups set-iam-policy
.
Terraform
data "google_iam_policy" "foo" {
binding {
role = "roles/cloudaicompanion.repositoryGroupsUser"
members = ["test-user@example.com"]
}
}
resource "google_gemini_repository_group_iam_policy" "foo" {
project = "PROJECT_ID"
location = "REGION"
code_repository_index_id = "INDEX_NAME"
repository_group_id = "GROUP_NAME"
policy_data = data.google_iam_policy.foo.policy_data
}
data "google_gemini_repository_group_iam_policy" "foo" {
project = "PROJECT_ID"
location = "REGION"
code_repository_index_id = "INDEX_NAME"
repository_group_id = "GROUP_NAME"
depends_on = [
google_gemini_repository_group_iam_policy.foo
]
}
Puoi anche creare un binding:
resource "google_gemini_repository_group_iam_binding" "foo" {
project = "PROJECT_ID"
location = "REGION"
code_repository_index_id = "INDEX_NAME"
repository_group_id = "GROUP_NAME"
role = "roles/cloudaicompanion.repositoryGroupsUser"
members = ["test-user@example.com"]
}
Sostituisci quanto segue:
GROUP_NAME
: il nome del gruppo di repository che hai creato in un passaggio precedente per controllare l'accesso all'indice utilizzando i gruppi di repository.REGION
: una regione supportata, come indicato nella sezione Prima di iniziare di questa pagina, che hai configurato in Developer Connect nel tuo progettoGoogle Cloud .INDEX_NAME
: il nome dell'indice che hai creato in un passaggio precedente per creare un indice.Per ulteriori informazioni, vedi
gcloud gemini code-repository-indexes repository-groups set-iam-policy
.
Controllare lo stato dell'indicizzazione
A seconda del numero di repository che vuoi indicizzare e delle loro 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 avviene una volta ogni 24 ore e rileva eventuali modifiche apportate al repository.
Cerca i log di
indexing
. Per maggiori informazioni, consulta Linguaggio delle query di Logging.Console
Nella console Google Cloud , vai a Esplora log.
Utilizza il filtro dei nomi dei log per visualizzare i log
indexing
.
Interfaccia a riga di comando gcloud
Per cercare i log di indicizzazione, in un ambiente shell, utilizza il comando
logging read
:gcloud logging read "logName="projects/PROJECT_ID/logs/indexing""
Sostituisci
PROJECT_ID
con l'ID progetto in cui si trova il gruppo di repository.Ad esempio, per visualizzare gli errori nei log di
indexing
, esegui questo comando:gcloud logging read "logName="projects/PROJECT_ID/logs/indexing" AND severity>=ERROR"
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 del singolo 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.
- Operazione riuscita:
- 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.
- Operazione riuscita:
Negli stati dell'indice,
REPOSITORY_NAME
è il repository che vuoi esaminare.- Inizio dell'indicizzazione del repository, ad esempio
Controlla gli errori di indicizzazione associati, ad esempio:
- Impossibile recuperare il repository.
- Impossibile elencare i file del repository.
- Impossibile recuperare le informazioni sul repository dall'indice.
- Impossibile recuperare i file dall'indice.
- Errore interno.
Utilizzare la personalizzazione del codice
Una volta configurata la personalizzazione del codice, inizierai a visualizzare suggerimenti per il completamento e la generazione del codice che potrebbero essere basati sul codice privato che hai indicizzato, oltre ai risultati della conoscenza completa del codebase.
Per scoprire di più sull'utilizzo della personalizzazione del codice e sulle best practice, consulta Utilizzare la personalizzazione del codice.
Disattivare la personalizzazione del codice
Per elencare tutti i gruppi di repository per l'indice corrente, in un ambiente shell, utilizza il 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 progettoGoogle Cloud .PROJECT_ID
: il tuo ID progetto Google Cloud .INDEX_NAME
: il nome dell'indice che hai creato in un passaggio precedente per creare un indice.
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
Ripeti il passaggio 3 per ogni gruppo di repository finché non avrai eliminato tutti i gruppi di repository dall'indice.
(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, IntelliJ e altri IDE JetBrains supportati: Codifica con l'Assistente codice Gemini
- Editor di Cloud Shell: codifica con Gemini Code Assist
- Cloud Workstations: Scrivi codice con Gemini Code Assist
- Scopri come utilizzare la personalizzazione del codice e le best practice.
- Scopri come criptare i dati con le chiavi di crittografia gestite dal cliente (CMEK).
- Scopri di più su Developer Connect.
- Scopri come e quando Gemini per Google Cloud utilizza i tuoi dati.