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

Borra de forma permanente todos los Documents seleccionados en una rama.

Este proceso es asíncrono. Según la cantidad de Documents que se borrarán, 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 Documents que se borrarán, establece PurgeDocumentsRequest.force en falso.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con 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. Filtra los documentos coincidentes que se borrarán definitivamente. Por el momento, el único valor admitido es * (todos los elementos).
errorConfig

object (PurgeErrorConfig)

Es la ubicación deseada de los errores que se produjeron durante la purga.
force

boolean

Realiza la eliminación definitiva. Si force se establece como falso, devuelve el recuento de eliminación definitiva previsto sin borrar ningún documento.
Campo de unión source. Es la fuente de entrada deseada para purgar documentos según los IDs de documentos. source puede ser solo uno de los siguientes:
gcsSource

object (GcsSource)

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

object (InlineSource)

Es la fuente intercalada del contenido de entrada para la eliminación.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita 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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.documents.purge

Para obtener más información, consulta la documentación de IAM.