Membuat aplikasi penelusuran

Halaman ini menjelaskan cara membuat aplikasi penelusuran.

Buat aplikasi

Konsol

Untuk membuat aplikasi penelusuran menggunakan konsol Google Cloud, ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud, buka halaman Agent Builder.

    Agent Builder

  2. Di halaman Aplikasi, klik Buat aplikasi.

  3. Di halaman Buat aplikasi, klik Buat di bagian Telusuri situs Anda.

  4. Tentukan apakah Anda menginginkan fitur Enterprise untuk aplikasi ini, lalu klik tombol untuk mengaktifkan atau menonaktifkannya. Mengaktifkan fitur edisi Enterprise diperlukan untuk mendapatkan fitur seperti penelusuran situs dan memilih wilayah untuk aplikasi Anda. Fitur edisi Enterprise akan dikenai biaya tambahan. Untuk informasi selengkapnya, lihat Fitur edisi Enterprise.

  5. Tentukan apakah Anda menginginkan fitur LLM lanjutan untuk aplikasi ini, lalu klik tombol untuk mengaktifkan atau menonaktifkannya. Mengaktifkan fitur LLM lanjutan diperlukan untuk mendapatkan fitur seperti ringkasan penelusuran atau penelusuran dengan tindak lanjut. Untuk informasi selengkapnya, lihat Fitur LLM lanjutan.

  6. Di kolom Nama aplikasi Anda, masukkan nama untuk aplikasi Anda.

  7. Di kolom Nama eksternal perusahaan atau organisasi Anda, masukkan nama umum untuk perusahaan atau organisasi Anda. Hindari akhiran seperti Inc atau LLC. Kolom ini membantu LLM mengidentifikasi perusahaan yang diwakili aplikasi.

  8. Pilih lokasi untuk aplikasi Anda. Fitur Enterprise harus diaktifkan untuk memilih lokasi. Google merekomendasikan agar Anda menggunakan setelan default, global (Global), kecuali jika Anda memiliki alasan untuk membatasi data ke geografi tertentu.

  9. Klik Lanjutkan.

  10. Untuk terhubung ke penyimpanan data, di halaman Data stores, pilih penyimpanan data yang sebelumnya Anda buat atau buat penyimpanan data baru.

    Pilih salah satu opsi berikut:

    • Pilih penyimpanan data yang ada: Jika hanya melampirkan satu penyimpanan data, Anda tidak dapat menghapusnya atau menambahkan penyimpanan data lain ke aplikasi nanti. Dengan melampirkan beberapa penyimpanan data, Anda dapat memperbarui penyimpanan data yang dilampirkan nanti, tetapi aplikasi selalu memerlukan minimal dua penyimpanan data.
    • Buat penyimpanan data baru dan serap data ke dalamnya:
      1. Klik Buat penyimpanan data dan ikuti langkah-langkah di halaman Buat penyimpanan data baru.
      2. Pilih penyimpanan data baru, lalu klik Pilih. Untuk informasi selengkapnya, lihat Membuat penyimpanan data penelusuran.

REST

Sebelum menggunakan command line untuk membuat aplikasi, Anda harus memiliki penyimpanan data yang sudah ada. Jika Anda tidak memiliki penyimpanan data, buat penyimpanan data dengan mengikuti langkah-langkah di Membuat penyimpanan data dan menyerap data untuk Vertex AI Search.

