Method: projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData

מגדיר את תבנית ה-URI למיפוי נתוני מסמכים עבור מאגר נתונים של חיפוש מתקדם באתר.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:setUriPatternDocumentData

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

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

פרמטרים
siteSearchEngine

string

חובה. שם המשאב המלא של SiteSearchEngine, למשל projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "documentDataMap": {
    string: {
      object
    },
    ...
  },
  "emptyDocumentDataMap": boolean,
  "schema": {
    object
  }
}
שדות
documentDataMap

map (key: string, value: object (Struct format))

נתוני מסמכים שמקבלים מפתח לפי תבנית URI. כל רשומה חייבת להיות זהה לערך Schema. לדוגמה: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } }

documentDataMap = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
emptyDocumentDataMap

boolean

אם הערך הוא True, המיפוי של נתוני המסמך מתבטל. אם הערך הוא true, השדה SetUriPatternDocumentDataRequest.document_data_map חייב להיות ריק.
schema

object (Struct format)

זה שינוי אופציונלי. אם לא מציינים ערך, המערכת משתמשת בערך הנוכחי של Schema. אם מצוין, מאמת ומעדכן את Schema. אם האימות נכשל, מוחזרת שגיאה.

גוף התשובה

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.