Searches Features matching a query in a given project.
HTTP request
GET https://{service-endpoint}/v1beta1/{location}/featurestores:searchFeatures
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
location |
Required. The resource name of the Location to search Features. Format: |
Query parameters
Parameters | |
---|---|
query |
Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using 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:
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:
Examples:
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.
Examples:
|
pageSize |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
Request body
The request body must be empty.
Response body
Response message for FeaturestoreService.SearchFeatures
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"features": [
{
object ( |
Fields | |
---|---|
features[] |
The Features matching the request. Fields returned:
|
nextPageToken |
A token, which can be sent as |
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.