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

Exclui permanentemente todos os Documents selecionados em uma ramificação.

Esse processo é assíncrono. Dependendo do número de Documents a serem excluídos, essa operação pode levar horas para ser concluída. Antes que a operação de exclusão seja concluída, alguns Documents ainda podem ser retornados por DocumentService.GetDocument ou DocumentService.ListDocuments.

Para receber uma lista dos Documents a serem excluídos, defina PurgeDocumentsRequest.force como "false".

Solicitação HTTP


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

Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

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

Obrigatório. Filtre os documentos correspondentes para serem excluídos. No momento, o único valor compatível é * (todos os itens).
errorConfig

object (PurgeErrorConfig)

O local desejado dos erros ocorridos durante a limpeza.
force

boolean

Realiza a exclusão permanente. Se force estiver definido como "false", retorne a contagem de limpeza esperada sem excluir documentos.
A origem de entrada desejada para a exclusão de documentos com base nos IDs. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
gcsSource

object (GcsSource)

Local do Cloud Storage para o conteúdo de entrada. dataSchema aceitos: * documentId: um Document.id válido por linha.
inlineSource

object (InlineSource)

Fonte inline do conteúdo de entrada para remoção.
Fim dos campos mutuamente exclusivos.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.documents.purge

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