Hyper HBI Service


The Hyper HBI Service supports WAII natural-language querying. It runs a dedicated Hyper process that executes the AI-generated SQL produced by the Waii service and calls HBI (VizQL Data Service) through Arrow Flight UDFs. It is separate from the standard Hyper process that serves extract queries.

The Hyper HBI Service is available if you have a Server+ license and the WAII feature is enabled. It is not available when FIPS mode is enabled, because the Waii service is not FIPS compatible.

Important: This service requires a specific configuration of PostgreSQL (the repository) and cannot be installed or enabled if this is missing. For more information, see About Tableau Server and the pgvector extension in PostgreSQL.

Process

HyperHBI Service (hyperhbi)

Status Status of the Hyper HBI Service process is visible on the Status Page and from the TSM command line using the tsm status -v command. For more information, see View Server Process Status
Logging Logs generated by the Tableau Statistical Service process are located in /var/opt/tableau/tableau_server/data/tabsvc/logs/hyperhbi. Log files are prefixed hyperhbi_0. For more information, see Tableau Server Logs and Log File Locations

Impact if the Hyper HBI Service fails

If the Hyper HBI service fails, the TSM service manager restarts it automatically after 300 seconds. While Hyper HBI is down, WAII queries cannot be executed. Standard Hyper and extract queries are unaffected because they use a separate process.

Topology and Configuration

  • By default Hyper HBI is installed on the initial node.

  • Hyper HBI is limited to a single instance in a Tableau Server installation and cannot be made highly available at this time.

  • We recommend you run the WAII service and VizQL Data Service on the same node as Hyper HBI, matching the default single-node topology.

  • No topology constraint prevents any service from sharing a node with Hyper HBI.

  • Hyper HBI is paired one-to-one with the WAII service, and TSM allows at most one instance. When the WAII feature is enabled (the default) and the server has a Server+ license, TSM requires one instance. The license adds it to the topology automatically. When an instance of Hyper HBI is added, you need to apply the configuration change, which restarts the server and starts the Hyper HBI service. When licensed, you can move Hyper HBI to a different node, but you cannot remove it entirely from your server installation.

High Availability

The default Hyper HBI is a single instance, running on the initial node. Hyper HBI is limited to a single instance so cannot be made highly available at this time.

In multi-node clusters, we recommend you move Hyper HBI, the WAII service, and HBI off the initial node and onto a dedicated node to isolate AI load.

Only one Hyper HBI process runs, so its failure stops WAII query execution until it is restarted. Requests are not rerouted to another instance. Other Server functions are unaffected.

Performance and Scale Recommendations

Hyper HBI can be CPU and RAM intensive. We recommend you monitor Tableau Server and adjust your deployment as necessary by isolating Hyper HBI on a separate node or adding server resources.

Because you are limited to a single instance of Hyper HBI, you cannot add additional instances to scale across nodes.

Back to top
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!