Workbench

Overview

The Workbench is the web-based administration interface to the Ontotext Semantic Services. Its layout consists of two main areas. The navigation area on the left-hand side of the screen contains a menu with its main functionalities: Schemas, Playground, Monitoring, GraphQL, Search, and Documentation. The work area shows the tasks associated with the selected functionality.

_images/platform_workbench.png

The Workbench provides a search user interface where you can execute various types of search queries against the configured Semantic Search.

The search field offers auto-suggest. Select or hit Enter on the preferred suggestion, and Enter/click Search to see the results.

_images/workbench-search-autosuggest.png

You can navigate through search result pages, and also change the page size via the drop-down list on the top right.

Set up License

In order to be able to use the Semantic Search Workbench, you first need to set up a license for the Semantic Objects. See how to do it here.

Upload Schema

To perform searches against the data, you first need to upload a schema in the Semantic Objects. See how to do it here.

GraphQL

The Workbench integrates the GraphiQL in-browser tool for writing, validating, and testing GraphQL queries. In it, you can:

  • perform GraphQL queries and mutations for the SOML schema currently active in the Semantic Search or the Semantic Objects
  • switch between available GraphQL endpoints: Semantic Search or Semantic Objects
  • see the query response or errors
  • see previously executed queries
  • explore the active GraphQL SDL (schema definition language)

Type your query in the left side of the screen, and you will see intelligent typeaheads aware of the current GraphQL type schema and live syntax and validation errors highlighted within the text.

The GraphiQL Explorer plugin, which is integrated in the tool, enables you to construct correct GraphQL queries and mutations faster and more easily. Clicking the Explorer button will open a panel on the left where you can explore and construct queries/mutations.

See more about it in the official GraphiQL Explorer documentation, as well as in this OneGraph blog post on the subject.

_images/workbench-search-graphql.png

Search Types