SearchSpec

검색 사양입니다.

JSON 표현
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
필드
통합 필드 input. 검색 동작을 제어하는 검색 매개변수입니다. 또는 검색 결과 목록을 제공하여 답변을 생성합니다. input은 다음 중 하나여야 합니다.
searchParams

object (SearchParams)

검색 매개변수입니다.

searchResultList

object (SearchResultList)

검색 결과 목록

SearchParams

검색 매개변수입니다.

JSON 표현
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
필드
maxReturnResults

integer

반환할 검색 결과 수입니다. 기본값은 10입니다.

filter

string

필터 구문은 필터링되는 문서의 하나 이상의 필드에서 조건자를 구성하기 위한 표현식 언어로 구성됩니다. 필터 표현식은 대소문자를 구분합니다. 이는 검색 결과를 필터링하는 데 사용되며 답변 응답에 영향을 줄 수 있습니다.

이 필드를 인식할 수 없으면 INVALID_ARGUMENT가 반환됩니다.

Vertex AI Search의 필터링은 LHS 필터 키를 Vertex AI Search 백엔드에 정의된 키 속성에 매핑하여 실행됩니다. 이 매핑은 고객이 스키마에 정의합니다. 예를 들어 미디어 고객은 스키마에 'name' 필드가 있을 수 있습니다. 이 경우 필터는 다음과 같습니다. filter --> name:'ANY("king kong")'

구문 및 필터 연산자를 비롯한 필터링에 대한 자세한 내용은 필터를 참고하세요.

boostSpec

object (BoostSpec)

검색 결과에서 특정 문서를 부스트하는 부스트 사양으로, 답변 쿼리 응답에 영향을 줄 수 있습니다. 부스팅에 대한 자세한 내용은 부스팅을 참고하세요.

orderBy

string

문서가 반환되는 순서입니다. 문서는 Document 객체의 필드별로 정렬할 수 있습니다. 관련성별로 정렬하는 경우 설정하지 않은 상태로 둡니다. orderBy 표현식은 대소문자를 구분합니다. 주문에 관한 자세한 내용은 주문을 참고하세요.

이 필드를 인식할 수 없으면 INVALID_ARGUMENT가 반환됩니다.

searchResultMode

enum (SearchResultMode)

검색 결과 모드를 지정합니다. 지정하지 않으면 검색 결과 모드는 기본적으로 DOCUMENTS입니다. 문서 파싱 및 청크 처리를 참고하세요.

dataStoreSpecs[]

object (DataStoreSpec)

검색 호출에서 필터링할 데이터 스토어와 해당 데이터 스토어의 구성을 정의하는 사양입니다. 이 기능은 데이터 스토어가 여러 개인 엔진 사용 사례에만 고려됩니다. 엔진 내 단일 데이터 스토어의 경우 최상위 수준의 사양을 사용해야 합니다.

naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

(선택사항) 검색 요청에 자연어 이해 기능을 사용 설정하기 위한 사양입니다.

SearchResultList

검색 결과 목록

JSON 표현
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
필드
searchResults[]

object (SearchResult)

검색 결과

SearchResult

검색 결과입니다.

JSON 표현
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
필드
통합 필드 content. 검색 결과 콘텐츠입니다. content은 다음 중 하나여야 합니다.
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

구조화되지 않은 문서 정보입니다.

chunkInfo

object (ChunkInfo)

청크 정보입니다.

UnstructuredDocumentInfo

구조화되지 않은 문서 정보입니다.

JSON 표현
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
필드
document

string

문서 리소스 이름입니다.

uri

string

문서의 URI입니다.

title

string

특성이 포함될 수 있습니다

documentContexts[]

object (DocumentContext)

문서 컨텍스트 목록입니다. 이 콘텐츠는 답변 생성에 사용됩니다. 문서의 기본 콘텐츠로, 길고 포괄적일 수 있습니다.

extractiveSegments[]

object (ExtractiveSegment)

추출 세그먼트 목록입니다.

extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

지원 중단됨: 이 필드는 지원 중단되었으며 대답 생성에 영향을 미치지 않습니다. documentContexts 및 extractiveSegments 필드를 사용하세요. 추출 답변 목록입니다.

DocumentContext

문서 컨텍스트입니다.

JSON 표현
{
  "pageIdentifier": string,
  "content": string
}
필드
pageIdentifier

string

페이지 식별자입니다.

content

string

답변 생성에 사용할 문서 콘텐츠입니다.

ExtractiveSegment

추출 세그먼트입니다. 가이드 documentContexts가 비어 있는 경우에만 답변 생성에 사용됩니다. 더 짧은 스니펫이어야 합니다.

JSON 표현
{
  "pageIdentifier": string,
  "content": string
}
필드
pageIdentifier

string

페이지 식별자입니다.

content

string

추출 세그먼트 콘텐츠입니다.

ExtractiveAnswer

추출 답변 가이드

JSON 표현
{
  "pageIdentifier": string,
  "content": string
}
필드
pageIdentifier

string

페이지 식별자입니다.

content

string

추출 답변 콘텐츠입니다.

ChunkInfo

청크 정보입니다.

JSON 표현
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
필드
chunk

string

청크 리소스 이름입니다.

content

string

텍스트 콘텐츠를 청크로 나눕니다.

documentMetadata

object (DocumentMetadata)

현재 청크의 문서 메타데이터입니다.

DocumentMetadata

문서 메타데이터에는 현재 청크의 문서 정보가 포함됩니다.

JSON 표현
{
  "uri": string,
  "title": string
}
필드
uri

string

문서의 URI입니다.

title

string

문서 제목입니다.