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

高度なサイト内検索 DataStore の 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

詳細については、Authentication Overview をご覧ください。