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

אפשרות. אם המדיניות מוגדרת כ-True, כל פריטי ה-Chunk והאובייקטים הקשורים ל-Document הזה יימחקו גם הם.

אם False (ברירת המחדל), תוחזר שגיאת FAILED_PRECONDITION אם Document מכיל Chunk כלשהו.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, קראו את הסקירה הכללית על אימות.