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

Elimina permanentemente todos os Documents selecionados num ramo.

Este processo é assíncrono. Consoante o número de Documents a eliminar, esta operação pode demorar horas a ser concluída. Antes da conclusão da operação de eliminação, o Document pode continuar a ser devolvido por DocumentService.GetDocument ou DocumentService.ListDocuments.

Para obter uma lista dos Documents a eliminar, defina PurgeDocumentsRequest.force como falso.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação 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

Obrigatório. Filtrar documentos correspondentes para expurgar. O único valor atualmente suportado é * (todos os itens).
errorConfig

object (PurgeErrorConfig)

A localização desejada dos erros incorridos durante a eliminação.
force

boolean

Executa efetivamente a eliminação. Se force estiver definido como falso, devolve a contagem de eliminação esperada sem eliminar documentos.
Campo de união source. A origem de entrada pretendida para a eliminação dos documentos com base nos IDs dos documentos. source só pode ser uma das seguintes opções:
gcsSource

object (GcsSource)

Localização do Cloud Storage para o conteúdo de entrada. Suportado dataSchema: * documentId: um Document.id válido por linha.
inlineSource

object (InlineSource)

Origem inline do conteúdo de entrada para eliminação.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Operation.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.documents.purge

Para mais informações, consulte a documentação do IAM.