Method: corpora.query

Corpus에 대해 시맨틱 검색을 수행합니다.

HTTP 요청

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

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

경로 매개변수

매개변수
name

string

필수 항목입니다. 쿼리할 Corpus의 이름입니다. 예: corpora/my-corpus-123

요청 본문

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

JSON 표현
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
필드
query

string

필수 항목입니다. 시맨틱 검색을 수행할 쿼리 문자열입니다.

metadataFilters[]

object (MetadataFilter)

선택사항입니다. ChunkDocument 메타데이터를 필터링합니다. 각 MetadataFilter 객체는 고유 키에 대응해야 합니다. 여러 MetadataFilter 객체가 논리적 'AND'로 결합됩니다.

문서 수준 검색어의 예: (2020년 >= 또는 2010년 <) AND (장르 = 드라마 OR 장르 = 액션)

MetadataFilter object list: metadataFilters " [{key = "document.custom_metadata.year"condition = [{int_value = 2020, action = GREATER_EQUAL}, {int_value = 2010, job = LESS}]}, {key = "document. courses = <ph type="x-smartling-placeholder">{1}</ph> = <ph type="x-smartling-placeholder">{1}</ph> <ph type="x-smartling-placeholder">{1/}</ph> 객체 목록: metadata = '

숫자 값 범위에 대한 단위 수준의 쿼리 예: (연도 > 2015 AND 연도 <= 2020)

MetadataFilter 객체 목록: metadataFilters = [ {key = "chunk.custom_metadata.year" terms = [{int_value = 2015, Operations = GREATER}]}, {key = "chunk.custom_metadata.year" terms = [{int_value = 2020, job = LESS_EQUAL}]}]

참고: 동일한 키에 대한 'AND'는 숫자 값에만 지원됩니다. 문자열 값은 동일한 키에 'OR'만 지원합니다.

resultsCount

integer

선택사항입니다. 반환할 최대 Chunk 수입니다. 서비스에서 더 적은 Chunk를 반환할 수도 있습니다.

지정하지 않으면 최대 10개의 Chunk가 반환됩니다. 지정된 최대 결과 수는 100개입니다.

응답 본문

관련 청크 목록이 포함된 corpora.query의 응답입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
필드
relevantChunks[]

object (RelevantChunk)

관련 청크

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

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