Skip to content

Initial First Documentation #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Binary file added .DS_Store
Binary file not shown.
Binary file added favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 41 additions & 49 deletions favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions favicon_old.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions guides/AI-agent.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

This guide will walk you through the process of configuring your AI voice agent in Ordibl to ensure it represents your brand effectively when handling calls.

### Accessing the AI Agent Settings

- Log in to your [Ordibl Dashboard](https://app.ordibl.ai)
- Locate and click on the **"AI Agent"** option in the main navigation menu
- This will open the AI agent configuration interface
<Frame caption="Ordibl AI Agent">
<img src="/images/ai-agent-dashboard.png" />
</Frame>

### Configuring Your AI Agent (Using Pre-Trained Models)

- Click on the "Create New Agent" button or select an existing agent to edit
- Select Template from the Agent Personality Type
- Choose between Inbound or Outbound call types
- Select the Industry and AI agent type (e.g., Customer Service, Sales, etc.)
- Choose the AI agent's name (this will be how the agent introduces itself)
- Save the agent name and model type
- Define your agent's voice type (select from available voice options)
- Select the knowledge base for the agent (this is where the AI will pull information from)
- Save the AI voice agent configuration
<Frame caption="Ordibl AI Agent Custom">
<img src="/images/ai-agent-template.png" />
</Frame>

### Configuring your AI agent (Using Custom Models)
- Click on the "Create New Agent" button or select an existing agent to edit
- Select "Custom" from the Agent Personality Type
- Choose between Inbound or Outbound call types
- Choose the AI agent's name (this will be how the agent introduces itself)
- Create the first message for the agent (this is the first thing the agent will say when it answers a call)
- Create the System prompt (this is the instruction that will guide the AI agent's behavior)
- Select the Provider and Model to use for the agent
- Optional: You can you use your own API key for the provider
- Set other parameters like temperature and max tokens
- Save the AI voice agent configuration
<Frame caption="Ordibl AI Agent Custom">
<img src="/images/ai-agent-custom.png" />
</Frame>



## Important Tips

- Create a persona that aligns with your brand voice and values
- Provide clear guidelines for how the agent should handle different scenarios
- Test your agent with sample conversations before deploying
- Update your agent's knowledge regularly through the Knowledge Base feature
- Monitor your agent's performance and refine settings as needed

A well-configured AI agent will provide consistent, professional customer service that represents your brand effectively while handling routine inquiries efficiently.
52 changes: 52 additions & 0 deletions guides/batch-call.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
This guide will walk you through the process of setting up an outbound call agent in Ordibl to schedule and manage batch calls to customers or prospects.


### Accessing the Batch Calls Feature

- Log in to your [Ordibl Dashboard](https://app.ordibl.ai)
- Navigate to the **"Batch Calls"** section in the main menu
- This will open the outbound calling management interface
<Frame caption="Ordibl Batch Calls">
<img src="/images/batch-call.png" />
</Frame>

Note: The batch call requires two previously additional set up:
- **AI Agent**: You need to have an Outbound AI agent configured with a voice profile and conversation script.
- **Phone Number**: You need to have a phone number assigned to your AI agent for making outbound calls.

### Creating a New Outbound Call Agent

4. Click on the "Create New Batch Call" button
5. Enter a descriptive name for your outbound call agent/campaign
6. Select the AI voice profile you wish to use for these calls

<Frame caption="Ordibl Batch Calls">
<img src="/images/batch-call.png" />
</Frame>

You can use either a single number or upload a csv file with multiple numbers. The CSV file should contain a list of phone numbers you want to call.
<Frame caption="Single Batch Number">
<img src="/images/batch-call-single.png" />
</Frame>
<br />
<Frame caption="Multiple Batch Numbers">
<img src="/images/batch-call-multiple.png" />
</Frame>

### Configuring Call Parameters

- Define your target audience by uploading a contact list or selecting from existing contacts
- Format your contact data appropriately (ensure phone numbers are in the correct format)
Note: A template for the contact list is available for download


## Important Tips

- Test your outbound call agent with a small sample before large-scale deployment
- Ensure compliance with local calling regulations and hours
- Monitor initial calls to verify script effectiveness and adjust as needed
- Include clear company identification in your scripts
- Provide an opt-out mechanism for recipients
- Review call analytics to optimize performance

Your outbound call agent will now be able to automatically place calls according to your configured parameters, handling routine outreach while collecting valuable data from interactions.
Loading