Connection


HTTP
golem.ai:3004/http

HTTPS
golem.ai:3005/http

Web Socket
golem.ai:3004/ws

Web Socket Sécurisé (WSS)
golem.ai:3005/ws

TCP
golem.ai:3003

Context

Structure

Context structure
It can be automatically generated from the console.
Note : A Golem.ai server can be liked to several contexts.

Significant content

A context notably contains :
- An ID
- An interaction list


Exemple

context
   {
    "type": "context",
    "id": "trainall",
    "interactions": [
        {
            "type": "interaction",
            "id_interaction": "simple",
            "verbose": {
                "en": "book a train ticket",
                "fr": "réserver un billet de train"
            },
            "descriptor": {
                "en": [
                    "go",
                    "travel",
                    "train"
                ],
                "fr": [
                    "aller",
                    "voyager",
                    "train",
                    "billet"
                ]
            },
            "parameters": [
               // Parameters
            ]
        },
        {
            "type": "interaction",
            "id_interaction": "return",
            "verbose": {
                "en": "book a return train ticket",
                "fr": "réserver un billet de train aller-retour"
            },
            "descriptor": {
                "en": [
                    "train",
                    "return"
                ],
                "fr": [
                    "train",
                    "aller-retour",
                    "retour",
                    "revenir"
                ]
            },
            "parameters": [
               // Parameters
            ]
        }
    ]
}

Complete Example

context
   {
    "type": "context",
    "id": "trainall",
    "interactions": [
        {
            "type": "interaction",
            "id_interaction": "simple",
            "verbose": {
                "en": "book a train ticket",
                "fr": "réserver un billet de train"
            },
            "descriptor": {
                "en": [
                    "go",
                    "travel",
                    "train"
                ],
                "fr": [
                    "aller",
                    "voyager",
                    "train",
                    "billet"
                ]
            },
            "parameters": [
                {
                    "archetype": "city_france",
                    "id_parameter": "departure_town",
                    "verbose": {
                        "en": "the town departure",
                        "fr": "la ville départ"
                    },
                    "descriptor": {
                        "en": [
                            "departure"
                        ],
                        "fr": [
                            "départ",
                            "depart"
                        ]
                    },
                    "descriptor_right": {
                        "en": [
                            "from"
                        ],
                        "fr": [
                            "de",
                            "depuis"
                        ]
                    },
                    "descriptor_left": {
                        "en": [],
                        "fr": []
                    },
                    "optional": true
                },
                {
                    "archetype": "city_france",
                    "id_parameter": "arrival_town",
                    "verbose": {
                        "en": "the arrival town",
                        "fr": "la ville d'arrivée"
                    },
                    "descriptor": {
                        "en": [
                            "arrival"
                        ],
                        "fr": [
                            "arrivée",
                            "arrivé"
                        ]
                    },
                    "descriptor_left": {
                        "en": [
                            "to"
                        ],
                        "fr": [
                            "jusqu'à",
                            "arrivé"
                        ]
                    },
                    "optional": false
                },
                {
                    "archetype": "date_time",
                    "id_parameter": "departure_date",
                    "verbose": {
                        "en": "the departure date",
                        "fr": "la date de départ"
                    },
                    "descriptor": {
                        "en": [
                            "on the"
                        ],
                        "fr": [
                            "jusqu'à",
                            "arrivé",
                            "pour",
                            "aller"
                        ]
                    },
                    "optional": true
                }
            ]
        },
        {
            "type": "interaction",
            "id_interaction": "return",
            "verbose": {
                "en": "book a return train ticket",
                "fr": "réserver un billet de train aller-retour"
            },
            "descriptor": {
                "en": [
                    "train",
                    "return"
                ],
                "fr": [
                    "train",
                    "aller-retour",
                    "retour",
                    "revenir"
                ]
            },
            "parameters": [
                {
                    "archetype": "city_france",
                    "id_parameter": "departure_town",
                    "verbose": {
                        "en": "the town departure",
                        "fr": "la ville départ"
                    },
                    "descriptor": {
                        "en": [
                            "departure"
                        ],
                        "fr": [
                            "départ"
                        ]
                    },
                    "descriptor_left": {
                        "en": [
                            "from"
                        ],
                        "fr": [
                            "de",
                            "depuis",
                            "retour"
                        ]
                    },
                    "descriptor_right": {
                        "en": [],
                        "fr": []
                    },
                    "optional": true
                },
                {
                    "archetype": "city_france",
                    "id_parameter": "arrival_town",
                    "verbose": {
                        "en": "the arrival town",
                        "fr": "la ville d'arrivée"
                    },
                    "descriptor": {
                        "en": [
                            "arrival"
                        ],
                        "fr": [
                            "arrivée",
                            "arrivé"
                        ]
                    },
                    "descriptor_left": {
                        "en": [
                            "to"
                        ],
                        "fr": [
                            "jusqu'à",
                            "aller"
                        ]
                    },
                    "optional": false
                },
                {
                    "archetype": "date_time",
                    "id_parameter": "departure_date",
                    "verbose": {
                        "en": "the departure date",
                        "fr": "la date de départ"
                    },
                    "descriptor": {
                        "en": [
                            "on the"
                        ],
                        "fr": [
                            "aller"
                        ]
                    },
                    "optional": true
                },
                {
                    "archetype": "date_time",
                    "id_parameter": "arrival_date",
                    "verbose": {
                        "en": "the return date",
                        "fr": "la date de retour"
                    },
                    "descriptor": {
                        "en": [
                            "on the"
                        ],
                        "fr": [
                            "retour"
                        ]
                    },
                    "optional": true
                }
            ]
        }
    ]
}

Do you have a question that has not been answered here ?
tech@golem.ai