SearchResponse

SearchService.Search 메서드의 응답 메시지입니다.

JSON 표현 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
필드
results[]

object (SearchResult)

일치하는 문서 목록입니다. 순서는 순위를 나타냅니다.
facets[]

object (Facet)

사용자가 요청한 패싯의 결과입니다.
totalSize

integer

페이지로 나누기와 관계없이 일치하는 항목의 예상 총 개수입니다. 페이지로 나누기를 통해 반환된 results 수가 일치하는 totalSize보다 적을 수 있습니다.
attributionToken

string

고유한 검색 토큰입니다. 이 토큰은 검색으로 인해 발생한 UserEvent 로그에 포함되어야 하며, 이를 통해 검색 모델 성능을 정확하게 기여 분석할 수 있습니다. 또한 고객 지원 시나리오에서 요청을 식별하는 데도 도움이 됩니다.
redirectUri

string

고객 정의 리디렉션 페이지의 URI입니다. 리디렉션 작업이 트리거되면 검색이 실행되지 않으며 응답에 redirectUri 및 attributionToken만 설정됩니다.
nextPageToken

string

다음 페이지를 검색하기 위해 SearchRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.
correctedQuery

string

맞춤법이 수정된 질문을 포함합니다(있는 경우). 맞춤법 수정 유형이 AUTOMATIC인 경우 검색 결과는 correctedQuery를 기반으로 합니다. 그렇지 않으면 검색에 원래 쿼리가 사용됩니다.
summary

object (Summary)

검색 결과의 일부로 표시되는 요약 이 필드는 SearchRequest.ContentSearchSpec.summary_spec이 설정된 경우에만 반환됩니다.
queryExpansionInfo

object (QueryExpansionInfo)

반환된 결과의 검색어 확장 정보입니다.
sessionInfo

object (SessionInfo)

세션 정보입니다.

SearchRequest.session이 제공된 경우에만 설정됩니다. 자세한 내용은 설명을 참고하세요.

패싯

패싯 결과입니다.

JSON 표현 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
필드
key

string

이 패싯의 키입니다. 예를 들면 "colors" 또는 "price"입니다. SearchRequest.FacetSpec.FacetKey.key와 일치합니다.
values[]

object (FacetValue)

이 필드의 패싯 값입니다.
dynamicFacet

boolean

패싯이 동적으로 생성되는지 여부입니다.

FacetValue

값 이름과 개수가 포함된 패싯 값입니다.

JSON 표현 
{
  "count": string,

  // Union field facet_value can be only one of the following:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of list of possible types for union field facet_value.
}
필드
count

string (int64 format)

이 패싯 값이 있는 항목의 수입니다.
통합 필드 facet_value. 값이 포함된 패싯 값입니다. facet_value은 다음 중 하나여야 합니다.
value

string

패싯의 텍스트 값입니다(예: 'colors' 패싯의 'Black').
interval

object (Interval)

패싯의 간격 값입니다(예: '가격' 패싯의 경우 [10, 20)). SearchRequest.FacetSpec.FacetKey.intervals와 일치합니다.

QueryExpansionInfo

확장이 발생했는지 여부를 비롯한 검색어 확장을 설명하는 정보입니다.

JSON 표현 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
필드
expandedQuery

boolean

쿼리 확장이 발생했는지 여부를 나타내는 부울입니다.
pinnedResultCount

string (int64 format)

고정된 결과 수입니다. 이 필드는 확장되고 SearchRequest.QueryExpansionSpec.pin_unexpanded_results이 true로 설정된 경우에만 설정됩니다.

SessionInfo

세션에 관한 정보입니다.

JSON 표현 
{
  "name": string,
  "queryId": string
}
필드
name

string

세션 이름입니다. 자동 세션 모드를 사용하는 경우 (SearchRequest.session가 '-'로 끝나는 경우) 이 필드에는 새로 생성된 세션 이름이 저장됩니다.
queryId

string

이 검색 API 호출에 해당하는 쿼리 ID입니다. 하나의 세션에 여러 턴이 있을 수 있으며 각 턴에는 고유한 쿼리 ID가 있습니다.

Answer API 호출에서 세션 이름과 이 쿼리 ID를 지정하면 이 검색 호출의 검색 결과 컨텍스트에서 답변이 생성됩니다.