정형 데이터 스토어에서 결과 정렬

이 페이지에서는 정형 데이터 스토어 및 메타데이터가 있는 비정형 데이터 스토어에서 실행한 검색어의 결과를 정렬하는 방법을 설명합니다.

결과 정렬에 지원되는 데이터 유형

다음은 검색 결과를 정렬할 수 있는 필드 유형입니다.

string
number
datetime
geolocation

시작하기 전에

정형 데이터 또는 메타데이터가 포함된 비정형 데이터가 포함된 데이터 스토어가 있는 앱이 있는지 확인합니다.

검색 결과 정렬

정형 데이터 스토어 또는 메타데이터가 있는 비정형 데이터 스토어의 검색 결과를 정렬하려면 다음 단계를 따르세요.

REST

API를 사용하여 정형 데이터가 있는 앱 또는 메타데이터가 있는 비정형 데이터의 검색 결과를 정렬하려면 engines.servingConfigs.search 메서드를 사용합니다.

참고: engines.servingConfigs.search 메서드를 사용하여 앱을 검색하고 dataStores.servingConfigs.search 메서드를 사용하여 데이터 스토어를 검색할 수 있습니다. 다음 절차에서는 engines.servingConfigs.search 메서드를 사용하여 검색하는 것이 좋습니다.

앱 ID를 찾습니다. 앱 ID를 이미 알고 있는 경우 다음 단계로 건너뜁니다.
1. Google Cloud 콘솔에서 Agent Builder 페이지로 이동합니다.
  
  앱으로 이동
2. 앱 페이지에서 앱 이름을 찾고 ID 열에서 앱 ID를 가져옵니다.

검색어를 만들고 orderBy 필드를 포함합니다.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"query": "QUERY",
"orderBy": "ORDER_BY"
}'

다음을 바꿉니다.

PROJECT_ID: Google Cloud 프로젝트의 ID입니다.
APP_ID: Vertex AI Search 앱의 ID입니다.
QUERY: 검색할 쿼리 텍스트입니다.
ORDER_BY: 결과가 정렬되는 순서입니다. 기본 정렬 순서는 오름차순입니다. 예를 들어 date를 지정하면 가장 오래된 결과부터 가장 최근 결과 순으로 반환됩니다. 내림차순 정렬 순서로 가져오려면 date 값에 desc를 추가합니다(예: date desc). 더 많은 예시는 orderBy 예시를 참조하세요.

명령어 및 결과 예시

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search:search" \
-d '{
    "query": "hotel",
    "orderBy": "rating desc"
   }'
    
{
"results": [
{
  "id": "10d480b19c256bb1",
  "document": {
    "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10d480b19c256bb1",
    "id": "10d480b19c256bb1",
    "structData": {
      "available_date": "2023-11-05",
      "amenities": [
        "Lake Views",
        "Private Beach",
        "Spa",
        "Water Activities"
      ],
      "room_types": [
        "Lakefront Suite",
        "Deluxe Room",
        "Cottage"
      ],
      "location": {
        "address": "988 Serenity Circle, Tranquil Town, NV 89501, USA"
      },
      "rating": 4.6,
      "id": 11,
      "price_per_night": 220.5,
      "title": "Serenity Springs Hotel"
    }
  }
},
{
  "id": "9ffae8af37cc8b63",
  "document": {
    "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/9ffae8af37cc8b63",
    "id": "9ffae8af37cc8b63",
    "structData": {
      "title": "Riverfront Plaza Hotel",
      "rating": 4.2,
      "location": {
        "address": "101 Main St, Anytown, CA 94501, USA"
      },
      "price_per_night": 145.8,
      "amenities": [
        "Fitness Center",
        "Conference Rooms",
        "Restaurant",
        "Valet Parking"
      ],
      "id": 3,
      "room_types": [
        "Executive Suite",
        "King Room",
        "Double Queen"
      ],
      "available_date": "2023-11-15"
    }
  }
},
{
  "id": "3be9e854d8f3a47f",
  "document": {
    "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/3be9e854d8f3a47f",
    "id": "3be9e854d8f3a47f",
    "structData": {
      "amenities": [
        "Oceanfront Views",
        "Pool",
        "Spa",
        "Beachside Dining"
      ],
      "available_date": "2023-09-18",
      "location": {
        "address": "449 Oceanfront Drive, Seaside Resort, CA 92007, USA"
      },
      "id": 13,
      "title": "Ocean Breeze Hotel",
      "room_types": [
        "Ocean View Suite",
        "Deluxe Room",
        "Family Suite"
      ],
      "rating": 4.1,
      "price_per_night": 180
    }
  }
}
],
"totalSize": 3,
"attributionToken": "wAHwvwoMCNDYz7UGEMCklrsCEiQ2NmIzYmU5My0wMDAwLTIxMDUtYmUyNy01ODI0MjljMzdlZTQiB0dFTkVSSUMqgAHd1akt3e2ILebtiC2CspoigLKaIpjeqC-q-LMtjr6dFeqCsS2W3qgvwvCeFaz4sy2jgJcinta3LeiCsS3b7Ygt5O2ILa3Eii3Usp0Vpp-VLZzWty359rMt-_azLaCJsy3dj5oixcvzF6vEii2iibMttreMLd_VqS3bj5oipJ-VLQ",
"guidedSearchResult": {},
"summary": {}
}

이 예시에서는 '호텔'이라는 단어가 포함된 문서가 평점이 4.6인 Serenity Springs Hotel부터 평점이 4.1인 Ocean Breeze Hotel까지 평점순으로 정렬되어 있습니다.

`orderBy` 예시

title이라는 문자열 필드에서 정렬하는 방식:

"orderBy": "title": 제목을 기준으로 알파벳순으로 문서를 반환합니다.
"orderBy": "title desc": 제목을 기준으로 알파벳 역순(Z~A)으로 정렬된 문서를 반환합니다.

rating이라는 숫자 필드에서 정렬하는 방식:

"orderBy": "rating": 평점이 가장 낮은 문서부터 가장 높은 문서 순으로 정렬합니다.
"orderBy": "rating desc": 평점이 가장 높은 문서부터 가장 낮은 문서 순으로 정렬합니다.

available_date라는 날짜/시간 필드에서 정렬하는 방식:

"orderBy": "available_date": 가장 빨리 사용할 수 있는 문서부터 가장 늦게 사용할 수 있는 문서 순으로 정렬합니다.
"orderBy": "available_date desc": 사용 가능한 날짜가 가장 늦은 문서부터 가장 빠른 문서 순으로 정렬합니다.

location이라는 필드에서 위치정보에 따라 정렬하는 방식:

"orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")": 마운틴뷰에서 가장 가까운 순서부터 가장 먼 순서로 문서를 정렬합니다.
"orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc": 37.38°N, 122.08°W 위치에서 가장 먼 순서부터 가장 가까운 순서로 문서를 정렬합니다.

정형 데이터 스토어에서 결과 정렬

결과 정렬에 지원되는 데이터 유형

시작하기 전에

검색 결과 정렬

REST

명령어 및 결과 예시

orderBy 예시

`orderBy` 예시