Application Builder Query API Reference Guide

The Watson Explorer Application Builder query API is a Ruby domain-specific language that you use to search and navigate the Application Builder entity model. You use the query API when you create endpoints and widgets, particularly custom widgets.

Note: In addition to all the information that is suggested in code fields for the query API methods (as shown in the following figure), this reference guide includes examples. Other methods, such as the methods that are used to traverse refinements (facets), are described in Application Builder Query API Overview.
Figure 1. Screen capture that shows how query API methods are suggested in code fields
This screen capture shows a custom widget called top5wordcount with a display name of Top authors by word count. In the View field, which contains ERB code that includes query API methods, the cursor is located after a period. The location of the cursor enables the code suggestion feature, which shows a list of query API methods that are valid at that location. A method from the list is selected, which opens another small widow. That small window shows a description for the method that is selected.