Diese Seite wurde von der Cloud Translation API übersetzt.

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:

Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.

Zum Agent Builder
Klicken Sie auf der Seite Apps auf App erstellen.
Klicken Sie auf der Seite App erstellen unter Suche für Ihre Website auf Erstellen.
Entscheiden Sie, ob Sie Enterprise-Funktionen für diese App benötigen, und klicken Sie dann auf die Ein-/Aus-Schaltfläche. Sie müssen die Funktionen der Enterprise-Version aktivieren, um Funktionen wie die Websitesuche und die Auswahl einer Region für Ihre App nutzen zu können. Die Funktionen der Enterprise-Version verursachen zusätzliche Kosten. Weitere Informationen finden Sie unter Enterprise-Version.
Entscheiden Sie, ob Sie erweiterte LLM-Funktionen für diese App verwenden möchten, und klicken Sie dann auf den Ein-/Aus-Schalter. Sie müssen die erweiterten LLM-Funktionen aktivieren, um Funktionen wie Suchergebnisse mit Zusammenfassungen oder Suche mit weiterführenden Fragen nutzen zu können. Weitere Informationen finden Sie unter Erweiterte LLM-Funktionen.
Geben Sie im Feld Anwendungsname einen Namen für die Anwendung ein.
Geben Sie im Feld Externer Name Ihres Unternehmens oder Ihrer Organisation den gängigen Namen Ihres Unternehmens oder Ihrer Organisation ein. Vermeiden Sie Suffixe wie „GmbH“ oder „AG“. Anhand dieses Felds kann der LLM das Unternehmen identifizieren, das die App repräsentiert.
Wählen Sie einen Standort für Ihre App aus. Die Enterprise-Funktionen müssen aktiviert sein, damit Sie einen Standort auswählen können. Wir empfehlen, die Standardeinstellung global (Global) zu verwenden, es sei denn, Sie haben einen Grund, Ihre Daten auf eine bestimmte Region zu beschränken.
Klicken Sie auf Weiter.
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.

Hinweis: Wenn Sie Ihrer App mehrere Datenspeicher zuordnen möchten, lesen Sie den Hilfeartikel Zusammengeführte Suche. Dort finden Sie Informationen zu den Funktionen und Einschränkungen. Wenn Sie nur einen Datenspeicher anhängen, können Sie später keine weiteren anhängen.

Wählen Sie eine der folgenden Optionen aus:
- Vorhandenen Datenspeicher auswählen: Wenn Sie nur einen Datenspeicher anhängen, können Sie ihn nicht entfernen oder der App später weitere Datenspeicher hinzufügen. Wenn Sie mehrere Datenspeicher anhängen, können Sie sie später aktualisieren. Für die App sind jedoch immer mindestens zwei Datenspeicher erforderlich.
- So erstellen Sie einen neuen Datenspeicher und nehmen Daten darin auf:
  1. Klicken Sie auf Datenspeicher 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 mit der Befehlszeile eine App erstellen können, benötigen Sie einen vorhandenen Datenspeicher. 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 mit der Methode engines.create eine Such-App über die Befehlszeile:

Suchen Sie die Datenspeicher-ID. Wenn Sie die Datenspeicher-ID bereits haben, fahren Sie mit dem nächsten Schritt fort.
1. Rufen Sie in der Google Cloud Console die Seite Agent Builder 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.
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.

Wichtiger Begriff:In Vertex AI Search kann der Begriff App im Kontext von APIs synonym mit dem Begriff Engine verwendet 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": "INDUSTRY_VERTICAL",
  "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.
- INDUSTRY_VERTICAL: Die Branche, der die App zugeordnet ist. Dieses Feld kann die in IndustryVertical angegebenen Werte haben. Bei Suchanwendungen mit mehreren Datenspeichern, auch zusammengeführte Suchanwendungen genannt, müssen Sie dieses Feld als GENERIC angeben.
- SEARCH_TIER: Die Suchebene 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 nutzen zu können. Die Funktionen der Enterprise-Version verursachen zusätzliche Kosten. 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 Suchergebnisse mit Zusammenfassungen 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 Vertex AI Agent Builder Python API.

Richten Sie zur Authentifizierung bei Vertex AI Agent Builder 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 Such-App mit Terraform finden Sie unter discovery_engine_search_engine.