Method: corpora.documents.delete

Borra un Document.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. El nombre del recurso de Document que se borrará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc

Parámetros de consulta

Parámetros
force

boolean

Opcional. Si se configura como verdadera, también se borrarán todos los Chunk y objetos relacionados con esta Document.

Si es falso (el valor predeterminado), se mostrará un error FAILED_PRECONDITION si Document contiene algún Chunk.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.