Skip to content

Commit 7097330

Browse files
committed
introduce chatbot
1 parent 94ba635 commit 7097330

File tree

4 files changed

+42
-2
lines changed

4 files changed

+42
-2
lines changed

docs/Integration-Map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
`OrderB2B` is an `RowDictMapper` subclass that defines a `dict` structure, with the 2 conversion methods shown.
1010

11-
![overview](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/integration-service.jpg?raw=true)
1211

12+
![overview](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/integration-service.jpg?raw=true)
1313

1414
 
1515

docs/Integration-chatbot.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
**ChatBots** are extensions to team collaboration systems (Microsoft Teams, Slack, DIscord) that can interface to other systems, such as OpenAI Functions for data inquiry / update.
3+
4+
>For example, in large companies, users spend significant time in such systems to the point it becomes their central UI. So, enabling access to key corporate systems, with a Natural Language interface, is a natural way to simpify business.
5+
6+
This is to explore:
7+
8+
| Explore | Status |
9+
| ---------------- | ------ |
10+
| ChatBot to Slack | -- |
11+
| | |
12+
13+
A value prop might be summarized: *instantly expose legacy DBs to Natural Language from collaboration tools, including critical business logic and security, to simplify user discovery and operation.*
14+
15+
<br>
16+
17+
## Status: Technology Exploration
18+
19+
This is an initial experiment, without automation. Many substantive issues need to be addressed, including but not limited to security, update, etc.
20+
21+
We welcome participation in this exploration. Please contact us via [discord](https://discord.gg/HcGxbBsgRF).
22+
23+
This exploration is changing rapidly. For updates, replace `integration/mcp` from [integration/msp](https://github.com/ApiLogicServer/ApiLogicServer-src/tree/main/api_logic_server_cli/prototypes/nw_no_cust/integration/openai_plugin)
24+
25+
<br>
26+
27+
## Example
28+
29+
✨ Flow example: “Create order for ALFKI with 2 bottles of Chai”:
30+
1. User sends message in Slack/Teams
31+
2. Bot passes message to backend
32+
3. Backend sends message to GPT function-calling endpoint
33+
4. GPT returns function call:
34+
→ POST /Order { customer_id: "ALFKI", items: [{product_id: "CHAI", quantity: 2}] }
35+
5. Backend sends API request to your OpenAPI endpoint
36+
6. Backend replies in Slack:
37+
→ “✅ Created order #1024 for ALFKI with 2 items”
38+

docs/Sample-Integration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ The **Northwind API Logic Server** provides APIs *and logic* for both transactio
2424

2525
The **Shipping API Logic Server** listens on kafka, and processes the message.<br><br>
2626

27-
![overview](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/overview.jpg?raw=true)
27+
![overview](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/integration.png?raw=true)
28+
2829
&nbsp;
2930

3031
**Self-serve APIs, Shared Logic**

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ nav:
9494
- "Kafka Messaging": Integration-Kafka.md
9595
- "MCP Integration": Integration-MCP.md
9696
- "OpenAI Plugin Integration": Integration-OpenAI-Plugin.md
97+
- "ChatBot Integration": Integration-chatbot.md
9798
- IDE - Customize, Manage:
9899
- "Customize Using Your IDE": IDE-Customize.md
99100
- "Fixup - missing attributes": IDE-Fixup-Attrs.md

0 commit comments

Comments
 (0)