Method: projects.locations.indexEndpoints.searchIndexEndpoint

배포된 색인 엔드포인트를 검색합니다 (이미지 코퍼스 유형만 해당).

HTTP 요청

POST https://visionai.googleapis.com/v1/{indexEndpoint=projects/*/locations/*/indexEndpoints/*}:searchIndexEndpoint

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
indexEndpoint

string

필수 입력란입니다. 검색할 색인 엔드포인트입니다. 형식: `projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}'

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "criteria": [
    {
      object (Criteria)
    }
  ],
  "exclusionCriteria": [
    {
      object (Criteria)
    }
  ],
  "pageSize": integer,
  "pageToken": string,

  // Union field query can be only one of the following:
  "imageQuery": {
    object (ImageQuery)
  },
  "textQuery": string
  // End of list of possible types for union field query.
}
필드
criteria[]

object (Criteria)

검색 결과에 적용되는 기준입니다.
exclusionCriteria[]

object (Criteria)

검색 결과에서 제외할 기준입니다. fetchMatchedAnnotations은 무시됩니다.
pageSize

integer

요청한 페이지 크기입니다. API에서 요청한 것보다 적은 결과를 반환할 수 있습니다. 음수인 경우 INVALID_ARGUMENT 오류가 반환됩니다. 지정하지 않거나 0인 경우 API는 기본 크기인 10을 선택합니다. 요청된 페이지 크기가 최대 크기보다 크면 API는 최대 크기인 100을 선택합니다.
pageToken

string

다음 페이지를 가져오는 연속 토큰입니다. 비어 있으면 첫 번째 페이지를 가져오는 중임을 의미합니다.
통합 필드 query. oneof 전 세계 검색어입니다. query은 다음 중 하나여야 합니다.
imageQuery

object (ImageQuery)

이미지 전용 검색어입니다.
textQuery

string

텍스트 전용 쿼리입니다.

응답 본문

indexEndpoints.searchIndexEndpoint의 응답 메시지입니다.

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

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

object (SearchResultItem)

반환된 검색 결과입니다.
nextPageToken

string

다음 페이지 연속 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

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

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

자세한 내용은 인증 개요를 참조하세요.

IAM 권한

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

  • visionai.indexEndpoints.search

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

ImageQuery

검색 엔드포인트 요청의 이미지 쿼리입니다.

JSON 표현 
{

  // Union field image can be only one of the following:
  "inputImage": string,
  "asset": string
  // End of list of possible types for union field image.
}
필드

통합 필드 image.

image는 다음 중 하나여야 합니다.
inputImage

string (bytes format)

원시 바이트의 입력 이미지입니다.

base64 인코딩 문자열입니다.
asset

string

저작물의 리소스 이름입니다. IMAGE 자료 유형에서만 지원됩니다. 형식: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}