Method: projects.locations.collections.dataObjects.search

Searches data objects.

HTTP request

POST https://vectorsearch.googleapis.com/v1beta/{parent}/dataObjects:search

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field search_type can be only one of the following:
  "vectorSearch": {
    object (VectorSearch)
  },
  "semanticSearch": {
    object (SemanticSearch)
  },
  "textSearch": {
    object (TextSearch)
  }
  // End of list of possible types for union field search_type.
}
Fields
pageSize

integer

Optional. The standard list page size.
pageToken

string

Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.
Union field search_type. The query to search for. search_type can be only one of the following:

Response body

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

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.search

For more information, see the IAM documentation.