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

Supprime définitivement tous les Document sélectionnés dans une branche.

Ce processus est asynchrone. Selon le nombre de Document à supprimer, cette opération peut prendre plusieurs heures. Avant la fin de l'opération de suppression, certains Document peuvent encore être renvoyés par DocumentService.GetDocument ou DocumentService.ListDocuments.

Pour obtenir la liste des Document à supprimer, définissez PurgeDocumentsRequest.force sur "false".

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource parente, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
filter

string

Obligatoire. Filtre correspondant aux documents à supprimer. La seule valeur acceptée actuellement est * (tous les éléments).
errorConfig

object (PurgeErrorConfig)

Emplacement souhaité des erreurs survenues lors de la suppression.
force

boolean

Effectue réellement la suppression. Si force est défini sur "false", renvoie le nombre de suppressions attendu sans supprimer de documents.
Source d'entrée souhaitée pour la suppression des documents en fonction de leurs ID. Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
gcsSource

object (GcsSource)

Emplacement Cloud Storage pour le contenu d'entrée. dataSchema accepté : * documentId : un Document.id valide par ligne.
inlineSource

object (InlineSource)

Source intégrée pour le contenu d'entrée à supprimer.
Fin des champs mutuellement exclusifs.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.documents.purge

Pour en savoir plus, consultez la documentation IAM.