Suchanwendung erstellen

Console

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

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

   KI-Anwendungen

2. Klicken Sie auf der Seite Apps auf addApp erstellen.

3. Klicken Sie auf der Seite addApp erstellen unter Site Search mit KI-Modus auf Erstellen.

4. Entscheiden Sie, ob Sie Enterprise-Funktionen für diese App verwenden möchten, und klicken Sie dann auf den Ein/Aus-Schalter. Wenn Sie Enterprise-Funktionen aktivieren, erhalten Sie Funktionen wie die Websitesuche und die Möglichkeit, eine Region für Ihre App auszuwählen. Für Enterprise-Funktionen fallen zusätzliche Kosten an. Weitere Informationen finden Sie unter Funktionen der Enterprise-Version.

5. Entscheiden Sie, ob Sie erweiterte LLM-Features für diese App verwenden möchten, und klicken Sie dann auf den Schieberegler, um ihn zu aktivieren oder zu deaktivieren. Die Aktivierung der erweiterten LLM-Features ist erforderlich, um Funktionen wie Suchzusammenfassungen oder Suche mit weiterführenden Fragen zu nutzen. Weitere Informationen finden Sie unter Erweiterte LLM-Funktionen.

6. Geben Sie im Feld Name der App einen Namen für die 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“. Mithilfe dieses Felds kann das LLM das Unternehmen identifizieren, für das die App steht.

8. Wählen Sie einen Standort für Ihre App aus. Unternehmensfunktionen müssen aktiviert sein, um einen Standort auszuwählen. Google empfiehlt, den Standardwert Global zu verwenden, sofern Sie Ihre Daten nicht aus einem bestimmten Grund auf eine bestimmte geografische Einheit beschränken müssen.

9. Klicken Sie auf Weiter.

10. Wenn Sie eine Verbindung zu einem Datenspeicher herstellen möchten, wählen Sie auf der Seite Datenspeicher einen Datenspeicher aus, den Sie zuvor erstellt haben, 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 und der App auch keine anderen Datenspeicher hinzufügen. Wenn Sie mehrere Datenspeicher anhängen, können Sie die angehängten Datenspeicher später aktualisieren. Die App erfordert jedoch immer mindestens zwei Datenspeicher.
    • Neuen Datenspeicher erstellen und Daten darin aufnehmen:
      1. Klicken Sie auf addDatenspeicher erstellen 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 Datenspeicher haben. Wenn Sie keinen Datenspeicher haben, erstellen Sie einen. Folgen Sie dazu der Anleitung unter Datenspeicher erstellen und Daten für Vertex AI Search aufnehmen.

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

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.

      Zur Seite „Datenspeicher“

   2. Klicken Sie auf den Namen des Datenspeichers.

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

2. Erstellen Sie eine Suchanwendung und verbinden Sie sie mit einem Datenspeicher. Ein Datenspeicher kann nur mit einer App verknüpft 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 Vertex AI Search-App, die Sie erstellen möchten.
   • APP_DISPLAY_NAME: Der Anzeigename der Vertex AI Search-App, die Sie erstellen möchten.
   • DATA_STORE_ID: Die ID eines vorhandenen Vertex AI Search-Datenspeichers, den Sie der Vertex AI 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 Funktionen der Enterprise-Version fallen zusätzliche Kosten an. Weitere Informationen finden Sie unter Funktionen der Enterprise-Version.

   • SEARCH_ADD_ON: Wenn Sie erweiterte LLM-Funktionen für diese App verwenden möchten, geben Sie SEARCH_ADD_ON_LLM an. Zu den erweiterten LLM-Funktionen gehören Suchzusammenfassungen und die Suche mit weiterführenden Fragen.

     Wenn Sie keine erweiterten LLM-Features verwenden möchten, geben Sie entweder SEARCH_ADD_ON_UNSPECIFIED an oder entfernen Sie das Feld searchAddOns.

     Weitere Informationen finden Sie unter Erweiterte LLM-Funktionen.

Python

Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications Python API.

Richten Sie zur Authentifizierung bei AI Applications 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 Anbieterreferenzdokumentation zu Terraform.

Informationen zum Erstellen einer Suchanwendung mit Terraform finden Sie unter discovery_engine_search_engine.