Method: corpora.documents.delete

Supprime un Document.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource du Document à supprimer. Exemple : corpora/my-corpus-123/documents/the-doc-abc

Paramètres de requête

Paramètres
force

boolean

Facultatif. Si cette règle est définie sur "True", tous les Chunk et objets associés à Document seront également supprimés.

Si la valeur est "false" (valeur par défaut), une erreur FAILED_PRECONDITION est renvoyée si Document contient des Chunk.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est vide.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.