Method: projects.locations.collections.dataStores.branches.documents.create

יצירת Document.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם משאב ההורה, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.

פרמטרים של שאילתה

פרמטרים
documentId

string

חובה. המזהה שמשמש ל-Document, שהופך לרכיב הסופי של Document.name.

אם למשתמש שקורא ל-API אין הרשאה ליצור את Document, בלי קשר לשאלה אם הוא קיים או לא, מוחזרת שגיאה PERMISSION_DENIED.

הערך בשדה הזה חייב להיות ייחודי בין כל התגים מסוג Document עם אותו parent. אחרת, מוחזרת שגיאת ALREADY_EXISTS.

השדה הזה צריך להיות בהתאם לתקן RFC-1034, עם מגבלת אורך של 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.

גוף הבקשה

גוף הבקשה מכיל מופע של Document.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Document.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.documents.create

מידע נוסף מופיע במאמרי העזרה בנושא IAM.