NlpQueryExportData

The query export object used to specify how to extract nlp query results.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

exportOptions

Export Options and switches

Y

ExportOptions

exportType

Result format type using enumeration of export format types

Y

ApiResponseFormat

model

The name of the model used as data source for the NLP query

Y

string

nlpSentence

The sentence for the NLP to run as query

Y

string

databaseId

The id of the database used as data source for the NLP query

Y

string

serverId

The id of the server used as data source for the NLP query

Y

string

*Required elements are only used for API parameters

Usages
  • /API2/query/extractNlpQueryResult
  • /API3/analytics/extractNlpQueryResult