Monitora le operazioni a lunga esecuzione

REST

Per elencare le operazioni a lungo termine per una Google Cloud risorsa, segui questo passaggio:

• Chiama il metodo operations.list:

  curl -X GET \
      -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/operations"
  

  DATA_STORE_ID: l'ID dello datastore delle applicazioni di IA creato con il tuo motore. Nell' Google Cloud URL della console, l'ID datastore viene visualizzato dopo engines/ e prima di /data.

Python

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.

Per effettuare l'autenticazione in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

from typing import Optional

from google.cloud import discoveryengine
from google.longrunning import operations_pb2

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_PROCESSOR_LOCATION"  # Options: "global"
# search_engine_id = "YOUR_SEARCH_ENGINE_ID"

# Create filter in https://google.aip.dev/160 syntax
# operations_filter = "YOUR_FILTER"


def list_operations_sample(
    project_id: str,
    location: str,
    search_engine_id: str,
    operations_filter: Optional[str] = None,
) -> operations_pb2.ListOperationsResponse:
    # Create a client
    client = discoveryengine.DocumentServiceClient()

    # The full resource name of the search engine branch.
    name = f"projects/{project_id}/locations/{location}/collections/default_collection/dataStores/{search_engine_id}"

    # Make ListOperations request
    request = operations_pb2.ListOperationsRequest(
        name=name,
        filter=operations_filter,
    )

    # Make ListOperations request
    response = client.list_operations(request=request)

    # Print the Operation Information
    for operation in response.operations:
        print(operation)

    return response

REST

Per conoscere lo stato e visualizzare i dettagli di unoperazione a lunga esecuzione:

1. Trova il nome dell'operazione in due modi:

   • Dopo aver eseguito una chiamata a un metodo che restituisce un'operazione di lunga durata, esamina la risposta.

     Ad esempio, se chiami documents.import, l'inizio della risposta sarà simile al seguente:

     {
       "operations": [
         {
           "name": "projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789",
           "metadata": {
             "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.ImportDocumentsMetadata",
           }
         }
       ]
     }
     

     Il valore name nella risposta fornisce il nome dell'operazione, che può essere utilizzato per eseguire query sullo stato dell'operazione. Non includere le virgolette quando copi il nome dell'operazione.

   • Ottieni il nome dell'operazione elencando le operazioni a lunga esecuzione.

2. Chiama il metodo operations.get sulla risorsa che ha creato l'operazione:

   curl -X GET \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       "https://discoveryengine.googleapis.com/v1/OPERATION_NAME"
   

   OPERATION_NAME: fornisci il nome dell'operazione per la quale hai bisogno di informazioni. Puoi trovare il nome dell'operazione elencando le operazioni a lunga esecuzione.

   Le prime righe della risposta del comando GET sono simili alle seguenti:

   {
         "name": "projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789",
         "metadata": {
           "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.ImportDocumentsMetadata"
         }
       }
   

Python

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.

Per effettuare l'autenticazione in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

from google.cloud import discoveryengine
from google.longrunning import operations_pb2

# TODO(developer): Uncomment these variables before running the sample.
# Example: `projects/{project}/locations/{location}/collections/{default_collection}/dataStores/{search_engine_id}/branches/{0}/operations/{operation_id}`
# operation_name = "YOUR_OPERATION_NAME"


def get_operation_sample(operation_name: str) -> operations_pb2.Operation:
    # Create a client
    client = discoveryengine.DocumentServiceClient()

    # Make GetOperation request
    request = operations_pb2.GetOperationRequest(name=operation_name)
    operation = client.get_operation(request=request)

    # Print the Operation Information
    print(operation)

    return operation

REST

Per eseguire il polling dell'operazione a lunga esecuzione termine fino al completamento:

1. Esegui il seguente comando, che chiama ripetutamente il metodo operations.get, utilizzando un backoff di 10 secondi tra ogni richiesta:

   while true; \
       do curl -X GET \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       "https://discoveryengine.googleapis.com/v1/OPERATION_NAME"; \
       sleep 10; \
       done
   

   OPERATION_NAME: fornisci il nome dell'operazione da eseguire. Puoi trovare il nome dell'operazione elencando le operazioni a lunga esecuzione. Ad esempio: projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789.

2. Interrompi il job di polling (Control+Z) quando lo stato è "done": true.

Python

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.

Per effettuare l'autenticazione in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

from time import sleep

from google.cloud import discoveryengine
from google.longrunning import operations_pb2

# TODO(developer): Uncomment these variables before running the sample.
# Example: `projects/{project}/locations/{location}/collections/{default_collection}/dataStores/{search_engine_id}/branches/{0}/operations/{operation_id}`
# operation_name = "YOUR_OPERATION_NAME"


def poll_operation_sample(
    operation_name: str, limit: int = 10
) -> operations_pb2.Operation:
    # Create a client
    client = discoveryengine.DocumentServiceClient()

    # Make GetOperation request
    request = operations_pb2.GetOperationRequest(name=operation_name)

    for _ in range(limit):
        operation = client.get_operation(request=request)
        # Print the Operation Information
        print(operation)

        # Stop polling when Operation is no longer running
        if operation.done:
            break

        # Wait 10 seconds before polling again
        sleep(10)

    return operation

REST

Per annullare unoperazione a lunga esecuzione:

• Chiama il metodo operations.cancel:

  curl -X post \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://discoveryengine.googleapis.com/v1/OPERATION_NAME":cancel
  

  OPERATION_NAME: fornisci il nome dell'operazione che vuoi annullare. Puoi trovare il nome dell'operazione elencando le operazioni a lunga esecuzione. Ad esempio: projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789.

  Dopo aver effettuato la chiamata API, il server tenta di annullare l'operazione. I risultati che vedi e le azioni che puoi intraprendere sono i seguenti:

  • Un errore con "code": 400 e "status": "FAILED_PRECONDITION" indica che non è stato possibile annullare la richiesta.

  • Un annullamento riuscito genera un oggetto JSON vuoto. Per verificare l'annullamento:

    • Utilizza il metodo operations.get.

    • Se l'operazione viene annullata correttamente, la risposta del metodo operations.get contiene l'errore "code": 1, che rappresenta il codice di stato CANCELLED.

      Ad esempio:

      {
        "name": "projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789",
        "metadata": {
          "@type": "type.googleapis.com/google.cloud.discoveryengine.v1alpha.ImportDocumentsMetadata",
          "createTime": "2025-04-28T21:29:21.199190Z",
          "updateTime": "2025-04-28T21:31:29.076865Z"
        },
        "done": true,
        "error": {
          "code": 1,
          "message": "Operation projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789 is cancelled."
        }
      }
      

Python

Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.

Per effettuare l'autenticazione in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

from google.cloud import discoveryengine
from google.longrunning import operations_pb2

# TODO(developer): Uncomment these variables before running the sample.
# Example: `projects/{project}/locations/{location}/collections/{default_collection}/dataStores/{search_engine_id}/branches/{0}/operations/{operation_id}`
# operation_name = "YOUR_OPERATION_NAME"


def cancel_operation_sample(operation_name: str) -> None:
    # Create a client
    client = discoveryengine.DocumentServiceClient()

    # Make CancelOperation request
    request = operations_pb2.CancelOperationRequest(name=operation_name)
    client.cancel_operation(request=request)

    return