Method: corpora.documents.delete

Document を削除します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。削除する Document のリソース名。例: corpora/my-corpus-123/documents/the-doc-abc

クエリ パラメータ

パラメータ
force

boolean

（省略可）true に設定すると、この Document に関連する Chunk とオブジェクトも削除されます。

false（デフォルト）の場合、Document に Chunk が含まれていると FAILED_PRECONDITION エラーが返されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。