find_relevant_entities
Read-onlyIdempotent
Rank business entities matching a natural-language description of a business object, keeping the agent in domain terms instead of raw table names.
Instructions
Use this when the user describes a business object (e.g. 'our customers', 'revenue data', 'product catalog'). Returns ranked entities — domain-named bindings to physical tables — so the agent stays in business terms. Use find_relevant_tables instead when no entities are curated. Common compositions: chain to describe_entity for one entity's full shape; chain to resolve_join to wire two entities together; chain to get_metric to compute a validated aggregation.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Natural-language description of the business object the user is asking about (e.g. 'customers', 'revenue', 'product catalog'). Embedded with the same model used to index column descriptions, then ranked by cosine similarity against the columns of each entity's bound table. Per-entity score is the MAX across columns. | |
| limit | No | Maximum number of ranked entity hits to return. Default 10. Use a small value (3-5) for narrow exploratory queries; use 10-20 when surveying an unfamiliar semantic layer. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| data | No | ||
| error | No | ||
| confidence | No | ||
| provenance | No | ||
| follow_up_hints | No | ||
| degradation_reason | No | ||
| charter_version | No | 1.2 |