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

為進階站內搜尋資料儲存庫設定文件資料對應的 URI 模式。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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

詳情請參閱Authentication Overview