Method: corpora.documents.delete

Exclui um Document.

Solicitação HTTP

DELETE https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do Document a ser excluído. Exemplo: corpora/my-corpus-123/documents/the-doc-abc

Parâmetros de consulta

Parâmetros
force

boolean

Opcional. Se definido como verdadeiro, todos os Chunks e objetos relacionados a esse Document também serão excluídos.

Se for "false" (o padrão), um erro FAILED_PRECONDITION será retornado se Document contiver Chunks.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever

Para saber mais, consulte a Visão geral da autenticação.