Untuk menggunakan metode engines.create guna membuat aplikasi penelusuran dari command line, ikuti langkah-langkah berikut:

  1. Temukan ID penyimpanan data Anda. Jika Anda sudah memiliki ID penyimpanan data, lanjutkan ke langkah berikutnya.

    1. Di konsol Google Cloud, buka halaman Agent Builder dan di menu navigasi, klik Data Stores.

      Buka halaman Data Store

    2. Klik nama penyimpanan data Anda.

    3. Di halaman Data untuk penyimpanan data Anda, dapatkan ID penyimpanan data.

  2. Buat aplikasi penelusuran dan hubungkan ke penyimpanan data. Penyimpanan data hanya dapat dilampirkan ke satu aplikasi dan tidak dapat dihapus dari aplikasi nanti.

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Goog-User-Project: PROJECT_ID" \
    "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines?engineId=APP_ID" \
    -d '{
      "displayName": "APP_DISPLAY_NAME",
      "dataStoreIds": ["DATA_STORE_ID"],
      "solutionType": "SOLUTION_TYPE_SEARCH",
      "industryVertical": "INDUSTRY_VERTICAL",
      "searchEngineConfig": {
         "searchTier": "SEARCH_TIER",
         "searchAddOns": ["SEARCH_ADD_ON"]
       }
    }'
    

    Ganti kode berikut:

    • PROJECT_ID: ID project Google Cloud Anda.
    • APP_ID: ID aplikasi Vertex AI Search yang ingin Anda buat.
    • APP_DISPLAY_NAME: nama tampilan aplikasi Vertex AI Search yang ingin Anda buat.
    • DATA_STORE_ID: ID penyimpanan data Vertex AI Search yang ada yang ingin Anda tambahkan ke aplikasi Vertex AI Search.
    • INDUSTRY_VERTICAL: vertikal industri yang dikaitkan dengan aplikasi. Kolom ini dapat menggunakan nilai yang ditentukan di IndustryVertical. Untuk aplikasi penelusuran dengan beberapa penyimpanan data, yang juga disebut aplikasi penelusuran gabungan, Anda harus menentukan kolom ini sebagai GENERIC.
    • SEARCH_TIER: tingkat penelusuran dapat berupa SEARCH_TIER_STANDARD atau SEARCH_TIER_ENTERPRISE. SEARCH_TIER_ENTERPRISE diperlukan untuk mendapatkan fitur seperti penelusuran situs dan memilih wilayah untuk aplikasi Anda. Fitur edisi Enterprise akan dikenai biaya tambahan. Untuk informasi selengkapnya, lihat Fitur edisi Enterprise.
    • SEARCH_ADD_ON: jika Anda menginginkan fitur LLM Lanjutan untuk aplikasi ini, tentukan SEARCH_ADD_ON_LLM. Fitur LLM lanjutan mencakup ringkasan penelusuran dan penelusuran dengan tindak lanjut.

      Jika Anda tidak menginginkan fitur LLM Lanjutan, tentukan SEARCH_ADD_ON_UNSPECIFIED atau hapus kolom searchAddOns.

      Untuk informasi selengkapnya, lihat Fitur LLM lanjutan.

Python

Untuk mengetahui informasi selengkapnya, lihat Dokumentasi referensi API Python Vertex AI Agent Builder.

Untuk melakukan autentikasi ke Vertex AI Agent Builder, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, baca Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

from typing import List

from google.api_core.client_options import ClientOptions
from google.cloud import discoveryengine_v1 as discoveryengine

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_LOCATION" # Values: "global"
# engine_id = "YOUR_ENGINE_ID"
# data_store_ids = ["YOUR_DATA_STORE_ID"]


def create_engine_sample(
    project_id: str, location: str, engine_id: str, data_store_ids: List[str]
) -> str:
    #  For more information, refer to:
    # https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
    client_options = (
        ClientOptions(api_endpoint=f"{location}-discoveryengine.googleapis.com")
        if location != "global"
        else None
    )

    # Create a client
    client = discoveryengine.EngineServiceClient(client_options=client_options)

    # The full resource name of the collection
    # e.g. projects/{project}/locations/{location}/collections/default_collection
    parent = client.collection_path(
        project=project_id,
        location=location,
        collection="default_collection",
    )

    engine = discoveryengine.Engine(
        display_name="Test Engine",
        # Options: GENERIC, MEDIA, HEALTHCARE_FHIR
        industry_vertical=discoveryengine.IndustryVertical.GENERIC,
        # Options: SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT
        solution_type=discoveryengine.SolutionType.SOLUTION_TYPE_SEARCH,
        # For search apps only
        search_engine_config=discoveryengine.Engine.SearchEngineConfig(
            # Options: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE
            search_tier=discoveryengine.SearchTier.SEARCH_TIER_ENTERPRISE,
            # Options: SEARCH_ADD_ON_LLM, SEARCH_ADD_ON_UNSPECIFIED
            search_add_ons=[discoveryengine.SearchAddOn.SEARCH_ADD_ON_LLM],
        ),
        # For generic recommendation apps only
        # similar_documents_config=discoveryengine.Engine.SimilarDocumentsEngineConfig,
        data_store_ids=data_store_ids,
    )

    request = discoveryengine.CreateEngineRequest(
        parent=parent,
        engine=engine,
        engine_id=engine_id,
    )

    # Make the request
    operation = client.create_engine(request=request)

    print(f"Waiting for operation to complete: {operation.operation.name}")
    response = operation.result()

    # After the operation is complete,
    # get information from operation metadata
    metadata = discoveryengine.CreateEngineMetadata(operation.metadata)

    # Handle the response
    print(response)
    print(metadata)

    return operation.operation.name

Terraform

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi penyedia Terraform.

Untuk membuat aplikasi penelusuran menggunakan Terraform, lihat discovery_engine_search_engine.

Langkah berikutnya