Als Nutzer einer Datendomain können Sie Datendomains verwenden, um Suchergebnisse auf bestimmte geschäftliche Kontexte zu beschränken, nach BigQuery-Datasets, -Tabellen und -Datenprodukten zu suchen und Metadaten innerhalb bestimmter Domainbegrenzungen zu finden.
Hinweis
Bevor Sie eine Suche nach Domain durchführen, prüfen Sie, ob Sie die erforderlichen Rollen haben und die APIs aktiviert sind.
APIs aktivieren
Aktivieren Sie die Dataplex API, falls sie noch nicht aktiviert ist.
Rollen, die zum Aktivieren von APIs erforderlich sind
Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen.
Erforderliche Rollen
Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für das Projekt oder die Datendomain zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Suchen und Auffinden von Metadaten mithilfe von Datendomains benötigen:
-
Metadaten von Domain-Einträgen für die Suche ansehen:
Dataplex Data Domain Entry Reader (
roles/dataplex.dataDomainEntryReader) -
Domainkonfigurationen und -bindungen ansehen:
Dataplex Data Domain Configuration Viewer (
roles/dataplex.dataDomainViewer)
Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.
Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.
Domainhierarchie durchsuchen
Weitere Informationen zum Durchsuchen der Domainhierarchie finden Sie unter Datendomains und Subdomains an einem Standort ansehen.
Ressourcen in einer Datendomain finden
So suchen Sie nach Ressourcen mit einer Domain:
Console
Rufen Sie in der Google Cloud Console die Seite Knowledge Catalog > Suchen auf.
Klicken Sie auf Natürliche Suche testen , um die Funktion für die natürliche Suche zu aktivieren.
Klicken Sie auf Filter.
Wählen Sie im Feld Bereich die Option Domain aus der Liste aus.
Wählen Sie im Feld Domain auswählen die Domain aus, auf die Sie die Ergebnisse beschränken möchten. Fügen Sie bei Bedarf weitere Filter hinzu.
Alternativ können Sie die Menüoption In Domain suchen verwenden, um Ressourcen in der Domain zu finden:
Rufen Sie in der Google Cloud Console die Datendomains Seite auf.
Wählen Sie im Menü „“ die Option In Domain suchen aus. Dadurch wird automatisch ein Suchfenster mit dem angewendeten Filter Domain geöffnet.
Verwenden Sie das Suchfeld, um Ressourcen in der Domain zu finden.
REST
Verwenden Sie die Methode projects.locations.searchEntries und geben Sie den Domainpfad im Parameter contexts an, um nach Einträgen zu suchen, die auf eine Datendomain beschränkt sind.
Ersetzen Sie folgende Werte in den Anfragedaten:
PROJECT_ID: die ID Ihres Google Cloud Projekts in.LOCATION_ID: die Region für die Suchanfrage (oderglobal).QUERY: der Suchabfragestring.DOMAIN_ID: die eindeutige Kennung der Datendomain, die den Kontext des Suchbereichs definiert.
HTTP-Methode und URL:
POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID:searchEntries
JSON-Text der Anfrage:
{
"query": "QUERY",
"contexts": [ "projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" ],
"semantic_search": true,
"page_size": 100
}
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten einen erfolgreichen Statuscode (2xx) und eine leere Antwort als Ausgabe erhalten.
Kontext für Datendomains abrufen
Mit der lookupContext
Methode können Sie KI-Agenten in den geschäftlichen Kontext einbinden, der von Ihren Daten
domains erfasst wird. Die Methode lookupContext unterstützt Datendomains auf folgende Weise:
- Kontext für eine Datendomain Sie können den Eintrag, der eine Datendomain darstellt, in der Liste
resourcesübergeben. Die Antwort enthält die Metadaten der Datendomain, z. B. die Beschreibung und die übergeordneten Datendomains in der Domainhierarchie. - Datendomain-Mitgliedschaft von Daten-Assets Wenn Sie den Kontext für ein Daten-Asset abrufen, das in einer oder mehreren Datendomains enthalten ist, enthält die Antwort ein Feld
dataDomains, in dem die Datendomains aufgeführt sind, zu denen das Asset gehört. Dabei wird mit der spezifischsten Domain begonnen und bis zur Domain der obersten Ebene aufgestiegen.
Senden Sie die folgende Anfrage, um den Kontext für eine Datendomain abzurufen:
curl --request POST \
'https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:lookupContext' \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H 'Content-Type: application/json' \
-d '{
"resources": [
"projects/PROJECT_ID/locations/LOCATION/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION/dataDomains/DATA_DOMAIN_ID"
],
"options": {
"format": "yaml"
}
}'
Ersetzen Sie Folgendes:
- PROJECT_ID: die ID des Projekts, das die Datendomain enthält.
- PROJECT_NUMBER: die Nummer des Projekts, das die Datendomain enthält.
- LOCATION: der Standort der Datendomain.
- DATA_DOMAIN_ID: die ID der Datendomain.
Weitere Informationen zur Methode lookupContext finden Sie unter
Kontext für Daten-Assets abrufen.
Beschränkungen
Wenn Sie nach Ressourcen außerhalb des Domainkontexts suchen, z. B. bei einer globalen Suche, gelten die Berechtigungen für die Auffindbarkeit der Domain nicht. Sie sehen nur Ressourcen, auf die Sie im zugrunde liegenden System, z. B. BigQuery, Zugriff haben.
Angenommen, ein BigQuery-Dataset ist in einer Datendomain enthalten. Sie haben die Rolle Dataplex Data Domain Entry Reader für die Domain, aber keine direkte Berechtigung, das Dataset in BigQuery anzusehen:
- Suche innerhalb der Domain:Das Dataset wird in den Suchergebnissen angezeigt, da die Domainberechtigungen gelten.
- Suche außerhalb der Domain:Das Dataset wird nicht in den Suchergebnissen angezeigt. Bei einer allgemeinen Suche gelten keine Domainberechtigungen und Sie haben keinen direkten Zugriff in BigQuery.
Nächste Schritte
- Weitere Informationen zu Datendomains.
- Datendomains erstellen
- Erfahren Sie, wie Sie Datendomain-Ressourcen verwalten.