Halaman ini diterjemahkan oleh Cloud Translation API.

Mendapatkan hasil penelusuran (Lama)

Halaman ini menunjukkan cara mendapatkan hasil penelusuran menggunakan API.

Anda dapat melakukan panggilan API dan mengintegrasikan panggilan tersebut ke server atau aplikasi Anda. Halaman ini menyertakan contoh kode tentang cara membuat kueri penelusuran menggunakan library klien gRPC dengan akun layanan.

Mendapatkan hasil penelusuran

Anda bisa mendapatkan hasil penelusuran menggunakan API.

REST

Untuk menggunakan API guna mendapatkan hasil penelusuran untuk aplikasi dengan data terstruktur atau tidak terstruktur, gunakan metode engines.servingConfigs.search:

Catatan: Anda dapat menelusuri aplikasi menggunakan metode engines.servingConfigs.search dan Anda dapat menelusuri penyimpanan data menggunakan metode dataStores.servingConfigs.search. Untuk prosedur berikut, Google merekomendasikan penelusuran menggunakan metode engines.servingConfigs.search.

Temukan ID aplikasi Anda. Jika Anda sudah memiliki ID aplikasi, lanjutkan ke langkah berikutnya.
1. Di konsol Google Cloud , buka halaman Gemini Enterprise.
  
  Buka Aplikasi
2. Di halaman Aplikasi, temukan nama aplikasi Anda dan dapatkan ID aplikasi dari kolom ID.
Melihat pratinjau hasil penelusuran.

Istilah Penting: Di Gemini Enterprise, istilah aplikasi dapat digunakan secara bergantian dengan istilah mesin dalam konteks API. Mesin Gemini Enterprise adalah mesin telusur generik dengan kolom app_type disetel ke APP_TYPE_INTRANET.
```
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
"query": "QUERY",
"userPseudoId": "USER_PSEUDO_ID",
"pageSize": "PAGE_SIZE",
"offset": "OFFSET",
"orderBy": "ORDER_BY",
"filter": "FILTER",
"boostSpec": "BOOST_SPEC",
"facetSpec": "FACET_SPEC",
"queryExpansionSpec": "QUERY_EXPANSION_SPEC",
"spellCorrectionSpec": "SPELL_CORRECTION_SPEC",
"contentSearchSpec": "CONTENT_SEARCH_SPEC",
"dataStoreSpecs": [{"DATA_STORE_SPEC"}],
}'
```
Ganti kode berikut:
- PROJECT_ID: ID project Anda.
- APP_ID: ID aplikasi yang ingin Anda kueri.
- QUERY: teks kueri yang akan ditelusuri.
- USER_PSEUDO_ID: string yang dienkode UTF-8, yang berfungsi sebagai ID unik yang dipseudonimkan yang melacak pengguna. Panjang maksimumnya adalah 128 karakter. Google sangat merekomendasikan penggunaan kolom ini karena dapat meningkatkan performa model dan kualitas personalisasi. Anda dapat menggunakan cookie HTTP untuk kolom ini, yang mengidentifikasi pengunjung secara unik di satu perangkat. Beberapa pertimbangan penting adalah sebagai berikut:
  - ID ini tidak berubah saat pengunjung login atau logout dari situs.
  - Kolom ini tidak boleh disetel ke ID yang sama untuk beberapa pengguna. Jika tidak, penggunaan ID pengguna yang sama untuk beberapa pengguna dapat menggabungkan histori peristiwa pengguna yang berbeda dan menurunkan kualitas model.
  - Kolom ini tidak boleh menyertakan informasi identitas pribadi (PII).
  - Untuk permintaan penelusuran atau penjelajahan tertentu, kolom ini harus dipetakan ke kolom userPseudoId yang sesuai di peristiwa pengguna.
  Untuk informasi selengkapnya, lihat userPseudoId.
- PAGE_SIZE: jumlah hasil yang ditampilkan oleh penelusuran. Ukuran halaman maksimum yang diizinkan bergantung pada jenis data. Ukuran halaman di atas nilai maksimum akan dikonversi menjadi nilai maksimum.
- OFFSET: optional. Indeks awal hasil. Nilai defaultnya adalah 0.
  
  Misalnya, jika offsetnya adalah 2, ukuran halamannya adalah 10, dan ada 15 hasil yang akan ditampilkan, hasil 2 hingga 11 akan ditampilkan di halaman pertama.
- ORDER_BY: optional. Urutan hasil diatur.
- FILTER: optional. Kolom teks untuk memfilter penelusuran Anda menggunakan ekspresi filter. Nilai defaultnya adalah string kosong, yang berarti tidak ada filter yang diterapkan.
  
  Contoh: color: ANY("red", "blue") AND score: IN(*, 100.0e)
  
  Untuk mengetahui informasi selengkapnya, lihat Memfilter penelusuran untuk data terstruktur atau tidak terstruktur.
