Describing a parameter

{
   "type" : "interaction",
   
   // Data of the interaction
   
   "parameters": [
      {
         "archetype" : "int",
         "id_parameter" : "sucre",
         
         "descriptor" : {
            "fr-fr" : ["sucre"],
            "en-us" : ["sugar"] 
         },
         
         "verbose" : {
            "fr-fr" : "nombre de sucres",
            "en-us" : "sugar amount"
         }
         
      }
   ]
}
Field Description
archetype Identifier of the wanted archetype.
id_parameter Identifier of the parameter. It is found during the function call.
descriptor Keywords describing the parameter.
verbose Nominal sentence describing the parameter.

Optional

It is possible to state that a value is optional.

   {
      "archetype" : "int",
      // ...
      "optional" : true
   }
   

If the service does not find the required information for a parameter, it will still be possible to call the interaction.
In the interaction call, the parameter's value will be null.

Multiple

It is possible to search for several values for one only parameter.

   {
      "archetype" : "date",
      // ...
      "multiple" : true
   }
   

The Service will send all the values found for this type.

Combined use optional/multiple

Number of elements sought regarding the configuration :
multiple : false multiple : true
optional : false 1 1 à N
optional : true 0 à 1 0 à N

API connection address :

TCP : golem.ai:3003
Web Socket : golem.ai:3004/ws
Web Socket Sécurisé (WSS) : golem.ai:3005/ws
HTTP : golem.ai:3004/http
HTTPS : golem.ai:3005/http