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

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

Este proceso es asíncrono. Según la cantidad de Document 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 aún muestren algunos Document.

Para obtener una lista de los Document que se borrarán, establece PurgeDocumentsRequest.force como falso.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el 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 con la siguiente estructura:

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

string

Obligatorio. Filtra los documentos coincidentes para borrarlos. El único valor admitido actualmente es * (todos los elementos).
errorConfig

object (PurgeErrorConfig)

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

boolean

Realiza la eliminación. Si force se establece como falso, muestra el recuento de eliminación previsto sin borrar ningún documento.
Es la fuente de entrada deseada para los documentos de eliminación según los IDs de los documentos. La siguiente es una lista de campos mutuamente excluyentes. Se establecerá como máximo uno de los campos en una respuesta:
gcsSource

object (GcsSource)

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

object (InlineSource)

Es la fuente intercalada para el contenido de entrada para la eliminación.
Fin de los campos mutuamente excluyentes.

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
  • https://www.googleapis.com/auth/discoveryengine.serving.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.