Method: projects.locations.collections.dataObjects.batchSearch

데이터 객체를 일괄 검색합니다.

HTTP 요청

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. 검색할 컬렉션의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}

요청 본문

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

JSON 표현 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
필드
searches[]

object (Search)

필수 항목입니다. 병렬로 실행할 검색 요청 목록입니다.
combine

object (CombineResultsOptions)

선택사항입니다. 일괄 검색 작업의 결과를 결합하는 옵션입니다.

응답 본문

일괄 검색 작업의 응답입니다.

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

JSON 표현 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
필드
results[]

object (SearchDataObjectsResponse)

출력 전용입니다. 검색 응답 목록으로, 배치에 있는 각 요청당 하나씩 있습니다. 랭커를 사용하는 경우 순위가 지정된 단일 결과 목록이 반환됩니다.

승인 범위

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

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

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

IAM 권한

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

  • vectorsearch.dataObjects.search

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

CombineResultsOptions

일괄 검색 작업의 결과를 결합하는 옵션입니다.

JSON 표현 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
필드
ranker

object (Ranker)

필수 항목입니다. 결과를 결합하는 데 사용할 순위 지정기입니다.
outputFields

object (OutputFields)

선택사항입니다. 반환할 필드를 지정하는 마스크입니다.
topK

integer

선택사항입니다. 반환할 결과 수입니다. 설정하지 않으면 기본값이 사용됩니다.

순위 지정 도구

여러 검색의 결과를 결합하는 순위 지정자를 정의합니다.

JSON 표현 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  },
  "vertex": {
    object (VertexRanker)
  }
  // End of list of possible types for union field ranker.
}
필드
통합 필드 ranker. 사용할 순위 지정 방법입니다. ranker은 다음 중 하나여야 합니다.
rrf

object (ReciprocalRankFusion)

상호 순위 융합 순위입니다.
vertex

object (VertexRanker)

Vertex AI 순위

ReciprocalRankFusion

결과 순위 지정을 위한 상호 순위 융합 (RRF) 알고리즘을 정의합니다.

JSON 표현 
{
  "weights": [
    number
  ]
}
필드
weights[]

number

필수 항목입니다. 융합 중에 각 검색 결과 세트에 적용할 가중치입니다.

VertexRanker

Vertex AI 순위 서비스를 사용하여 랭커를 정의합니다. 자세한 내용은 https://cloud.google.com/generative-ai-app-builder/docs/ranking을 참고하세요.

JSON 표현 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string,
  "model": string
}
필드
query

string

필수 항목입니다. 레코드의 순위 및 점수가 매겨지는 쿼리입니다.
titleTemplate

string

선택사항입니다. 레코드의 제목을 생성하는 데 사용되는 템플릿입니다.
contentTemplate

string

선택사항입니다. 레코드의 콘텐츠를 생성하는 데 사용된 템플릿입니다.
model

string

필수 항목입니다. 문서 순위 지정에 사용된 모델입니다. 모델이 지정되지 않으면 semantic-ranker-default@latest가 사용됩니다.