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

Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
siteSearchEngine

string

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "documentDataMap": {
    string: {
      object
    },
    ...
  },
  "emptyDocumentDataMap": boolean,
  "schema": {
    object
  }
}
Fields
documentDataMap

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

Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: 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

If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.
schema

object (Struct format)

Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.