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

선택사항입니다. 표준 목록 페이지 크기입니다. 기본값은 100입니다. 최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 변환됩니다.
pageToken

string

선택사항입니다. 표준 목록 페이지 토큰입니다. 일반적으로 이전 DataObjectSearchService.QueryDataObjects 호출의 QueryDataObjectsResponse.next_page_token을 통해 가져옵니다.

응답 본문

DataObjectSearchService.QueryDataObjects의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
필드
dataObjects[]

object (DataObject)

출력 전용입니다. 쿼리와 일치하는 dataObject 목록입니다.
nextPageToken

string

출력 전용입니다. 결과의 다음 페이지를 검색하는 토큰입니다. 해당 페이지를 가져오려면 [DataObjectSearchService.QueryDataObjectsRequest.page_token][] 에 전달하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • vectorsearch.dataObjects.query

자세한 내용은 IAM 문서를 참조하세요.