Method: projects.locations.featurestores.searchFeatures

Searches Features matching a query in a given project.

HTTP request

GET https://{service-endpoint}/v1/{location}/featurestores:searchFeatures

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
location

string

Required. The resource name of the Location to search Features. Format: projects/{project}/locations/{location}

Query parameters

Parameters
query

string

Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using AND to form a conjunction.

A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by:

  • Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric [a-zA-Z0-9], underscore _, or asterisk * are treated as delimiters for tokens. * is treated as a wildcard that matches characters within a token.
  • Ignoring case.
  • Prepending an asterisk to the first and appending an asterisk to the last token in QUERY.

A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively.

Supported FIELDs for field-restricted queries:

  • featureId
  • description
  • entityTypeId

Examples:

  • featureId: foo --> Matches a Feature with ID containing the substring foo (eg. foo, foofeature, barfoo).
  • featureId: foo*feature --> Matches a Feature with ID containing the substring foo*feature (eg. foobarfeature).
  • featureId: foo AND description: bar --> Matches a Feature with ID containing the substring foo and description containing the substring bar.

Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive.

  • featureId: Supports = comparisons.
  • description: Supports = comparisons. Multi-token filters should be enclosed in quotes.
  • entityTypeId: Supports = comparisons.
  • valueType: Supports = and != comparisons.
  • labels: Supports key-value equality as well as key presence.
  • featurestoreId: Supports = comparisons.

Examples: * description = "foo bar" --> Any Feature with description exactly equal to foo bar * valueType = DOUBLE --> Features whose type is DOUBLE. * labels.active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels. * labels.env: * --> Any Feature which has a label with env as the key.

pageSize

integer

The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

pageToken

string

A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except pageSize, must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for FeaturestoreService.SearchFeatures.

JSON representation
{
  "features": [
    {
      object (Feature)
    }
  ],
  "nextPageToken": string
}
Fields
features[]

object (Feature)

The Features matching the request.

Fields returned:

  • name
  • description
  • labels
  • createTime
  • updateTime
nextPageToken

string

A token, which can be sent as SearchFeaturesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

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 location resource:

  • aiplatform.features.list

For more information, see the IAM documentation.