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

Elimina definitivamente tutti i Document selezionati in un ramo.

Questa procedura è asincrona. 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,

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  },
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
Campi
filter

string

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

object (PurgeErrorConfig)

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

boolean

Esegue effettivamente l'eliminazione. Se force è impostato su false, restituisci il numero di eliminazioni previsto senza eliminare alcun documento.
Campo unione source. L'origine di input desiderata per l'eliminazione dei documenti in base agli ID documento. source può essere solo uno dei seguenti:
gcsSource

object (GcsSource)

Il percorso 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 da eliminare.

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

Per ulteriori informazioni, consulta 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.