JSON Document Search
Search and extract data from JSON files in your flows using text or query-based searches with the JSON Document Search component.
Component description
How the JSON Document Search component works
The JSON Document Search component is a versatile tool designed to search and extract information from JSON documents within your AI workflow. It supports both traditional text-based searches and advanced pandas query expressions, enabling efficient querying of structured data stored in JSON format.
What Does This Component Do?
This component enables users to:
- Search through JSON documents, whether sourced from internal repositories or external URLs.
- Specify search criteria, such as case sensitivity, target columns, and result limits.
- Integrate search operations directly into AI process workflows, facilitating data-driven automation and analysis.
It is especially useful when you need to filter, query, or locate specific data points within complex JSON structures, making it a valuable asset in data preprocessing, validation, and information retrieval tasks.
Inputs
There is no input handle for this component.
Output
- Tool: The output of this component is a search tool that can be utilized by agents or in downstream workflow steps to retrieve relevant JSON data as per the configured search parameters.
Settings
| Option | Description | Default/Example |
|---|---|---|
| Cache TTL | Determines how long to cache the JSON file content. Options range from “No cache” to “1 year”. | 2 weeks |
| Case Sensitive | Whether the search distinguishes between uppercase and lowercase characters. | False |
| JSON Array Key | Specifies the key holding the array of objects to search. Leave empty if the root is already array. | (empty) |
| JSON Document ID | ID of the internal JSON document to use (if applicable). | (empty) |
| JSON File URL | URL to an external JSON file, used if not selecting from internal documents. | (empty) |
| Max Results | Maximum number of search results to return. | 5000 |
| Search Columns | Comma-separated list of columns to search in. Searches all columns if left empty. | (empty) |
| Tool Name | Custom name for this tool, for easier reference. | (empty) |
| Tool Description | Description to help agents or users understand the tool’s purpose. | (empty) |
| Verbose | Enables verbose output for debugging or detailed logs. | False |
How to Use This Component
- Select Source: Choose to load the JSON document from an internal source (via Document ID) or from an external URL.
- Configure Search: Define if the search is case sensitive, and specify columns if needed.
- Set Result Limit: Adjust the maximum number of results to fit your use case.
- Customize Tool: Optionally name and describe the tool for easier integration into agent workflows.
Why Use This Component?
- Automates Data Extraction: Quickly locate and extract relevant information from large or complex JSON files.
- Flexible Integration: Works with both internal and external JSON data sources.
- Customizable Search: Tailor searches with advanced options, such as limiting results, filtering columns, and controlling case sensitivity.
- Efficient Workflow: Caching reduces load times and redundant network requests for frequently accessed documents.
This component is ideal for any AI workflow requiring robust, flexible, and efficient access to structured JSON data, whether for analytics, data enrichment, or as part of a larger decision-making process.
Frequently asked questions
- What does the JSON Document Search component do?
It allows you to search within JSON files using plain text or advanced query expressions, making it easy to extract relevant information from structured data inside your workflows.
- Can I use data from both internal and external JSON sources?
Yes, you can connect to internal JSON documents or fetch data from external URLs, making it flexible for various data sources.
- Is it possible to limit the number of search results?
Absolutely. You can set the maximum number of results to return, helping you control the output and optimize performance.
- Can I specify which fields to search in?
Yes, you can define specific columns or fields to focus the search. If you leave it empty, the search will cover all fields in the JSON data.
- Does it support case-sensitive searches?
You can choose to make your searches case-sensitive or not, giving you flexibility based on your data needs.
Try JSON Document Search
Integrate JSON data into your workflows with the JSON Document Search component—search, filter, and extract information easily.