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