Method: projects.locations.dataStores.branches.documents.purge

Elimina definitivamente tutti i Document selezionati in un ramo.

Questo processo è asincrono. A seconda del numero di Document da eliminare, il completamento di questa operazione può richiedere ore. Prima del completamento dell'operazione di eliminazione, alcuni Document potrebbero essere ancora restituiti da DocumentService.GetDocument o DocumentService.ListDocuments.

Per ottenere un elenco dei Document da eliminare, imposta PurgeDocumentsRequest.force su false.

Richiesta HTTP

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa padre, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "filter": string,
  "errorConfig": {
    object (PurgeErrorConfig)
  },
  "force": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsSource)
  },
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
}
Campi
filter

string

Obbligatorio. Filtra i documenti corrispondenti da eliminare. L'unico valore attualmente supportato è * (tutti gli elementi).
errorConfig

object (PurgeErrorConfig)

La posizione desiderata degli errori riscontrati durante l'eliminazione.
force

boolean

Esegue effettivamente l'eliminazione. Se force è impostato su false, restituisce il numero di eliminazioni previsto senza eliminare alcun documento.
La sorgente di ingresso desiderata per l'eliminazione dei documenti in base agli ID dei documenti. Di seguito è riportato un elenco di campi che si escludono a vicenda. Al massimo uno dei campi verrà impostato in una risposta:
gcsSource

object (GcsSource)

Località Cloud Storage per i contenuti di input. dataSchema supportato: * documentId: un Document.id valido per riga.
inlineSource

object (InlineSource)

Origine in linea per i contenuti di input per l'eliminazione.
Fine dei campi che si escludono a vicenda.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.documents.purge

Per saperne di più, consulta la documentazione di IAM.