Technology

Documentation

Technology

Guide of the Golem.ai console

Here you will find all the essential information on the operation of the console from the oldest version to the most recent.

Activating


An interaction can be activated or deactivated.
If it is disabled, it is totally ignored by the Service.

Utility

Using the activation/deactivation system, we can send all the interactions when the software is launched, then activate/deactivate the interactions depending on the context.
This way, we maintain light communication with the service as the software is being used.

Some examples :

Windows, tabs, panels

Many softwares are functioning with several windows. When the user has access to a window, its specific functions can be activated.

Dialog, validation

During the validation process (yes/no or save/cancel) we can chose to activate only the interaction waiting for the user's answer.

Tip:
An interaction waiting for a user feedback countains an unique archetype parameter "enumeration", with a possible value for each possible answer.

Process in several steps

During a several steps process, a purchase for example, each step only leads access to the concerned interactions.

Activation packages



enable_interactionTarget -> Service
   {
       "type" : "enable_interaction",
       "id_interaction" : "coffee",
   }
Field Description
id_interaction Identifier of the interaction to activate

Confirmation

confirm_enable_interactionService -> Target
   {
       "type" : "confirm_enable_interaction",
       "id_interaction" : "coffee",
       "id_session" : "session_174"
   }

Deactivation package


disable_interactionTarget -> Service
   {
       "type" : "disable_interaction",
       "id_interaction" : "coffee",
   }
Field Description
id_interaction Identifier of the interaction to disable

Confirmation

confirm_disable_interactionService -> Target
   {
       "type" : "confirm_disable_interaction",
       "id_interaction" : "coffee",
       "id_session" : "session_174"
   }

Activating several interactions


enable_interaction_arrayTarget -> Service
   {
       "type" : "enable_interaction_array",
       "id_interactions" : [
          "coffee",
          "tea"
      ]
   }
Field Description
id_interactions Identifiers of the interactions to activate

Confirmation

confirm_enable_interaction_arrayService -> Target
   {
       "type" : "confirm_enable_interaction_array",
       "id_interaction" : "coffee",
       "id_session" : "session_174"
   }

Deactivating several interactions


disable_interaction_arrayTarget -> Service
   {
       "type" : "disable_interaction_array",
       "id_interactions" : [
          "coffee",
          "tea"
      ]
   }
Field Description
id_interactions Identifier of the interactions to diasable

Confirmation

confirm_disable_interaction_arrayService -> Target
   {
       "type" : "confirm_disable_interaction_array",
       "id_interaction" : "coffee",
       "id_session" : "session_174"
   }

Activating all but some interactions


Activates all interactions, and deactivates the specified ones.


enable_interaction_arrayTarget -> Service
   {
      "type" : "enable_all_but",
      "id_interactions" : [
          "coffee",
          "tea"
      ]
   }
Field Description
id_interactions Identifiers of the only interactions to disable

Confirmation

confirm_enable_interaction_arrayService -> Target
   {
       "type" : "confirm_enable_but_all",
       "id_interactions" : [
          "coffee",
          "tea"
       ],
       "id_session" : "session_174"
   }

Deactivating all but some interactions


Deactivating all interactions, and activating the specified ones.


disable_interaction_arrayTarget -> Service
   {
      "type" : "disable_all_but",
      "id_interactions" : [
         "coffee",
         "tea"
      ]
   }
Field Description
id_interactions Identified of the only interactions to activate

Confirmation

confirm_disable_interaction_arrayService -> Target
   {
      "type" : "confirm_disable_all_but",
      "id_interactions" : [
         "coffee",
         "tea"
      ],
      "id_session" : "session_174"
   }

Adresses de connexion à l'API :

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