getSchema
Retrieve the RushDB graph schema as structured JSON to inspect labels, properties, relationships, and vector indexes, enabling targeted queries and deeper property drill-down.
Instructions
Returns the same graph schema as getSchemaMarkdown but as structured JSON. Each item has: label (string), count (number), properties (array with id, name, type, optional isArray, recordsCount (number of records that carry this property), min/max for numbers/datetimes, values[] for strings/booleans, and an optional vectorIndexes array), and relationships (array with label, type, direction: in|out, count, and optional edge properties). vectorIndexes is non-empty when one or more embedding indexes exist for that property; each entry has: id, sourceType (managed|external), similarityFunction (cosine|euclidean), dimensions (number), status (pending|indexing|ready|error), modelKey. A non-empty vectorIndexes means the property is queryable with aiSemanticSearch. Use this when you need property id values to pass to propertyValues for deeper drill-down. For initial schema orientation, getSchemaMarkdown uses fewer tokens. Pass force: true to bypass the 1-hour schema cache and force a fresh recalculation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Pass true to bypass the 1-hour schema cache and force a fresh recalculation. | |
| labels | No | Optional: scope schema to specific labels only. Leave empty to get all labels. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schema | Yes |