QueryAssistantAssistance is a union datatype for either a successful assistance result, or an error. Based on this, use either the QueryAssistantSuccess or QueryAssistantError datatypes and their parameters — or both. Below are tables for each:

Table: QueryAssistantSuccess

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 2, 2024
diagnostics[QueryAssistantDiagnostic]yes PreviewThe diagnostics of the query assistant. See QueryAssistantDiagnostic.
resultstringyes PreviewThe results of the diagnostics.

Table: QueryAssistantError

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 2, 2024
errorstringyes PreviewThe error from the query assistant.