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 تنظیم شود، هر Chunk و اشیاء مربوط به این Document نیز حذف خواهد شد.

اگر نادرست (پیش‌فرض)، خطای FAILED_PRECONDITION برگردانده می‌شود اگر Document حاوی هر Chunk باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.