Skip to main content

Ai

info

The FormAi object must be defined in the first screen of the form. Every other ai objects will be ignored. It can also be defined inside a Field. This field will be filled by Ai whenever the Ai button is clicked.

Define form ai behavior.

JSON Example​

{
"config": {...},
"admin_context": [...],
"input": false,
"floating": false,
"questions": [...],
"form_questions": [...],
"planning_questions": [...],
}

Elements of FormAi​

config​

  • Type: Config?.
  • Description: The gobal configuration of the Ai.

Example:

"config": {...}

admin_context​

  • Type: Array<String>.
  • Description: The context given to the ai for every questions you ask.

Example:

"admin_context": [
"You are an AI assistant that helps people find information about sidely.",
"The second context"
]

input​

  • Type: boolean.
  • Description: Whenever the input is enabled or not.
  • Default: false

Example:

"input": true

floating​

  • Type: boolean.
  • Description: If on a field, a floating button will be displayed on the bottom with quick Ai actions. For now, it only works with Image and Text field.
  • Default: false

Example:

"floating": true

questions​

  • Type: Array<Question>.
  • Description: The questions the user can ask inside the form. The lua can be used.

Example:

"question": [...]

form_questions​

  • Type: Array<Question>.
  • Description: The questions the user can ask outside the form. The lua cannot be used.

Example:

"form_questions": [...]

planning_questions​

  • Type: Array<Question>.
  • Description: The questions the user can ask on in planning. The lua cannot be used.

Example:

"planning_questions": [...]