Scenari di utilizzo per RAG

Esamina i seguenti scenari di utilizzo per comprendere come configurare e utilizzare RAG (retrieval augmented generation) con watsonx Code Assistant per varie strutture di team e requisiti di accesso.

Panoramica

I seguenti scenari illustrano diversi modi per configurare e utilizzare RAG in watsonx Code Assistant base alla struttura del team e ai requisiti di accesso. Ogni scenario include i passaggi di configurazione e le considerazioni necessarie per implementare efficacemente il RAG.

Utilizzo di un unico repository di codice

Se stai lavorando in un unico repository e desideri utilizzare il codice di questo repository come contesto per le conversazioni in chat, segui questo approccio:

Prerequisiti:

  • Hai accesso al repository in GitHub.
  • Hai un token di Git accesso personale dal tuo GitHub account.

Passaggi di configurazione:

  1. Indicizza il repository nel negozio vettoriale. Per ulteriori informazioni, consulta Indicizzazione dei repository di codice e della documentazione.
  2. Crea una risorsa di connessione per il repository. Per ulteriori informazioni, vedere Configurazione delle risorse di connessione.
  3. Completa la configurazione Git del token di accesso personale in Visual Studio Code. Per ulteriori informazioni, consulta Configurazione della generazione aumentata dal recupero (RAG).
  4. Apri il repository in Visual Studio Code.
  5. Utilizza il @repo comando nella chat per generare risposte che utilizzano il contesto dal repository.

Utilizzo di più repository di codice

Se stai lavorando su un repository che ha dipendenze da altri repository, puoi utilizzare il codice proveniente da più repository come contesto per le conversazioni in chat.

Prerequisiti:

  • Hai accesso a tutti i repository in GitHub.
  • Hai un token di Git accesso personale dal tuo GitHub account.

Passaggi di configurazione:

  1. Indicizza separatamente ogni repository nel negozio vettoriale. Per ulteriori informazioni, consulta Indicizzazione dei repository di codice e della documentazione.
  2. Crea una risorsa di connessione per ogni repository. Per ulteriori informazioni, vedere Configurazione delle risorse di connessione.
  3. Completa la configurazione Git del token di accesso personale in Visual Studio Code. Per ulteriori informazioni, consulta Configurazione della generazione aumentata dal recupero (RAG).
  4. Nel repository primario, configura un file di configurazione YAML che elenchi tutti i repository. Per ulteriori informazioni, consulta Impostazione della configurazione YAML per RAG.
  5. Utilizza il @repo comando nella chat per generare risposte che utilizzano il contesto di tutti i repository configurati.
Nota: se si utilizza lo stesso indice per più repository, il controllo GitHub di accesso non viene applicato ai repository aggiuntivi. Se non si ha accesso a uno dei repository, watsonx Code Assistant genera il contesto solo dai repository autorizzati.

Consentire a tutti gli utenti di un team di accedere alla documentazione del progetto

È possibile consentire a tutti gli utenti di un team di accedere agli archivi della documentazione di progetto e utilizzare i documenti come contesto per le conversazioni in chat.

Prerequisiti:

  • Tutti i membri del team hanno accesso agli archivi della documentazione.
  • Esiste uno spazio di distribuzione che include tutti i membri del team.

Passaggi di configurazione:

  1. Indicizza gli archivi della documentazione di progetto nel magazzino vettoriale. Per ulteriori informazioni, consulta Indicizzazione dei repository di codice e della documentazione.
  2. Se tutti gli utenti hanno accesso agli archivi di documentazione indicizzati, è possibile utilizzare lo stesso indice per tutta la documentazione. Se gli utenti hanno restrizioni di accesso, consultare il caso d'uso per abilitare gli utenti in diversi sottogruppi.
  3. Crea una risorsa di connessione per l'indice della documentazione nello spazio di distribuzione che include tutti i membri del team. Per ulteriori informazioni, vedere Configurazione delle risorse di connessione.
  4. Utilizza il @docs comando nella chat per generare risposte che utilizzano il contesto dall'indice della documentazione.
Nota: il token di GitHub accesso personale non viene utilizzato per verificare l'accesso ai contenuti della documentazione. È possibile combinare diversi repository di documentazione nello stesso indice nel negozio vettoriale. Il contenuto della documentazione è meno restrittivo rispetto ai repository di codice e un unico indice per tutti i repository di documentazione semplifica il processo di gestione dell'indice. L'autorizzazione ad accedere agli archivi di documentazione è controllata tramite l'appartenenza allo spazio di distribuzione.

Consentire agli utenti di diversi sottogruppi di accedere alla documentazione del progetto

In questo scenario, diversi sottogruppi all'interno di un grande team mantengono archivi separati della documentazione di progetto. L'accesso agli archivi di documentazione è limitato a specifici sottogruppi, mentre gli altri sottogruppi non hanno accesso a tali archivi.

Prerequisiti:

  • Ogni sottogruppo dispone dei propri archivi di documentazione.
  • Esiste uno spazio di distribuzione per ogni sottogruppo che include i suoi membri.

Passaggi di configurazione:

  1. Indicizza separatamente gli archivi di documentazione nel magazzino vettoriale. Per ulteriori informazioni, consulta Indicizzazione dei repository di codice e della documentazione.
  2. Assicurarsi che venga creato uno spazio di distribuzione per ogni sottogruppo che includa i suoi utenti.
  3. Per ogni indice dell'archivio della documentazione, creare una risorsa di connessione nello spazio di distribuzione corrispondente. Per ulteriori informazioni, vedere Configurazione delle risorse di connessione.
  4. Utilizza il @docs comando nella chat per generare risposte che utilizzano il contesto dall'indice della documentazione.

watsonx Code Assistant utilizza l'indice del repository della documentazione basato sullo spazio di distribuzione assegnato agli utenti. Non è richiesta alcuna configurazione lato client.

Consentire agli utenti con ruoli specifici di accedere alla documentazione del progetto

In questo scenario, gli utenti di un team necessitano di accedere a diversi set di documentazione in base ai loro ruoli. L'ambito della documentazione utilizzata come contesto varia a seconda degli utenti senza restrizioni di accesso. Ad esempio, gli sviluppatori necessitano solo della documentazione tecnica e delle API, mentre gli analisti aziendali si concentrano sui documenti relativi ai processi aziendali.

Prerequisiti:

  • La documentazione è organizzata per ruolo o funzione.
  • Esiste uno spazio di distribuzione che include tutti i membri del team.

Passaggi di configurazione:

  1. Indicizza separatamente ogni repository di documentazione nell'archivio vettoriale. Per ulteriori informazioni, consulta Indicizzazione dei repository di codice e della documentazione.
  2. Crea una risorsa di connessione per ogni indice nello spazio di distribuzione del team. Per ulteriori informazioni, vedere Configurazione delle risorse di connessione.
  3. Configurare un file di configurazione YAML per gli indici di documentazione richiesti che devono essere utilizzati come contesto. Se è necessario utilizzare più indici di documentazione, configurare ciascuno di essi nel file YAML. Per ulteriori informazioni, consulta Impostazione della configurazione YAML per RAG.
  4. Utilizza il @docs comando nella chat per generare risposte che utilizzano il contesto dagli indici della documentazione configurati.

Cosa fare successivamente

Per ulteriori informazioni sulla configurazione di RAG, vedere Configurazione della generazione aumentata dal recupero (RAG).