- BOOST_SPEC: optional. Spesifikasi untuk menaikkan atau menyembunyikan dokumen. Nilai:
  - BOOST: bilangan floating point dalam rentang [-1,1]. Jika nilainya negatif, hasil akan diturunkan (muncul lebih rendah dalam hasil). Jika nilainya positif, hasil akan dipromosikan (muncul lebih tinggi dalam hasil).
  - CONDITION: ekspresi filter teks untuk memilih dokumen yang akan diterapkan peningkatannya. Filter harus dievaluasi ke nilai boolean.
  Untuk mempelajari cara meningkatkan penelusuran terstruktur, lihat Meningkatkan hasil penelusuran.
- FACET_SPEC: optional. Spesifikasi faset untuk melakukan penelusuran berfaset.
- QUERY_EXPANSION_SPEC: optional. Spesifikasi untuk menentukan kondisi yang memungkinkan perluasan kueri terjadi. Defaultnya adalah DISABLED.
- SPELL_CORRECTION_SPEC: optional. Spesifikasi untuk menentukan kondisi yang menyebabkan koreksi ejaan harus dilakukan. Defaultnya adalah AUTO.
- CONTENT_SEARCH_SPEC: optional. Untuk mendapatkan cuplikan, jawaban ekstraktif, segmen ekstraktif, dan ringkasan penelusuran. Khusus untuk data tidak terstruktur. Untuk informasi selengkapnya, lihat:
  - Menggunakan cuplikan dan konten ekstraktif
  - Mendapatkan ringkasan penelusuran
- DATA_STORE_SPEC: filter untuk penyimpanan data tertentu yang akan dicari. Hal ini dapat digunakan jika aplikasi penelusuran Anda terhubung ke beberapa penyimpanan data. Untuk mengetahui informasi selengkapnya, lihat DataStoreSpec.
- Melihat hasil penelusuran terpandu dalam respons penelusuran:
  
  Hasil penelusuran terpandu ditampilkan dengan respons penelusuran untuk penelusuran terstruktur dan tidak terstruktur. Hasil penelusuran terpandu berisi daftar pasangan nilai kunci atribut yang diekstrak berdasarkan dokumen hasil penelusuran. Hal ini memungkinkan pengguna menyaring hasil penelusuran mereka dengan menggunakan beberapa kunci dan nilai atribut sebagai filter.
  
  Dalam contoh respons ini, warna hijau digunakan untuk mempersempit hasil penelusuran dengan mengirimkan permintaan penelusuran baru dengan kolom filter yang ditentukan sebagai _gs.color: ANY("green"):
```
{
"guidedSearchResult": {
  "refinementAttributes": [
    {
      "attributeKey": "_gs.color",
      "attributeValue": "green"
    },
    {
      "attributeKey": "_gs.category",
      "attributeValue": "shoe"
    }
  ]
}
}
```

Mendapatkan skor relevansi dokumen dengan hasil penelusuran

Skor relevansi dokumen didasarkan pada kemiripan kueri dengan dokumen. Skor dimasukkan ke dalam 11 bucket dalam rentang: 0, 0,1, 0,2, … hingga 1,0. Makin tinggi skornya, makin relevan dokumen tersebut.

Pertimbangkan skor relevansi dokumen untuk kasus penggunaan berikut:

Pemfilteran pasca-penelusuran berdasarkan skor relevansi untuk menghapus hasil yang tidak relevan
Peringkat pasca-penelusuran atau sebagai input ke aplikasi lain
Proses debug: skor relevansi dapat memberikan insight tentang alasan beberapa hasil penelusuran ditampilkan

Untuk setiap hasil penelusuran, skor relevansi dapat ditampilkan:

  "results": [
    {
      "id": "DOCUMENT_ID",
      "document": {
      ...
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            DOCUMENT-RELEVANCE-SCORE
          ]
        }
      }
    },
    ...

Lihat juga contoh perintah dalam prosedur di bawah.

Sebelum Anda memulai: Pastikan aplikasi penelusuran dikaitkan dengan penyimpanan data terstruktur atau tidak terstruktur.

REST

Untuk meminta agar skor relevansi dokumen ditampilkan dengan hasil penelusuran, gunakan metode engines.servingConfigs.search sebagai berikut:

Temukan ID aplikasi Anda. Jika Anda sudah memiliki ID aplikasi, lanjutkan ke langkah berikutnya.
1. Di konsol Google Cloud , buka halaman Gemini Enterprise.
  
  Buka Aplikasi
2. Di halaman Aplikasi, temukan nama aplikasi Anda dan dapatkan ID aplikasi dari kolom ID.

Jalankan perintah curl berikut untuk mendapatkan skor yang ditampilkan dengan hasil penelusuran.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/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",
     "relevanceScoreSpec": {
       "returnRelevanceScore": true
     }
}'

PROJECT_ID: ID project Anda.
APP_ID: ID aplikasi yang ingin Anda kueri.
QUERY: teks kueri yang akan ditelusuri.

