Search Catalog Tool
Search Catalog Tool
Section titled “Search Catalog Tool”This tool searches the Alation Data Catalog for objects and assets — tables, schemas, columns, articles, glossary terms, and more. It is the primary discovery tool behind the Catalog Search agent.
When to use it
Section titled “When to use it”Add this tool to an agent that needs to find catalog objects from a natural language query. Combine it with Get Search Filter Fields and Get Search Filter Values to narrow results with filters.
Parameters
Section titled “Parameters”| Parameter | Required | Type | Suggested scope | What it does |
|---|---|---|---|---|
search_term | Yes | string | Agent determined | The text to search for. |
object_types | No | list of strings | Agent determined | Restrict results to types such as table, column, schema, article, bi_field, glossary_term. |
filters | No | list of objects | Fixed or Agent determined | Filter on custom fields. Use the same format as the aggregated context signature search_filters.fields structure. |
limit | No | integer (default 20, max 100) | Fixed | Maximum number of results. |
ranges | No | list of date ranges | Agent determined | Limit results to a date range. |
starred | No | boolean | User input | Only objects the user has starred. |
watching | No | boolean | User input | Only objects the user is watching. |
recent | No | boolean | User input | Only recently accessed objects. |
domain_ids | No | list of strings | Fixed or User input | Scope the search to specific domains. |
Example usage
Section titled “Example usage”{ "search_term": "Agriculture", "object_types": ["table"], "limit": 20}