Method: projects.locations.collections.dataObjects.query

Queries data objects.

HTTP request

POST https://vectorsearch.googleapis.com/v1/{parent}/dataObjects:query

Path parameters

Parameters
parent

string

Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Fields
filter

object (Struct format)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
outputFields

object (OutputFields)

Optional. Mask specifying which fields to return.
pageSize

integer

Optional. The standard list page size.
pageToken

string

Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.

Response body

Response message for DataObjectSearchService.QueryDataObjects.

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

JSON representation 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Fields
dataObjects[]

object (DataObject)

The list of dataObjects that match the query.
nextPageToken

string

A token to retrieve next page of results. Pass to [DataObjectSearchService.QueryDataObjectsRequest.page_token][] to obtain that page.

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:

  • vectorsearch.dataObjects.query

For more information, see the IAM documentation.