Estensione Vertex AI Search

Anteprima

Vertex AI Extensions è un'offerta in anteprima, soggetta ai "Termini dell'offerta pre-GA" dei Termini specifici dei servizi Google Cloud. Prodotti e funzionalità pre-GA potrebbero avere assistenza limitata e le modifiche ai prodotti e alle funzionalità pre-GA potrebbero non essere compatibili con le altre versioni pre-GA. Per ulteriori informazioni, consulta le descrizioni della fase di lancio. Inoltre, utilizzando Vertex AI Extensions, accetti i Termini e condizioni di Anteprima dell'IA generativa ("Termini di anteprima").

Questo documento mostra come registrarsi e utilizzare il servizio fornito da Google Estensione di Vertex AI Search dalla console Google Cloud e dall'API Vertex AI. Questa estensione consente di accedere ai corpora dei siti web e ai dati non strutturati e di eseguire ricerche al loro interno per fornire risposte pertinenti a domande in linguaggio naturale, ad esempio:

• "Come sono cambiate le minacce competitive per l'azienda rispetto al primo trimestre dell'ultimo trimestre rispetto al primo trimestre di quest'anno?"
• "Quali parti dell'azienda stanno crescendo più rapidamente? A che velocità?"

L'estensione Vertex AI Search utilizza Vertex AI Search per recuperare risultati significativi dal tuo datastore. L'estensione Vertex AI Search è definita in un file vertex_ai_search.yaml di specifica OpenAPI.

Per utilizzare l'estensione Vertex AI Search, devi creare un data store nella regione globale con un ambito di ricerca specificato. Per risultati di ricerca ottimali, attiva l'indicizzazione avanzata per i dati del sito web e la versione Enterprise per i dati non strutturati. Consulta Informazioni sulle funzionalità avanzate per ulteriori informazioni.

Espandimi Comprimimi

openapi: "3.0.0"
info:
  title: Vertex AI Search
  version: v1alpha
  description: >
    Performs search on user ingested data including website and unstructured data type.

    This extension is used when user wants to search or retrieve meaningful results from their ingested data in the Vertex AI Search service.

    Supported AuthTypes:
    - GOOGLE_SERVICE_ACCOUNT_AUTH: (only supports using Vertex AI Extension Service Agent).
paths:
  /search:
    get:
      operationId: search
      description: Retrieves the results from user's query by searching in the data store.
      parameters:
      - name: query
        in: query
        schema:
          type: string
        description: User natural language instructions for search.
        required: true
      responses:
        default:
          description: Search execution result.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResult"

components:
  schemas:
    SearchResult:
      description: Top results from search response.
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
                description: Retrieved document title.
              display_link:
                type: string
                description: Retrieved document link to display.
              link:
                type: string
                description: Retrieved document link.
              extractive_segments:
                type: array
                description: Extractive segments from the retrieved file.
                items:
                  type: string
              extractive_answers:
                type: array
                description: Extractive answers from the retrieved file. These are generated from the extractive segments.
                items:
                  type: string

    

Per scoprire di più sulle estensioni di Google con tutorial end-to-end, consulta i seguenti notebook Jupyter:

• Flusso di lavoro degli analisti aziendali con Vertex AI Extensions: utilizza l'estensione Interprete di codice e l'estensione Vertex AI Search per completare un report di ricerca sulle opportunità di investimento immobiliare per gli stakeholder aziendali.
  Colab | GitHub | Vertex AI Workbench
• Flusso di lavoro di analisi delle recensioni dei giochi con le estensioni Vertex AI: utilizza l'estensione Interprete codice per analizzare le recensioni dei giochi di Steam. Utilizza l'estensione Vertex AI Search per riepilogare le recensioni dei giochi provenienti da siti web. Utilizza l'estensione Interprete codice per creare un report con tutti gli asset generati.
  Colab | GitHub | Vertex AI Workbench

Prima di iniziare

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Vertex AI API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Vertex AI API.

   Enable the API

Registra ed esegui l'estensione Vertex AI Search

Le sezioni seguenti mostrano come registrare l'estensione Vertex AI Search utilizzando la console Google Cloud e l'API Vertex AI. Dopo aver registrato l'estensione, puoi utilizzando l'API Vertex AI.

Console

Registrare l'estensione

Esegui i seguenti passaggi per registrare l'estensione Vertex AI Search utilizzando la console Google Cloud.

1. Nella console Google Cloud, vai alla pagina Estensioni di Vertex AI.

   Vai alle estensioni di Vertex AI

2. Fai clic su Crea estensione.

3. Nella finestra di dialogo Crea una nuova estensione, compila i seguenti campi:

   • Nome estensione: inserisci un nome per l'estensione, ad esempio "vertex_search_extension".
   • (Facoltativo) Descrizione:inserisci una descrizione dell'estensione, ad esempio "Un'estensione di Vertex AI Search".
   • Tipo di estensione: seleziona Vertex AI search.

