Method: corpora.delete

Deletes a Corpus.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the Corpus. Example: corpora/my-corpus-123

Query parameters

Parameters
force

boolean

Optional. If set to true, any Documents and objects related to this Corpus will also be deleted.

If false (the default), a FAILED_PRECONDITION error will be returned if Corpus contains any Documents.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.