Retrievers
JSON Document Search
Tool that allows searching within JSON documents using text search or pandas query expressions.
Category: Retrievers · Plans: Trial, Starter, Pro, Premium, Enterprise · Type: JSONDocument
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| JSON File URL | Text | No | (empty) | The JSON file to load from URL. |
| JSON Document ID | Text | No | (empty) | The ID of the JSON document to search in. |
| JSON Array Key | Text | No | (empty) | The key in the JSON object that contains the array of objects to search. |
| Search Query | Text | No | {input} | The search term to look for in the JSON document. |
| Search Column | Text | No | (empty) | Optional column name to restrict search to a specific column. |
| Query Expression | Text | No | (empty) | Pandas query expression (e.g., ‘Price > 100 and Category == “Electronics”’). If provided, this will be used instead of the simple text search. |
| Search Columns | Text | No | (empty) | Specific columns to search in (comma-separated). If empty, all columns will be searched. |
| Max Results | Number | Yes | 5000 | Maximum number of results to return. |
| Case Sensitive | Yes/No | No | Off | Whether the search should be case sensitive. |
| Sort By | Text | No | (empty) | Column(s) to sort by. For multiple columns, separate with commas. Add a minus sign (-) before column name for descending order. Example: ‘Price,-Date’ |
| Group By | Text | No | (empty) | Column(s) to group by. For multiple columns, separate with commas. Must be used with Aggregate Function. |
| Aggregate Function | Text | No | (empty) | Aggregation function(s) when using Group By. Format: ‘column:function’. Supported: sum, mean, min, max, count, median. Example: ‘Price:mean,Quantity:sum’ |
| Pivot Table | Text | No | (empty) | Create a pivot table. Format: ‘index,columns,values[:agg_func]’. Example: ‘Category,Region,Price:mean’ |
| Add Calculated Column | Text | No | (empty) | Add a calculated column. Format: ’new_column_name:expression’. Example: ‘Discount:Price*0.1’ |
| String Filter | Text | No | (empty) | Advanced string filtering with regex. Format: ‘column:pattern[:case_sensitive]’. Example: ‘Description:premium|luxury:false’ |
| Cache TTL | Text | No | 2 weeks | Cache the content of the JSON file for defined amount of time. Options: No cache, 5 minutes, 30 minutes, 1 hour, 12 hours, 1 day, 1 week, 2 weeks, 1 month, 3 months, 6 months, 1 year |
Outputs#
| Output | Type |
|---|---|
| Row Count | Any |
| Column Count | Any |
| Columns | Any |
| Matched Rows | Any |
| Search Results | Any |
| Operations Applied | Any |
Use as an agent tool#
Tool name: jsondocument
Tool that allows searching within JSON documents using text search or pandas query expressions.