Suchanwendung erstellen

Auf dieser Seite wird beschrieben, wie Sie eine Such-App erstellen.

App erstellen

Console

So erstellen Sie eine Such-App mit der Google Cloud Console:

  1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

    KI-Anwendungen

  2. Klicken Sie auf der Seite Apps auf und dann auf App erstellen.

  3. Klicken Sie auf der Seite App erstellen im Bereich Site Search mit KI-Modus auf Erstellen.

  4. Legen Sie fest, ob Sie Enterprise-Funktionen für diese App verwenden möchten, und klicken Sie dann auf die Ein/Aus-Schaltfläche. Wenn Sie Funktionen wie die Websitesuche und die Auswahl einer Region für Ihre App nutzen möchten, müssen Sie die Enterprise-Version aktivieren. Für die Enterprise-Version fallen zusätzliche Kosten an. Weitere Informationen finden Sie unter Enterprise-Version.

  5. Legen Sie fest, ob Sie für diese App generative Antworten mit erweiterten LLM-Funktionen verwenden möchten, und klicken Sie dann auf die Ein/Aus-Schaltfläche. Wenn Sie Funktionen wie Suchzusammenfassungen oder die Suche mit weiterführenden Fragen nutzen möchten, müssen Sie die Option Generative Antworten aktivieren. Weitere Informationen finden Sie unter Generative Antworten.

  6. Geben Sie im Feld Anwendungsname einen Namen für Ihre App ein.

  7. Geben Sie im Feld Externer Name Ihres Unternehmens oder Ihrer Organisation den üblichen Namen Ihres Unternehmens oder Ihrer Organisation ein. Vermeiden Sie Suffixe wie „Inc.“ oder „LLC“. Dieses Feld hilft dem LLM, das Unternehmen zu identifizieren, für das die App steht.

  8. Wählen Sie einen Standort für Ihre App aus. Enterprise-Funktionen müssen aktiviert sein, um einen Standort auszuwählen. Google empfiehlt, die Standardeinstellung global (Global) zu verwenden, es sei denn, Sie haben einen Grund, Ihre Daten auf einen bestimmten geografischen Bereich zu beschränken.

  9. Klicken Sie auf Weiter.

  10. Wenn Sie eine Verbindung zu einem Datenspeicher herstellen möchten, wählen Sie auf der Seite Datenspeicher einen zuvor erstellten Datenspeicher aus oder erstellen Sie einen neuen Datenspeicher.

    Wählen Sie eine der folgenden Optionen aus:

    • Vorhandenen Datenspeicher auswählen: Wenn Sie nur einen Datenspeicher anhängen, können Sie ihn später nicht entfernen oder der App keine weiteren Datenspeicher hinzufügen. Wenn Sie mehrere Datenspeicher anhängen, können Sie die angehängten Datenspeicher später aktualisieren. Für die App sind jedoch immer mindestens zwei Datenspeicher erforderlich.
    • Neuen Datenspeicher erstellen und Daten aufnehmen:
      1. Klicken Sie auf Erstellen Datenspeicher und folgen Sie der Anleitung auf der Seite Neuen Datenspeicher erstellen.
      2. Wählen Sie den neuen Datenspeicher aus und klicken Sie auf Auswählen. Weitere Informationen finden Sie unter Suchdatenspeicher erstellen.

REST

Bevor Sie eine App über die Befehlszeile erstellen, müssen Sie einen vorhandenen Datenspeicher haben. Wenn Sie keinen Datenspeicher haben, erstellen Sie einen. Folgen Sie dazu der Anleitung unter Datenspeicher erstellen und Daten für die Agent Search aufnehmen.

So erstellen Sie eine Such-App über die Befehlszeile mit der engines.create Methode:

  1. Suchen Sie nach Ihrer Datenspeicher-ID. Wenn Sie die ID Ihres Datenspeichers bereits haben, fahren Sie mit dem nächsten Schritt fort.

    1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf und klicken Sie im Navigationsmenü auf Datenspeicher.

      Rufen Sie die Seite Datenspeicher auf.

    2. Klicken Sie auf den Namen des Datenspeichers.

    3. Rufen Sie auf der Seite Daten Ihres Datenspeichers die Datenspeicher-ID ab.

  2. Erstellen Sie eine Such-App und verbinden Sie sie mit einem Datenspeicher. Ein Datenspeicher kann nur an eine App angehängt werden und kann später nicht mehr aus der App entfernt werden.

    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": "GENERIC",
  "searchEngineConfig": {
     "searchTier": "SEARCH_TIER",
     "searchAddOns": ["SEARCH_ADD_ON"]
   }
}'

    Ersetzen Sie Folgendes:

    • PROJECT_ID: die ID Ihres Google Cloud Projekts.
    • APP_ID: die ID der Agent Search-App, die Sie erstellen möchten.
    • APP_DISPLAY_NAME: der Anzeigename der Agent Search-App, die Sie erstellen möchten.
    • DATA_STORE_ID: die ID eines vorhandenen Agent Search-Datenspeichers, den Sie der Agent Search-App hinzufügen möchten.
    • SEARCH_TIER: Die Suchstufe kann SEARCH_TIER_STANDARD oder SEARCH_TIER_ENTERPRISE sein. SEARCH_TIER_ENTERPRISE ist erforderlich, um Funktionen wie die Websitesuche und die Auswahl einer Region für Ihre App zu nutzen. Für die Enterprise-Version fallen zusätzliche Kosten an. Weitere Informationen finden Sie unter Enterprise Version.

    • SEARCH_ADD_ON: Wenn Sie für diese App generative Antworten mit erweiterten LLM-Funktionen verwenden möchten, geben Sie SEARCH_ADD_ON_LLM an. Generative Antworten umfassen Suchzusammenfassungen und die Suche mit weiterführenden Fragen.

      Wenn Sie keine generativen Antworten verwenden möchten, geben Sie entweder SEARCH_ADD_ON_UNSPECIFIED als Such-Add-on an oder entfernen Sie das Feld searchAddOns.

      Weitere Informationen finden Sie unter Generative Antworten.

Python

Weitere Informationen finden Sie in der Agent Search Python API Referenzdokumentation.

Richten Sie zur Authentifizierung bei der Agent Search die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

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

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle. Weitere Informationen finden Sie in der Terraform Anbieter-Referenzdokumentation.

Informationen zum Erstellen einer Such-App mit Terraform finden Sie unter discovery_engine_search_engine.

Nächste Schritte