Grounding dengan Elasticsearch

Konsol

Untuk melakukan perujukan dengan Elasticsearch di konsol Google Cloud , lakukan hal berikut:

1. Buka Vertex AI Studio ke halaman Create prompt.

   Buka Buat perintah

2. Di panel Setelan, untuk mendasarkan data Anda, klik tombol Pendasaran: Data Anda.

3. Di panel Sesuaikan Perujukan, pilih Elasticsearch.

4. Masukkan endpoint di kolom Elasticsearch endpoint.

5. Masukkan Kunci API di kolom Elasticsearch API Key.

6. Masukkan indeks di kolom Elasticsearch index.

7. Masukkan template penelusuran di kolom Elasticsearch search template.

8. Sesuaikan jumlah hit dengan menggeser penggeser Jumlah hit.

9. Klik Simpan.

10. Masukkan perintah Anda.

11. Klik Kirim.

Memahami respons Anda

Jika perintah model Anda berhasil melakukan perujukan ke datastore Elasticsearch menggunakan Vertex AI Studio atau API, respons model akan menyertakan metadata dengan kutipan dan konten sumber. Jika relevansi sumber rendah atau informasi tidak lengkap terjadi dalam respons model, metadata mungkin tidak diberikan, dan respons perintah tidak akan di-grounding.

REST

Bagian ini menjelaskan cara Anda menggunakan Vertex AI API untuk mendasari respons LLM Anda.

Prasyarat

Sebelum Anda dapat mendasarkan respons LLM dengan Elasticsearch, Anda harus menyelesaikan langkah-langkah berikut:

1. Aktifkan Vertex AI API: Pastikan Vertex AI API diaktifkan untuk project Google Cloud Anda.

2. Instal dan login ke CLI Google Cloud CLI: Instal dan lakukan inisialisasi alat command line gcloud CLI.

3. Penyiapan Elasticsearch: Gunakan cluster dan indeks Elasticsearch yang ada yang ingin Anda gunakan untuk perujukan. Dapatkan informasi berikut dari penyiapan Elasticsearch Anda:

   • Endpoint: URL cluster Elasticsearch Anda.
   • Nama Indeks: Nama indeks yang ingin Anda telusuri, seperti my-data-index.
   • Kunci API: Kunci API yang memungkinkan akses ke cluster Elasticsearch Anda. Kunci API harus diawali dengan awalan ApiKey.

4. Membuat template penelusuran Elasticsearch: Gunakan sumber data Elasticsearch yang menggunakan template referensi yang menampilkan data hasil untuk perujukan.

Akses API

Gunakan petunjuk berikut untuk mendasari Gemini dengan sumber data Elasticsearch menggunakan Vertex AI API.

Menyiapkan permintaan pembuatan dengan perujukan

Untuk mengirimkan perintah teks dan mendasarkannya pada Elasticsearch, kirim permintaan POST ke Vertex AI API. Minimal, Anda harus memberikan isi permintaan. Pastikan untuk melakukan penggantian berikut:

• QUERY: Perintah teks untuk merujuk.
• ELASTIC_SEARCH_ENDPOINT: Jalur endpoint absolut untuk resource Elasticsearch yang akan digunakan.
• ELASTIC_SEARCH_API_KEY: Kunci API untuk endpoint data Elasticsearch.
• INDEX_NAME: Nama indeks Elasticsearch yang digunakan untuk perujukan.
• SEARCH_TEMPLATE_NAME: Template penelusuran Elasticsearch yang digunakan untuk perujukan.
• NUM_HITS: Jumlah hasil yang ditampilkan dari sumber data Elasticsearch dan digunakan untuk perujukan.

