Method: projects.locations.collections.dataObjects.query

שליחת שאילתות לאובייקטים של נתונים.

בקשת HTTP

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

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של האוסף שעליו רוצים להריץ שאילתה. פורמט: projects/{project}/locations/{location}/collections/{collection}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
שדות
filter

object (Struct format)

זה שינוי אופציונלי. ביטוי מסנן ב-JSON, לדוגמה: {‎"genre": {‎"$eq": "sci-fi"‎}}‎, שמוצג כ-google.protobuf.Struct.
outputFields

object (OutputFields)

זה שינוי אופציונלי. מסכה שמציינת אילו שדות להחזיר.
pageSize

integer

זה שינוי אופציונלי. גודל הדף הרגיל ברשימה.
pageToken

string

זה שינוי אופציונלי. טוקן הדף הרגיל של הרשימה. בדרך כלל מתקבל באמצעות QueryDataObjectsResponse.next_page_token של הקריאה הקודמת של DataObjectSearchService.QueryDataObjects.

גוף התשובה

הודעת תגובה לDataObjectSearchService.QueryDataObjects.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
שדות
dataObjects[]

object (DataObject)

רשימת אובייקטי הנתונים שתואמים לשאילתה.
nextPageToken

string

טוקן לאחזור של דף התוצאות הבא. מעבירים ל-‎[DataObjectSearchService.QueryDataObjectsRequest.page_token][] ‎ כדי לקבל את הדף הזה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • vectorsearch.dataObjects.query

מידע נוסף מופיע במאמרי העזרה בנושא IAM.