Method: projects.locations.collections.dataObjects.query

Fragt Datenobjekte ab.

HTTP-Anfrage

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

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname der Sammlung, für die die Abfrage ausgeführt werden soll. Format: projects/{project}/locations/{location}/collections/{collection}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Felder
filter

object (Struct format)

Optional. Ein JSON-Filterausdruck, z.B. {"genre": {"$eq": "sci-fi"}}, dargestellt als google.protobuf.Struct.
outputFields

object (OutputFields)

Optional. Maske, die angibt, welche Felder zurückgegeben werden sollen.
pageSize

integer

Optional. Die Standardgröße der Listenseite
pageToken

string

Optional. Das Standardtoken der Listenseite Wird normalerweise über QueryDataObjectsResponse.next_page_token des vorherigen DataObjectSearchService.QueryDataObjects-Aufrufs abgerufen.

Antworttext

Antwortnachricht für DataObjectSearchService.QueryDataObjects.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Felder
dataObjects[]

object (DataObject)

Die Liste der „dataObjects“, die der Abfrage entsprechen.
nextPageToken

string

Ein Token zum Abrufen der nächsten Ergebnisseite. Übergeben Sie den Wert an [DataObjectSearchService.QueryDataObjectsRequest.page_token][], um die entsprechende Seite abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • vectorsearch.dataObjects.query

Weitere Informationen finden Sie in der IAM-Dokumentation.