Method: projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore using a POST HTTP request."],["The required path parameter `siteSearchEngine` specifies the full resource name of the SiteSearchEngine to be modified."],["The request body allows for setting a `documentDataMap`, which is structured with URI patterns as keys and document data as values, consistent with the specified schema."],["The request body includes an option to set the boolean `emptyDocumentDataMap` to true, to clear the existing document data map, which implies that `document_data_map` must be empty."],["The request body allows for an optional schema to be defined, and if it is defined it will update and validate the schema, but if not, the current existing schema is used."]]],[]]
