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

Löscht alle ausgewählten Documents in einem Zweig endgültig.

Dieser Vorgang ist asynchron. Je nach Anzahl der zu löschenden Documents kann dieser Vorgang Stunden dauern. Bevor der Löschvorgang abgeschlossen ist, werden möglicherweise noch einige Documents von DocumentService.GetDocument oder DocumentService.ListDocuments zurückgegeben.

Wenn Sie eine Liste der zu löschenden Document abrufen möchten, setzen Sie PurgeDocumentsRequest.force auf „false“.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
filter

string

Erforderlich. Filtern Sie übereinstimmende Dokumente, die gelöscht werden sollen. Derzeit wird nur der Wert * (alle Artikel) unterstützt.
errorConfig

object (PurgeErrorConfig)

Der gewünschte Speicherort für Fehler, die während des Bereinigens aufgetreten sind.
force

boolean

Führt den Löschvorgang tatsächlich aus. Wenn force auf „false“ gesetzt ist, wird die erwartete Anzahl an Löschungen zurückgegeben, ohne Dokumente zu löschen.
Union-Feld source. Die gewünschte Eingabequelle für das Löschen von Dokumenten anhand von Dokument-IDs. Für source ist nur einer der folgenden Werte zulässig:
gcsSource

object (GcsSource)

Cloud Storage-Speicherort für die Eingabeinhalte. Unterstützte dataSchema: * documentId: Eine gültige Document.id pro Zeile.
inlineSource

object (InlineSource)

Inline-Quelle für die Eingabeinhalte, die entfernt werden sollen.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.documents.purge

Weitere Informationen finden Sie in der IAM-Dokumentation.