Contoh perintah dan hasil parsial

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search:search" \
-d '{
      "servingConfig": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search",
      "query": "When was Verily founded and what is its mission?",
      "relevanceScoreSpec": {
        "returnRelevanceScore": true
      }
}'

{
  "results": [
    {
      "id": "f1b0d98bd2a078a6dfb4f809c3028565",
      "document": {
        "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/f1b0d98bd2a078a6dfb4f809c3028565",
        "id": "f1b0d98bd2a078a6dfb4f809c3028565",
        "derivedStructData": {
          "link": "gs://cloud-samples-data/gen-app-builder/search/alphabet-investor-pdfs/2019_alphabet_annual_report.pdf",
          "extractive_answers": [
            {
              "pageNumber": "70",
              "content": "VERILY Verily is a life science and healthcare company with a mission to make the world's health data useful so that people enjoy healthier lives. In December 2018, Verily received $900 million in cash from a $1.0 billion investment round. The remaining $100 million was received in the first quarter of 2019."
            }
          ],
          "title": "2019_alphabet_annual_report"
        }
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            0.7
          ]
        }
      }
    },
    {
      "id": "0371b29bfa18ac43896b86a7b63d00b0",
      "document": {
        "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/0371b29bfa18ac43896b86a7b63d00b0",
        "id": "0371b29bfa18ac43896b86a7b63d00b0",
        "derivedStructData": {
          "link": "gs://cloud-samples-data/gen-app-builder/search/alphabet-investor-pdfs/20190429_alphabet_10Q.pdf",
          "title": "GOOG 10-Q Q1 2019",
          "extractive_answers": [
            {
              "content": "Verily Verily is a life science company with a mission to make the world's health data useful so that people enjoy healthier lives. In December 2018, Verily received $900 million in cash from a $1.0 billion investment round. The remaining $100 million was received in the first quarter of 2019.",
              "pageNumber": "21"
            }
          ]
        }
      },
     "modelScores": {
        "relevance_score": {
          "values": [
            0.5
          ]
        }
      }
    },
    ...
    {
      "id": "e6bbd0d82dc2a2fc7ccf1bd82ac6334f",
      "document": {
        "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/e6bbd0d82dc2a2fc7ccf1bd82ac6334f",
        "id": "e6bbd0d82dc2a2fc7ccf1bd82ac6334f",
        "derivedStructData": {
          "title": "2021_Q1_Earnings_Transcript",
          "link": "gs://cloud-samples-data/gen-app-builder/search/alphabet-investor-pdfs/2021_Q1_Earnings_Transcript.pdf",
          "extractive_answers": [
            {
              "pageNumber": "2",
              "content": "Our strength in AI and ML is also helping Financial Services customers improve efficiency of payments, reduce fraud and risk, and deliver faster payment solutions."
            }
          ]
        }
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            0
          ]
        }
      }
    }
  ],
  "totalSize": 76,
  "attributionToken": "8QHw8AoLCIW4_b0GELHd3lgSJDY3YmU1ZGMwLTAwMDAtMmM1OC04NzcyLTc0NzQ0NjNiOGMyNSIHR0VORVJJQyqcAcb77TDHy_MX8tntMI6-nRWK4uQwwvCeFYX77TDvifIwq8SKLauR3zCq-LMt0IrIMNSynRWc1rctv_7kML7l3zDZveQwkPeyMMP77TD12e0wpd_hMIfi5DCRv9owgvvtMJWSxTCOkckwu-XfMK7Eii3sifIwqJHfMKjf4TCt-LMtlL_aMJ_Wty23t4wto4CXIs2KyDDcveQwwv7kMDABShIweDU3MGFkYWI4MzQ4NmY0MGE",
  "nextPageToken": "UjMjhjYzYDN0cDN30iM3cDOtgTNjJTLwADMw0iZiRWNlJ2N2QiGBUd0gWLEG4bjhWICMIBM1IgC",
  "summary": {},
  "queryExpansionInfo": {}
}

Ringkasan penelusuran berbeda menurut model

Jika Anda membuat ringkasan penelusuran untuk kueri, Anda mungkin melihat bahwa ringkasan berbeda antara hasil konsol dan hasil API. Jika Anda melihat pesan ini, kemungkinan alasannya adalah konsol menggunakan model LLM yang berbeda dari API. Contoh curl dan kode di halaman ini menggunakan model LLM yang stabil.

Untuk mengubah atau melihat model LLM yang digunakan di halaman Preview UI, buka halaman Configurations > tab UI untuk aplikasi Anda.
Untuk panggilan metode, model stabil adalah model default. Untuk menggunakan model LLM selain model stabil, lihat Menentukan model ringkasan dan Menentukan model jawaban.

Mendapatkan hasil penelusuran (Lama) Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Mendapatkan hasil penelusuran

REST

Mendapatkan skor relevansi dokumen dengan hasil penelusuran

REST

Contoh perintah dan hasil parsial

Ringkasan penelusuran berbeda menurut model

Mendapatkan hasil penelusuran (Lama)