Intent Injection Protocol

Protocollo WS che permette a sistemi esterni di integrare nuovi intenti dinamici con Calybron.

Il protocollo permette, tramite sottoscrizione, di iniettare intenti per uno scope preciso e di ricevere le varie interazioni che Calybron interecetta per gli intenti relativi al medesimo DIM.

L'autenticazione avviene tramite token il quale determina lo scope degli intenti per la massima sicurezza. Il token è generato dallo Smart Center ed è univoco per ogni DIM.

Verifica IIP

Quando il DIM Manager riceve una nuova connessione, richiede alle API Core la verifica del token, recuperando in caso affermativo:

• Lista degli Intent.

• Informazione sul DIM di riferimento.

Sta al DIM Manager controllare in caso che il DIM sia abilitato.

---

Libreria

Introduzione

Il protocollo Intent Injection Protocol (o IIP) è una libreria che standardizza la comunicazione tra un Dim e il Dim Manager.

È dotato sia di un'implementazione server, per il Dim Manager, sia di un'implementazione client, per i Dim.

Server Side

Installazione

import { IIPServer } from '@holocron/intent-injection-protocol';

// Inizializza con le configurazioni, un winston logger, la funzione da eseguire in caso di Presentation, Response e Error
socket = new IIPServer(configuration, logger, presentationCallback, responseCallback, errorCallback);

Questa libreria richiede una configurazione specifica per poter verificare i token di ciascun DIM.

{
    "iip": {
        "port": 1234,
        "verification_webhook": "http://{{domain}}/api/v1/dim/verify/token/"
    }
}

Metodi disponibili

Invia una domanda

socket.ask(intent, payload);

Client Side

Installazione

import { IIPClient } from '@holocron/intent-injection-protocol';

// Inizializza con le configurazioni, un winston logger
socket = new IIPClient(configuration, logger, askCallback);

Questa libreria richiede una configurazione esterna per la connessione all'implementazione del server. Nel file config/[organization].js è necessario aggiungere qualcosa di simile a questo.

{
    "iip": {
        "port": 3000,
        "domain": "{{dominio delle api}}",
        "token": "{{token del dim}}",
        "dim_uuid": "{{id del dim}}",
    }
}

Il DIM richiede anche un file di “presentazione”, ovvero un file in cui sono descritti i suoi intenti. Deve essere un file localizzato in /docs/presentation.json, con il seguente formato:

NB Questa gestione verrà presto rivista per poter agire maggiormente dalla dashboard.

{
  "intentArray": [
    {
      "organization": "{{slug organizzazione come su smart center}}",
      "intentSlug": "{{slug intento}}",
      "scope": "{{slug scope}}",
      "description": "{{descrizione dell'intento}}",
      "is_tool": false|true,
      "context": "{{contesto che verrà usato dal Broadcast Manager per rispondere}} ",
      "entities": {
        //Lasciare vuoto se is_tool = false
        //Altrimenti Schema JSON
        "topic": {
          "type": "string",
          "required": true,
          "description": "Un argomento con cui generare la filastrocca. Correggi eventuali errori di battitura e addolcisci linguaggio scurrile in maniera divertente."
        },
        "required": ["topic"]

      },
    },
        ...
  ],
}