catalog_run_adhoc_analysis
Submit an ad-hoc analysis job to profile a catalog table, computing column statistics, data dictionary, and data-quality metrics. Optionally enable NLP for semantic enrichment of privacy and keyword signals.
Instructions
Submit an ad-hoc analysis (profiling) job for a table in the catalog.
Profiles the table — computing the data dictionary, column statistics, and
data-quality metrics that catalog_download_table_profile returns. The job
runs asynchronously and may take a while; poll catalog_get_adhoc_analysis
with the returned job id until the profile is ready.
The three NLP job parameters are enabled by default — they drive the
semantic enrichment that populates an asset's informationPrivacy,
nlpTerms, nlpTags, and mostImportantFields (the privacy and
keyword signals the catalog is most useful for). Leave them on unless you
only need a plain column profile and want the job to finish faster.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | A name for the analysis job. | |
| provider | No | Job provider (default 'TABLE-BOT'). | TABLE-BOT |
| description | No | Optional description for the job. | |
| resource_uri | Yes | Source URI of the table to analyze (the ``resource_uri`` from a catalog_search hit, e.g. '/dataTables/dataSources/cas~fs~.../tables/MYTABLE'). | |
| resource_type | No | Catalog entity type of the resource. Defaults to 'CASMEMTable' when the URI is a CAS table (contains 'cas~fs~'); pass it explicitly for other asset types. | |
| analyze_sentiment | No | Score sentiment on text columns (default True). | |
| identify_language | No | Detect each text column's language (default True). | |
| get_nlp_semantic_id | No | Derive semantic types / privacy classification (informationPrivacy, nlpTerms, nlpTags) (default True). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||