monojit18/luisbinderapp

AZRLUISServer

1. A set of REST services for Azure LUIS APIs.These Binder APIs can be called from both Mobile and Web applications using the exposed endpoints.
2. Dockerfile is included which would help containerize the service and also can be used seamlessly with Azure Container Registry or Docker Cloud or running locally. This would help in local testing and then hosting in Azure as Web API (or any other hosting services)
3. No need to send API subscription details as part of the request (although that option is open); these secured information can be in Azure Web API layer and service can read from process.env dictionary
4. Server host address is kept at 0.0.0.0 - so that it can be accesses from containerized hosting solutions like Docker Swarm

API Endpoints:

Default

URL - https://<host_server_details>
GET request-

Entity APIs

1. URL - https://<host_server_details>/luis/:versionId/entities/:entityId
   GET request-

2. URL - https://<host_server_details>/luis/:versionId/entities/create
   PUT request body-

    {
        "name": "DayOfWeek"
    }
   
   

3. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/update
   POST request body-

    {
        "name": "DayOfWeek"
    }
   
   

4. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/delete
   DELETE request-

5. URL - https://<host_server_details>/luis/:versionId/entities/composite/create
   PUT request body-

    {
       "name": "Reservation",
       "children": [ "Location::To", "datetime" ]
   }
   
   

6. URL - https://<host_server_details>/luis/:versionId/entities/composite/:entityId/update
   POST request body-

    {
       "name": "Reservation",
       "children": [ "Location::To" ]
       
   }
   
   

7. URL - https://<host_server_details>/luis/:versionId/entities/composite/:entityId/delete
   DELETE request-

8. URL - https://<host_server_details>/luis/:versionId/entities/list/create
   PUT request body-

    {
       "name": "States",
       "sublists": 
       [
         {
           "canonicalForm": "New York",
           "list": [ "NY", "New York" ]
         },
         {
           "canonicalForm": "Washington",
           "list": [ "Washington", "WA" ]
         },
         {
           "canonicalForm": "California",
           "list": [ "California", "CA", "Calif.", "Cal." ]
         }
       ]
    }
   
   

9. URL - https://<host_server_details>/luis/:versionId/entities/list/:entityId/update
   POST request body-

    {
       "name": "States",
       "subLists": [
         {
           "canonicalForm": "new york",
           "list": [
             "ny",
             "new york"
           ]
         },
         {
           "canonicalForm": "washington",
           "list": [
             "washington",
             "wa"
           ]
         },
         {
           "canonicalForm": "california",
           "list": [
             "california",
             "ca",
             "calif.",
             "cal."
           ]
         },
         {
           "canonicalForm": "Texas",
           "list": [
             "Texas",
             "TX"
           ]
         }
       ]
    }
   
   

10. URL - https://<host_server_details>/luis/:versionId/entities/list/:entityId/delete
    DELETE request-

11. URL - https://<host_server_details>/luis/:versionId/entities/hierarchial/create
    PUT request body-

   {
      "name" : "To"
   }
  

12. URL - https://<host_server_details>/luis/:versionId/entities/hierarchial/:entityId/update
    POST request body-

   {
      "name" : "Source"
   }
  

13. URL - https://<host_server_details>/luis/:versionId/entities/hierarchial/:entityId/delete
    DELETE request-

14. URL - https://<host_server_details>/luis/:versionId/entities/sublists/create
    PUT request body-

   {
      "canonicalForm": "BankName",
      "list": [
        "HSBC",
        "CitiBank"
      ]
   }
  

15. URL - https://<host_server_details>/luis/:versionId/entities/sublists/create
    PUT request body-

   {
      "canonicalForm": "BankName",
      "list": [
        "HSBC",
        "CitiBank"
      ]
   }
  

16. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/create
    PUT request body-

   {
      "name" : "datetime"
   }
  

17. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/create
    PUT request body-

   {
      "name" : "datetime"
   }
  

18. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/:childEntityId/update
    POST request body-

   {
      "name" : "datetime"
   }
  

19. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/:childEntityId/delete
    DELETE request-

20. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/hierarchial/create
    PUT request body-

   {
      "name" : "To"
   }
  

21. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/hierarchial/:childEntityId/update
    POST request body-

   {
      "name" : "Source"
   }
  

22. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/hierarchial/:childEntityId/delete
    DELETE request-

Intent APIs

1. URL - https://<host_server_details>/luis/:versionId/intents/:intentId
   GET request-

2. URL - https://<host_server_details>/luis/:versionId/intents/create
   PUT request body-

   {
      "name" : "intent1"
   }
  

3. URL - https://<host_server_details>/luis/:versionId/prebuiltIntents/create
   PUT request body-

   {
      "domainName": "Camera",
      "modelName": "CapturePhoto"
   }
  

Utterances APIs

1. URL - https://<host_server_details>/luis/:versionId/patterns
   GET request-

2. URL - https://<host_server_details>/luis/:versionId/intents/:intentId/patterns
   GET request-

3. URL - https://<host_server_details>/luis/:versionId/train
   GET request-

4. URL - https://<host_server_details>/luis/:versionId/examples
   GET request-

5. URL - https://<host_server_details>/luis/:versionId/labels/create
   PUT request body-

  [
    {
      "text": "Book me a flight from Cairo to Redmond next Thursday",
      "intentName": "BookFlight",
      "entityLabels":
      [
        {
          "entityName": "Location::From",
          "startCharIndex": 22,
          "endCharIndex": 26
        },
        {
          "entityName": "Location::To",
          "startCharIndex": 31,
          "endCharIndex": 37
        }
      ]
    },
    {
      "text": "What's the weather like in Seattle?",
      "intentName": "GetWeather",
      "entityLabels":
      [
        {
          "entityName": "Location",
          "startCharIndex": 27,
          "endCharIndex": 33
        }
      ]
    }
  ]
  

6. URL - https://<host_server_details>/luis/:versionId/labels/delete
   DELETE request-

7. URL - https://<host_server_details>/luis/:versionId/patterns/create
   PUT request body-

   [
      {
          "pattern": "Who's reporting to {Name}",
          "intent": "report to name"
      },
      {
          "pattern": "Who's {Name} reporting to?",
          "intent": "name report to"
      }
  ]
  

8. URL - https://<host_server_details>/luis/:versionId/patterns/update
   POST request body-

   [
      {
          "id": "16cfbc93-4065-445f-b06e-00cebdae11c4",
          "pattern": "Who's reporting to {Name}",
          "intent": "new intent"
      },
      {
          "id": "1d026f03-5942-4d0d-9153-1c01301e1429",
          "pattern": "Who's {Name} reporting to?",
          "intent": "new intent"
      }
  ]
  

9. URL - https://<host_server_details>/luis/:versionId/patterns/delete
   DELETE request-

10. URL - https://<host_server_details>/luis/:versionId/train
    POST request body-

   {
        "statusId": 9,
        "status": "Queued"
   }
    OR

   {
        "statusId": 2,
        "status": "UpToDate"
   }
  

Role APIs

1. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/roles/:roleId
   GET request-

2. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/roles/create
   PUT request body-

   {
        "name": "sample role"
   }
  

2. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/roles/update
   POST request body-

   {
        "name": "new role name"
   }
  

3. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/roles/delete
   DELETE request-

4. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/roles/create
   PUT request body-

   {
        "name": "sample role"
   }
  

5. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/roles/:roleId/update
   POST request body-

   {
        "name": "new role name"
   }
  

6. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/composite/roles/:roleId/delete
   DELETE request-

7. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/list/roles/create
   PUT request body-

   {
        "name": "sample role"
   }
  

8. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/list/roles/:roleId/update
   POST request body-

   {
        "name": "new role name"
   }
  

9. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/list/roles/:roleId/delete
   DELETE request-

10. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/hierarchial/roles/create
    PUT request body-

   {
        "name": "sample role"
   }
  

11. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/hierarchial/roles/:roleId/update
    POST request body-

   {
        "name": "new role name"
   }
  

12. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/hierarchial/roles/:roleId/delete
    DELETE request-

13. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/regex/roles/create
    PUT request body-

   {
        "name": "sample role"
   }
  

14. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/regex/roles/:roleId/update
    POST request body-

   {
        "name": "new role name"
   }
  

15. URL - https://<host_server_details>/luis/:versionId/entities/:entityId/regex/roles/:roleId/delete
    DELETE request-