Meminta isi JSON:

    {
      "contents": [
        {
          "role": "user",
          "parts": [
            {
              "text": "QUERY"
            }
          ]
        }
      ],
      "tools": [{
        "retrieval": {
          "externalApi": {
            "api_spec": "ELASTIC_SEARCH",
            "endpoint": "ELASTIC_SEARCH_ENDPOINT",
            "apiAuth": {
              "apiKeyConfig": {
                "apiKeyString": "ApiKey ELASTIC_SEARCH_API_KEY"
              }
            },
            "elasticSearchParams": {
              "index": "INDEX_NAME",
              "searchTemplate": "SEARCH_TEMPLATE_NAME",
              "numHits": "NUM_HITS",
            }
          }
        }
      }]
    }

Untuk mengetahui informasi selengkapnya tentang kolom API lainnya seperti petunjuk sistem dan percakapan multi-giliran, lihat Panduan pemula AI Generatif.

Mengirim permintaan API

Anda dapat menyimpan isi permintaan dalam file bernama request.json. Kemudian, jalankan permintaan POST API, dan lakukan penggantian berikut:

• LOCATION: Region untuk memproses permintaan. Untuk mengetahui informasi selengkapnya tentang lokasi yang tersedia, lihat Lokasi AI Generatif di Vertex AI.
• PROJECT_ID: ID project Google Cloud Anda. Untuk mengetahui informasi selengkapnya tentang ID project, lihat Membuat dan mengelola project.
• MODEL_ID: ID model multimodal.

  curl -X POST \
      -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      -H "Content-Type: application/json; charset=utf-8" \
      -d @request.json \
  "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_ID:generateContent"

Anda akan melihat respons JSON seperti berikut:

  {
    "candidates": [
      {
        "content": {
          "role": "model",
          "parts": [
            {
              "text": "Based on the information ..."
            }
          ]
        },
        "finishReason": "STOP",
        "safetyRatings": [ "..." ],
        "groundingMetadata": {
          "groundingChunks": [
            {
              "retrievedContext": {
                "text": "ipsum lorem ..."
              }
            },
            {...},
            {...},
          ],
          "groundingSupports": [
            {
              "segment": {
                "startIndex": 25,
                "endIndex": 147,
                "text": "ipsum lorem ..."
              },
              "groundingChunkIndices": [1,2],
              "confidenceScores": [0.6626542, 0.82018316],
            },
          ],
        },
      }
    ],
  }

Memahami respons Anda

Respons dari kedua API tersebut mencakup teks yang dihasilkan LLM, yang disebut kandidat. Jika perintah model Anda berhasil mendasarkan pada sumber data Elasticsearch, respons akan menyertakan metadata perujukan, yang mengidentifikasi bagian respons yang berasal dari data Elasticsearch Anda. Namun, ada beberapa alasan mengapa metadata ini mungkin tidak diberikan, dan respons prompt tidak akan memiliki rujukan. Alasan tersebut mencakup relevansi sumber yang rendah atau informasi yang tidak lengkap dalam respons model.

Berikut adalah perincian data output:

• Peran: Menunjukkan pengirim jawaban berbasis informasi. Karena respons selalu berisi teks yang dirujuk, peran selalu model.
• Teks: Jawaban yang dirujuk yang dihasilkan oleh LLM.
• Metadata perujukan: Informasi tentang sumber perujukan, yang berisi elemen berikut:
  • Potongan perujukan: Daftar hasil dari indeks Elasticsearch Anda yang mendukung jawaban.
  • Dukungan perujukan: Informasi tentang klaim tertentu dalam jawaban yang dapat digunakan untuk menampilkan kutipan:
  • Segmen: Bagian jawaban model yang didukung oleh potongan perujukan.
  • Indeks potongan perujukan: Indeks potongan perujukan dalam daftar potongan perujukan yang sesuai dengan klaim ini.
  • Skor keyakinan: Angka dari 0 hingga 1 yang menunjukkan seberapa kuat klaim tersebut didasarkan pada kumpulan perujukan yang disediakan. Tidak tersedia untuk Gemini 2.5 Pro dan Gemini 2.5 Flash serta yang lebih baru.