ContextQMD
Back to Genai Toolbox

Knowledge Catalog (formerly known as Dataplex)

docs/en/integrations/knowledge-catalog/prebuilt-configs/knowledge-catalog.md

1.5.02.2 KB
Original Source

Knowledge Catalog

  • --prebuilt value: dataplex
  • Environment Variables:
    • DATAPLEX_PROJECT: The GCP project ID.
  • Permissions:
    • Dataplex Reader (roles/dataplex.viewer) to search and look up entries.
    • Dataplex Editor (roles/dataplex.editor) to modify entries.
  • Tools:
    • search_entries: Searches for entries in Knowledge Catalog.
    • lookup_entry: Retrieves a specific entry from Knowledge Catalog.
    • search_aspect_types: Finds aspect types relevant to the query.
    • lookup_context: Retrieves rich metadata regarding one or more data assets along with their relationships.
    • search_dq_scans: Search for data quality scans in Dataplex.
    • generate_data_insights: Creates a new Dataplex Data Documentation scan template and triggers the run.
    • get_data_insights: Retrieves the final generated data insights for a completed scan.
    • generate_data_profile: Creates a new Dataplex Data Profile scan template and triggers the run.
    • get_data_profile: Retrieves the final generated data profile results.
    • discover_metadata: Creates a new Dataplex Data Discovery scan template and triggers the run.
    • get_discovery_results: Retrieves the final generated data discovery results.
    • check_data_quality: Creates a new Dataplex Data Quality scan template and triggers the run.
    • get_data_quality_results: Retrieves the final generated data quality results.
    • get_operation: Retrieves the status of a Dataplex long-running operation.
    • get_run_status: Retrieves the execution status of the latest background job run.
  • Toolsets:
    • discovery: Metadata discovery and search toolset (search_entries, lookup_entry, search_aspect_types, lookup_context, search_dq_scans).
    • enrich: Metadata enrichment pipeline orchestration and execution toolset (search_entries, lookup_entry, lookup_context, generate_data_insights, get_data_insights, generate_data_profile, get_data_profile, discover_metadata, get_discovery_results, check_data_quality, get_data_quality_results, get_operation, get_run_status).