Skip to content

Commit

Permalink
docs: ✏️ migrate docs wip
Browse files Browse the repository at this point in the history
  • Loading branch information
gmpetrov committed Apr 8, 2024
1 parent add3761 commit 3dc87ce
Show file tree
Hide file tree
Showing 22 changed files with 150 additions and 1 deletion.
9 changes: 9 additions & 0 deletions apps/docs/agent/rate-limit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
You can set up a rate limit from your Agent global settings tab in order to limit the number of messages your users can send.

**This setting applies only to the following integration**

- Chatbubble Widget
- iFrame Widget
- Standalone Page Widget

![Xnapper-2023-09-07-10.38.04.png](/images/agent-rate-limit/Xnapper-2023-09-07-10.38.04.png)
Empty file.
Empty file.
42 changes: 42 additions & 0 deletions apps/docs/agent/tools/http-tool.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: HTTP Tool
---

The HTTP Tool is a highly powerful feature, enabling AI Agents to execute HTTP Requests seamlessly, allowing you to call any API during a conversation. (Under the hood it uses function calling [https://platform.openai.com/docs/guides/function-calling](https://platform.openai.com/docs/guides/function-calling))

![Xnapper-2024-01-12-10.30.52.png](/images/http-tool/Xnapper-2024-01-12-10.30.52.png)

This tool is integrated into the language model, which utilizes both the tool's name and its detailed description, along with predefined parameters, to determine the appropriate moments for activation.

Additionally, the model can be specifically instructed on when to employ the tool through directives included in its system prompt.

For instance, an exemplary description of the HTTP Tool might be:
**"Useful for retrieving random cat images."**

![Xnapper-2024-01-12-10.30.12.png](/images/http-tool/Xnapper-2024-01-12-10.30.12.png)

### Request Parameters

The HTTP Tool editor facilitates the creation of necessary variables for conducting the HTTP request.

It includes an option labeled “Provided By User,” which signals to the model that it should gather the required data directly from the ongoing conversation.

![Xnapper-2024-01-12-10.36.18.png](/images/http-tool/Xnapper-2024-01-12-10.36.18.png)

### **Streamlined Approval Process**

With the activation of the “Approval Required” feature, the AI Agent will await authorization from an administrator before proceeding with the request.

This function ensures a controlled and secure operation.

![Xnapper-2024-01-12-10.53.40.png](/images/http-tool/Xnapper-2024-01-12-10.53.40.png)

![Xnapper-2024-01-12-11.17.42.png](/images/http-tool/Xnapper-2024-01-12-11.17.42.png)

![Xnapper-2024-01-12-11.18.19.png](/images/http-tool/Xnapper-2024-01-12-11.18.19.png)

![Xnapper-2024-01-12-11.19.14.png](/images/http-tool/Xnapper-2024-01-12-11.19.14.png)

### **Workflows**

Moreover, the model is capable of executing multiple actions simultaneously and can integrate various tools to efficiently manage intricate workflows.
Empty file.
Empty file.
13 changes: 13 additions & 0 deletions apps/docs/agent/tools/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
You can enhance an Agent capabilities with Tools.

<CardGroup cols={1}>
<Card title="🧠 Datastore Tool" href="datastore-tool" />
<Card title="📄 Form Tool" href="form-tool" />
<Card title="🛜 HTTP Tool" href="http-tool" />
<Card title="🙋 Request Human Tool" href="request-human-tool" />
<Card title="✅ Mark as Resolved Tool" href="mark-as-resolved-tool" />
<Card
title="🎯 Lead Generation Tool (⚠️ deprecated)"
href="lead-generation-tool"
/>
</CardGroup>
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions apps/docs/integrations/channels/whatsapp.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
The WhatsApp integration let you connect an Agent to a WhatsApp Business Account.
Your Agent will reply to incoming messages based on its configuration.
If necessary you can manually intervene and handle conversations directly through the Inbox page

<Warning>
💡 Once you migrate a phone number to the WhatsApp Business Platform, you
cannot use that number on the WhatsApp Business App concurrently. Your number
must be used either on the Business Platform or on the Business App. [Migrate
an Existing WhatsApp Number to a Business
Account](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started/migrate-existing-whatsapp-number-to-a-business-account)
</Warning>

## **1. Create a Meta Business account**

1. Head over to **[https://business.facebook.com](https://business.facebook.com/)**
2. Create a new business account

<Warning>
💡 Be aware that Meta may initially limit access to your new business account.
If this happens, confirm your identity to continue.
</Warning>

## **[](https://docs.typebot.io/deploy/whatsapp/create-meta-app#2-create-a-meta-app)2. Create a Meta app**

1. Head over to **[https://developers.facebook.com/apps](https://developers.facebook.com/apps)**
2. Click on Create App
3. “What do you want your app to do?”, select **`Other`**.
4. Select **`Business`** type
5. Name your app and associate it with the business account you just created.
6. On the app page, look for **`WhatsApp`** product and enable it

You can then follow the instructions in the Deploy tab of your **Agent** to connect your Meta app to Chaindesk.

![Xnapper-2024-01-26-14.52.07.png](/images/whatsapp/Xnapper-2024-01-26-14.52.07.png)
13 changes: 13 additions & 0 deletions apps/docs/integrations/datasources/google-drive.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Integrate Google Drive with [Chaindesk.ai](http://chaindesk.ai/) to train AI agents using files or folders from your Drive.
Chaindesk syncs linked data automatically in order to keep your agent up-to-date.

<Note>
💡 Chaindesk use and transfer of information received from Google APIs to any
other app will adhere to [Google API Services User Data
Policy](https://developers.google.com/terms/api-services-user-data-policy#additional_requirements_for_specific_api_scopes),
including the Limited Use requirements.
</Note>

![Xnapper-2024-01-30-14.01.41.png](/images/google-drive/Xnapper-2024-01-30-14.01.41.png)

![Xnapper-2024-01-30-14.02.28.png](/images/google-drive/Xnapper-2024-01-30-14.02.28.png)
40 changes: 39 additions & 1 deletion apps/docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@
"icon": "table-list",
"url": "form"
},
{
"name": "Integrations",
"icon": "puzzle-piece",
"url": "integrations"
},
{
"name": "Widgets",
"icon": "html5",
Expand All @@ -64,7 +69,22 @@
},
{
"group": "Agent",
"pages": ["agent/get-started"]
"pages": [
"agent/get-started",
"agent/rate-limit",
{
"group": "Tools",
"pages": [
"agent/tools/quick-start",
"agent/tools/datastore-tool",
"agent/tools/http-tool",
"agent/tools/form-tool",
"agent/tools/request-human-tool",
"agent/tools/mark-as-resolved-tool",
"agent/tools/lead-generation-tool"
]
}
]
},
{
"group": "Datastore",
Expand All @@ -74,6 +94,19 @@
"group": "Form",
"pages": ["form/get-started"]
},
{
"group": "Integration",
"pages": [
{
"group": "Train With",
"pages": ["integrations/datasources/google-drive"]
},
{
"group": "Install On",
"pages": ["integrations/channels/whatsapp"]
}
]
},
{
"group": "chaindesk API",
"pages": ["api-reference/authentication"]
Expand Down Expand Up @@ -132,5 +165,10 @@
"twitter": "https://twitter.com/georges_petrov",
"discord": "https://discord.gg/FSWKj49ckX",
"github": "https://github.com/gmpetrov/databerry"
},
"feedback": {
"thumbsRating": true,
"suggestEdit": true,
"raiseIssue": true
}
}

0 comments on commit 3dc87ce

Please sign in to comment.