Preparing search index...
The search index is not available
Toolkit
Toolkit
models/interfaces/aiServices/textToSQLRequest
TextToSQLRequest
Interface TextToSQLRequest
Hierarchy
TextToSQLRequest
Index
Properties
data
Source
Schemas?
input
model?
model
Configuration?
parameters?
prompt
Template?
Properties
Optional
data
Source
Schemas
data
Source
Schemas
?:
DataSourceSchema
[]
input
input
:
string
Optional
model
model
?:
string
Optional
model
Configuration
model
Configuration
?:
Record
<
string
,
object
>
Optional
parameters
parameters
?:
Record
<
string
,
string
>
Optional
prompt
Template
prompt
Template
?:
PromptTemplate
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
packages
toolkit
src
classes
url-search-params
index.ts
URLSearchParams
index.ts
URLSearchParams
clients
ai-client
index.ts
AIClient
appDB-client
collections
index.ts
CollectionsClient
constants
index.ts
CREATE_COLLECTION
EXPORT_COLLECTIONS
LIST_COLLECTIONS
ADD_DOCUMENT
BULK_ADD_DOCUMENTS
BULK_DELETE_DOCUMENTS
BULK_EDIT_DOCUMENTS
DELETE_COLLECTION
EDIT_COLLECTION
EDIT_DOCUMENT
PARTIAL_UPDATE
SEARCH_DOCUMENTS
documents
index.ts
DocumentsClient
index.ts
AppDBClient
codeengine-client
index.ts
CodeEngineClient
domo-client
index.ts
DomoClient
file-client
index.ts
FileClient
default
group-client
index.ts
GroupClient
identity-client
index.ts
IdentityClient
sql-client
index.ts
SqlClient
transport-client
index.ts
TransportClientClass
TransportClient
user-client
index.ts
UserClient
workflow-client
index.ts
WorkflowClient
index.ts
AIClient
AppDBClient
CodeEngineClient
DomoClient
FileClient
GroupClient
IdentityClient
SqlClient
TransportClient
TransportClientClass
UserClient
WorkflowClient
errors
index.ts
InvalidParamError
invalid-param-error.ts
InvalidParamError
helpers
fetch-helper
index.ts
buildURL
fetchWithLog
filter-helpers
index.ts
DomoEvents
querystring
querystringify
type-guard
index.ts
isArray
isAvatarSizes
isBoolean
isDataFormatTypes
isDataPoint
isDate
isExpandType
isExpandTypeArray
isFile
isFormData
isFunction
isGenericDataRow
isGenericDataRowArray
isInEnum
isNumber
isPromise
isRequest
isRequestHeaders
isRequestMethods
isResponseType
isString
isUndefined
util-helper
index.ts
UtilsHelper
index.ts
DomoEvents
UtilsHelper
isArray
isAvatarSizes
isBoolean
isDataFormatTypes
isDataPoint
isDate
isExpandType
isExpandTypeArray
isFile
isFormData
isFunction
isGenericDataRow
isGenericDataRowArray
isInEnum
isNumber
isPromise
isRequest
isRequestHeaders
isRequestMethods
isResponseType
isString
isUndefined
querystring
querystringify
models
enums
appDB
collection-permission.ts
AppDBCollectionPermission
column-type.ts
AppDBColumnType
document-filter-entity.ts
AppDBDocumentFilterEntity
document-filter-method.ts
AppDBDocumentFilterMethod
common
data-format-types.ts
DataFormatTypes
endpoints.ts
EndpointsV1
EndpointsV2
getServiceEndpointsV1
file-details-expand.ts
ExpandType
filter-data-type.ts
FilterDataType
filter-operand.ts
FilterOperand
request-methods.ts
RequestMethods
response-types.ts
ResponseType
rest
avatar-sizes.ts
AvatarSizes
interfaces
aiServices
chatMessage.ts
ChatAIRole
ChatMessage
column.ts
Column
dataSourceSchema.ts
DataSourceSchema
promptTemplate.ts
PromptTemplate
textAiResponse.ts
TextAIResponse
textGenerationRequest.ts
TextGenerationRequest
textSummarizationRequest.ts
SeparatorType
SummarizationOutputStyle
ChunkingConfiguration
SizeBoundary
TextSummarizationRequest
textToBeastModeRequest.ts
TextToBeastModeRequest
textToSQLRequest.ts
TextToSQLRequest
appDB
appDB-collection.ts
AppDBCollection
AppDBCollectionDefinition
AppDBCollectionDefinitionRequest
appDB-document.ts
AppDBDocument
appDB-error.ts
AppDBError
isAppDBError
bulk-delete.ts
AppDBBulkDeleteResponse
bulk-update.ts
AppDBBulkUpdateResponse
collection-filter.ts
AppDBCollectionFilter
collection-schema.ts
AppDBCollectionSchema
document-filter-condition.ts
AppDBDocumentFilterCondition
updated-document.ts
AppDBUpdatedDocument
codeengine
execution-result.ts
CodeEngineExecutionResult
function-input.ts
CodeEngineFunctionInput
package.ts
CodeEnginePackage
version.ts
CodeEngineVersion
CodeEngineVersionShort
common
dataset.ts
DataSet
GenericDataRow
MetaData
DataPoint
DataRow
filters.ts
FilterEventData
Filters
request.ts
Request
RequestHeaders
RequestWithBlobResponse
response.ts
ResponseWithBody
ResponseWithoutBody
Response
search-params.ts
SearchParams
sql-response.ts
SqlResponse
data-files
data-file.ts
DataFile
data-file-id.ts
DataFileId
metadata.ts
Metadata
permissions.ts
Permissions
revision.ts
Revision
rest
group.ts
Group
identity.ts
Identity
user.ts
User
UserDetail
workflow
instance.ts
WorkflowInstance
model.ts
WorkflowModel
WorkflowModelDetails
WorkflowModelWithPermissions
variable.ts
WorkflowVariable
types
common
filter-aggregation-function.ts
FilterAggregationFunction
sql-clause-result.ts
SQLClauseResult
sql-predicate-block.ts
SQLPredicateBlock
index.ts
AppDBBulkDeleteResponse
AppDBBulkUpdateResponse
AppDBCollection
AppDBCollectionDefinition
AppDBCollectionDefinitionRequest
AppDBCollectionFilter
AppDBCollectionPermission
AppDBCollectionSchema
AppDBColumnType
AppDBDocument
AppDBDocumentFilterCondition
AppDBDocumentFilterEntity
AppDBDocumentFilterMethod
AppDBError
AppDBUpdatedDocument
AvatarSizes
ChunkingConfiguration
CodeEngineExecutionResult
CodeEngineFunctionInput
CodeEnginePackage
CodeEngineVersion
CodeEngineVersionShort
Column
DataFile
DataFileId
DataFormatTypes
DataPoint
DataRow
DataSet
DataSourceSchema
EndpointsV1
EndpointsV2
ExpandType
FilterAggregationFunction
FilterDataType
FilterEventData
FilterOperand
Filters
GenericDataRow
Group
Identity
MetaData
Metadata
Permissions
PromptTemplate
Request
RequestHeaders
RequestMethods
RequestWithBlobResponse
Response
ResponseType
ResponseWithBody
ResponseWithoutBody
Revision
SQLClauseResult
SQLPredicateBlock
SearchParams
SeparatorType
SizeBoundary
SqlResponse
SummarizationOutputStyle
TextAIResponse
TextGenerationRequest
TextSummarizationRequest
TextToBeastModeRequest
TextToSQLRequest
User
UserDetail
WorkflowInstance
WorkflowModel
WorkflowModelDetails
WorkflowModelWithPermissions
WorkflowVariable
getServiceEndpointsV1
isAppDBError
index.ts
AIClient
AppDBBulkDeleteResponse
AppDBBulkUpdateResponse
AppDBClient
AppDBCollection
AppDBCollectionDefinition
AppDBCollectionDefinitionRequest
AppDBCollectionFilter
AppDBCollectionPermission
AppDBCollectionSchema
AppDBColumnType
AppDBDocument
AppDBDocumentFilterCondition
AppDBDocumentFilterEntity
AppDBDocumentFilterMethod
AppDBError
AppDBUpdatedDocument
AvatarSizes
ChunkingConfiguration
CodeEngineClient
CodeEngineExecutionResult
CodeEngineFunctionInput
CodeEnginePackage
CodeEngineVersion
CodeEngineVersionShort
Column
DataFile
DataFileId
DataFormatTypes
DataPoint
DataRow
DataSet
DataSourceSchema
DomoClient
DomoEvents
EndpointsV1
EndpointsV2
ExpandType
FileClient
FilterAggregationFunction
FilterDataType
FilterEventData
FilterOperand
Filters
GenericDataRow
Group
GroupClient
Identity
IdentityClient
InvalidParamError
MetaData
Metadata
Permissions
PromptTemplate
Request
RequestHeaders
RequestMethods
RequestWithBlobResponse
Response
ResponseType
ResponseWithBody
ResponseWithoutBody
Revision
SQLClauseResult
SQLPredicateBlock
SearchParams
SeparatorType
SizeBoundary
SqlClient
SqlResponse
SummarizationOutputStyle
TextAIResponse
TextGenerationRequest
TextSummarizationRequest
TextToBeastModeRequest
TextToSQLRequest
TransportClient
TransportClientClass
URLSearchParams
User
UserClient
UserDetail
UtilsHelper
WorkflowClient
WorkflowInstance
WorkflowModel
WorkflowModelDetails
WorkflowModelWithPermissions
WorkflowVariable
getServiceEndpointsV1
isAppDBError
isArray
isAvatarSizes
isBoolean
isDataFormatTypes
isDataPoint
isDate
isExpandType
isExpandTypeArray
isFile
isFormData
isFunction
isGenericDataRow
isGenericDataRowArray
isInEnum
isNumber
isPromise
isRequest
isRequestHeaders
isRequestMethods
isResponseType
isString
isUndefined
querystring
querystringify
Generated using
TypeDoc