Method: corpora.documents.delete

حذف Document

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
name

string

مطلوبة. اسم المورد لـ Document المطلوب حذفه. مثال: corpora/my-corpus-123/documents/the-doc-abc

معلمات طلب البحث

المَعلمات
force

boolean

اختياريّ. في حال ضبطها على "صحيح"، سيتم أيضًا حذف أي Chunk أو عناصر مرتبطة بهذا Document.

وإذا كان الخيار "خطأ" (الإعداد التلقائي)، سيتم عرض خطأ "FAILED_PRECONDITION" إذا كان العمود "Document" يحتوي على أي أخطاء "Chunk".

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

في حال نجاح هذا الإجراء، يكون نص الاستجابة فارغًا.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، راجع نظرة عامة على المصادقة.