Method: projects.locations.corpora.searchConfigs.patch

Updates a search configuration inside a corpus.

Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules --- 1. Request.search_configuration.name must already exist. 2. Request must contain at least one non-empty searchCriteriaProperty or facetProperty. 3. mappedFields must not be empty, and must map to existing UGA keys. 4. All mappedFields must be of the same type. 5. All mappedFields must share the same granularity. 6. All mappedFields must share the same semantic SearchConfig match options. For property-specific rules, please reference the comments for FacetProperty and SearchCriteriaProperty.

HTTP request

PATCH https://visionai.googleapis.com/v1/{searchConfig.name=projects/*/locations/*/corpora/*/searchConfigs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
searchConfig.name

string

Resource name of the search configuration. For CustomSearchCriteria, searchConfig would be the search operator name. For Facets, searchConfig would be the facet dimension name. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{searchConfig}

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated. If left unset, all field paths will be updated/overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of SearchConfig.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.searchConfigs.update

For more information, see the IAM documentation.