Method: projects.locations.corpora.searchConfigs.create

Creates a search configuration inside a corpus.

Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules --- 1. Request.search_config_id must not be associated with an existing SearchConfig. 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

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/corpora/*}/searchConfigs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource where this search configuration will be created. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}

Query parameters

Parameters
searchConfigId

string

Required. ID to use for the new search config. Will become the final component of the SearchConfig's resource name. This value should be up to 63 characters, and valid characters are /[a-z][0-9]-_/. The first character must be a letter, the last could be a letter or a number.

Request body

The request body contains an instance of SearchConfig.

Response body

If successful, the response body contains a newly created 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 parent resource:

  • visionai.searchConfigs.create

For more information, see the IAM documentation.