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

Exclui permanentemente todos os Documents selecionados em um branch.

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 da conclusão da operação de exclusão, 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/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge

O URL usa 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. Filtra documentos correspondentes para limpeza. O único valor compatível no momento é * (todos os itens).
errorConfig

object (PurgeErrorConfig)

O local desejado dos erros ocorridos durante a limpeza.
force

boolean

Executa a limpeza. Se force estiver definido como "false", retorne a contagem de limpeza esperada sem excluir nenhum documento.
A origem de entrada desejada para os documentos de limpeza com base nos IDs de documentos. A seguir, há 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 compatível: * documentId: um Document.id válido por linha.
inlineSource

object (InlineSource)

Origem inline para o conteúdo de entrada para limpeza.
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.