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

Elimina permanentemente todos los Documents seleccionados de una rama.

Este proceso es asíncrono. En función del número de Documents que se vayan a eliminar, esta operación puede tardar horas en completarse. Antes de que se complete la operación de eliminación, es posible que DocumentService.GetDocument o DocumentService.ListDocuments sigan devolviendo algunos Document.

Para obtener una lista de los Document que se van a eliminar, asigna el valor "false" a PurgeDocumentsRequest.force.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso superior, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación 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.
}
Campos
filter

string

Obligatorio. Filtrar los documentos coincidentes que se van a purgar. El único valor admitido actualmente es * (todos los elementos).
errorConfig

object (PurgeErrorConfig)

La ubicación deseada de los errores producidos durante la purga.
force

boolean

Realiza la purga. Si force tiene el valor "false", devuelve el número de purgas esperado sin eliminar ningún documento.
Campo de unión source. La fuente de entrada deseada para purgar documentos en función de los IDs de los documentos. source solo puede ser una de estas dos opciones:
gcsSource

object (GcsSource)

Ubicación de Cloud Storage del contenido de entrada. dataSchema admitidos: * documentId: un Document.id válido por línea.
inlineSource

object (InlineSource)

Fuente insertada del contenido de entrada que se va a purgar.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de Operation.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.documents.purge

Para obtener más información, consulta la documentación de gestión de identidades y accesos.