4. Nella sezione File di specifica OpenAPI visualizzata, verifica che i seguenti campi siano impostati correttamente:

   • Nome API: vertex_ai_search.
   • Descrizione dell'API: Performs search on user ingested data including website and unstructured data type...
   • Fonte: Cloud Storage.
   • Specifiche OpenAPI: vertex-extension-public/vertex_ai_search.yaml.
   • Autenticazione: Google service account.

5. Nella sezione Configurazioni di runtime, fornisci un nome per la configurazione del servizio. Il nome della configurazione di pubblicazione è specificato in vertexAiSearchRuntimeConfig. È formattato e completato come segue: projects/PROJECT_ID/locations/global/collections/COLLECTION_NAME/engines/ENGINE/servingConfigs/SERVING_CONFIG

   • Imposta COLLECTION_NAME su default_collection.
   • Imposta ENGINE sull'ID applicazione che hai ricevuto quando hai creato la tua applicazione di ricerca. Per saperne di più, vedi Creare un'app di ricerca per i dati dei siti web.
   • Imposta SERVING_CONFIG su default_search.

6. Fai clic su Crea estensione.

REST

Registrare l'estensione

Invia una richiesta per l'API Vertex AI extensions.import per registrare l'estensione Vertex AI Search.

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

• PROJECT_ID: l'ID del tuo progetto Google Cloud.
• REGION: una regione Compute Engine.
• DISPLAY_NAME: l'estensione del nome visualizzata agli utenti, ad esempio "my_search_extension".
• DESCRIPTION: (facoltativo) l'estensione description mostrato agli utenti, ad esempio "Un'estensione di ricerca".
• SERVICE_ACCOUNT: (Facoltativo) L'estensione di ricerca Vertex AI utilizza GOOGLE_SERVICE_ACCOUNT_AUTH come mostrato nel corpo della richiesta di esempio. Se non specifichi un account di servizio, l'estensione utilizza l'account di servizio predefinito Vertex AI Extension Service Agent. Se specifichi un account di servizio diverso, concedi la iam.serviceAccounts.getAccessToken all'account di servizio dell'agente di servizio estensione Vertex AI per l'account di servizio specificato.
• SERVING_CONFIG_NAME: il nome della configurazione di pubblicazione è specificato in vertexAiSearchRuntimeConfig. Deve essere formattato e compilato come segue: projects/PROJECT_ID/locations/global/collections/COLLECTION_NAME/engines/ENGINE/servingConfigs/SERVING_CONFIG.
  • PROJECT_ID: l'ID del tuo progetto Google Cloud.
  • Imposta COLLECTION_NAME su default_collection.
  • ENGINE: l'ID applicazione che hai ricevuto quando hai creato l'applicazione di ricerca. Per scoprire di più, consulta Creare un'app di ricerca per i dati dei siti web.
  • Imposta SERVING_CONFIG su default_search.

Metodo HTTP e URL:

POST https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions:import

Corpo JSON della richiesta:

{
  "displayName":"DISPLAY_NAME",
  "description":"DESCRIPTION",
  "manifest":{
    "name":"vertex_ai_search_tool",
    "description":"A Vertex AI Search tool",
    "apiSpec":{
      "openApiGcsUri":"gs://vertex-extension-public/vertex_ai_search.yaml"
    },
    "authConfig":{
      "authType":"GOOGLE_SERVICE_ACCOUNT_AUTH",
      "googleServiceAccountConfig":{
        "serviceAccount":"SERVICE_ACCOUNT"
      }
    }
  }
  "runtimeConfig": {
     "vertexAiSearchRuntimeConfig": {
        "servingConfigName": "SERVING_CONFIG_NAME",
     }
  }
}

Per inviare la richiesta, scegli una delle seguenti opzioni:

curl

Nota: Il comando seguente presuppone che tu abbia eseguito l'accesso a l'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che ti consente di accedere automaticamente all'interfaccia a riga di comando gcloud di Google. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json. ed esegui questo comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions:import"

PowerShell

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso alla CLI gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list

Salva il corpo della richiesta in un file denominato request.json. ed esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions:import" | Select-Object -Expand Content

Eseguire l'estensione

Puoi inviare un'operazione execute all'API Vertex AI per ottenere risultati significativi dal datastore.

Ricerca documento

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

• PROJECT_ID: l'ID del tuo progetto Google Cloud.
• REGION: una regione Compute Engine.
• EXTENSION_ID: l'ID della tua estensione Vertex AI Search elencato in Dettagli dell'estensione nella console Google Cloud.

Metodo HTTP e URL:

POST https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions/EXTENSION_ID:execute

Corpo JSON della richiesta:

{
  "operation_id":"search",
  "operation_params":{
    "query":"Housing affordability since 2010",
  }
}

Per inviare la richiesta, scegli una delle seguenti opzioni:

curl

Nota: Il comando seguente presuppone che tu abbia eseguito l'accesso a l'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che ti consente di accedere automaticamente all'interfaccia a riga di comando gcloud di Google. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list

Salva il corpo della richiesta in un file denominato request.json. ed esegui questo comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions/EXTENSION_ID:execute"

PowerShell

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso alla CLI gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json. ed esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions/EXTENSION_ID:execute" | Select-Object -Expand Content