Skip to content

Commit 2cc470d

Browse files
kafkaskafkas
committed
Port docs from proficientai/docs
1 parent 7b98395 commit 2cc470d

18 files changed

+607
-7
lines changed

Diff for: ‎fern/api/docs/concepts.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: "Concepts"
3+
---
4+
5+
Here are the core concepts that you need to be familiar with when using Proficient AI. You will find most
6+
of them to be intuitive.
7+
8+
## Project
9+
10+
Represents a company or product. A project has members (managers, developers etc.) and users.
11+
12+
<Note>
13+
Projects are currently only accessible from the dashboard e.g. you can't
14+
create a project using the API.
15+
</Note>
16+
17+
## Agent
18+
19+
Represents an AI entity that exists to serve a project. Agents are currently powered with multiple
20+
large language models (LLMs) and can be configured to your project's requirements.
21+
22+
## Agent Configuration
23+
24+
Represents the configuration of an agent. Each agent has its own configuration that is managed by project admins.
25+
26+
## User
27+
28+
Represents a human user that belongs to a given project.
29+
30+
### External ID
31+
32+
When a user is created, Proficient assigns them a unique ID that starts with `u_`. This is the ID that uniquely
33+
identifies the user within Proficient.
34+
35+
However, it is almost surely the case that the project already has another unique identifier for that user (i.e.
36+
before joining Proficient AI). This is what we call the user's **external ID**.
37+
38+
## Interaction
39+
40+
Represents an interaction that takes place between a given user and agent. An interaction can be thought of as
41+
a conversation.
42+
43+
## Message
44+
45+
Represents a message that is part of a given interaction. An interaction can have multiple messages created
46+
by agents or users.

Diff for: ‎fern/api/docs/create-agent.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "Creating my first agent"
3+
---
4+
5+
1. **Enable billing**
6+
7+
Before proceeding to create an agent, you need to enable billing for the project. Billing is enabled by
8+
creating a usage-based Stripe subscription in [Project Settings](https://proficientai.com/project-settings).
9+
Once you enable billing, your project will start incurring charges based on your usage. See
10+
[Pricing](https://proficientai.com/pricing) for more details.
11+
12+
2. **Create an agent**
13+
14+
To create an AI agent, visit the [Agents](https://proficientai.com/agents) page in the admin dashboard and
15+
click the _Create an agent_ button. Select the model that you want to use and name your agent.
16+
17+
3. **Configure the agent**
18+
19+
To update your agent's configuration, visit the Agent Configuration page. You can set your own values for
20+
system message, initial turn, provider-specific options like `temperature` and `frequency_penalty` etc.
21+
22+
When configuring the agent, you have access to dynamic API resources like `user` and `agent`. You can use the
23+
[Handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template format to refer to these resources
24+
in your configuration:
25+
26+
```txt System Message
27+
You are an AI assistant that works for Acme Inc. Your name is {{agent.display_name}}. Your main task is to
28+
help {{user.first_name}} with any questions they may have.
29+
```
30+
31+
4. **Activate the agent**
32+
33+
Once you've configured your agent, you can then activate it so that it starts responding to user requests.
34+
35+
<Tip>
36+
Activation is a mechanism that allows you to enable or disable your agent.
37+
For example, if you want to immediately stop your project from incurring
38+
charges you can deactivate all your agents using the dashboard or the
39+
[Admin API](/admin-api).
40+
</Tip>
41+
42+
5. **All done!**
43+
44+
You can now test your agent in the [Playground](https://proficientai.com/playground) with a test user or
45+
start integrating it with your application using our official [SDKs](/sdks).

Diff for: ‎fern/api/docs/docs.yml

+21-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
navigation:
2-
- section: Getting Started
2+
- section: Welcome
33
contents:
44
- page: Introduction
5-
path: ./sections/getting-started/intro.md
6-
- page: Quickstart
7-
path: ./sections/getting-started/quickstart.md
8-
- section: Advanced
5+
path: ./intro.md
6+
- page: Why Proficient AI?
7+
path: ./why-proficient.md
8+
- page: Concepts
9+
path: ./concepts.md
10+
- section: Getting Started
11+
contents:
12+
- page: Installation
13+
path: ./installation.md
14+
- page: Creating my first agent
15+
path: ./create-agent.md
16+
- section: SDKs
917
contents:
10-
- page: HMAC Authentication
11-
path: ./sections/advanced/hmac.md
18+
- page: Overview
19+
path: ./overview.md
20+
- page: React SDK
21+
path: ./react.md
22+
- page: JavaScript Client SDK
23+
path: ./js-client.md
24+
- page: Node.js Admin SDK
25+
path: ./node-admin.md
1226
- api: Client API Reference
1327
audiences:
1428
- client

Diff for: ‎fern/api/docs/images/architecture.png

597 KB
Loading

Diff for: ‎fern/api/docs/images/bg.png

1.02 MB
Loading

Diff for: ‎fern/api/docs/images/conversion.png

2.12 MB
Loading

Diff for: ‎fern/api/docs/images/interactionview-code.png

140 KB
Loading

Diff for: ‎fern/api/docs/images/interactionview-frame.png

350 KB
Loading

Diff for: ‎fern/api/docs/images/light.png

1.63 MB
Loading

Diff for: ‎fern/api/docs/images/playground.png

1.7 MB
Loading

Diff for: ‎fern/api/docs/images/search.png

1.23 MB
Loading

Diff for: ‎fern/api/docs/installation.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Installation"
3+
---
4+
5+
Depending on your project's requirements, you may need to use one or more of our SDKs. Visit the
6+
[SDKs](/sdks) section to see the official libraries and installation steps.
7+
8+
<Card title="SDKs" icon="puzzle-piece" href="/sdks">
9+
View all the available Proficient AI SDKs.
10+
</Card>

Diff for: ‎fern/api/docs/intro.md

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
title: Introduction
3+
description: Add a conversational AI agent to your app in 3 minutes
4+
---
5+
6+
## What is Proficient AI?
7+
8+
Proficient AI is a platform that enables developers to add conversational AI agents to their apps
9+
in minutes. Our interaction APIs and SDKs coupled with our powerful web dashboard are the simplest
10+
way teams can add and operate <Tooltip tip="Large Language Model">LLM</Tooltip>-powered agents for their end-user applications.
11+
12+
<Frame type="simple">
13+
<img
14+
src="/images/interactionview-code.png"
15+
style={{
16+
width: "100%",
17+
maxWidth: 600,
18+
marginLeft: "auto",
19+
marginRight: "auto",
20+
}}
21+
/>
22+
</Frame>
23+
24+
## How it works
25+
26+
Here is a simple overview of the steps to get started:
27+
28+
1. Go to the [web dashboard](https://proficientai.com) and create an agent with the specified model
29+
2. Customize the agent to your application's needs by editing its configuration
30+
3. Add the prebuilt UI component to your app to connect it to the agent (3-5 lines of code)
31+
32+
Done! The agent appears in a chat window with a persistent conversation history and your users
33+
are ready to interact with it, once you deploy.
34+
35+
<Frame type="simple">
36+
<img
37+
src="/images/interactionview-frame.png"
38+
style={{ width: "100%", padding: 10 }}
39+
/>
40+
</Frame>
41+
42+
<br />
43+
44+
<Tip>
45+
For more advanced features, you need to use the [API](#proficient-apis), which
46+
lets you connect your agents to all parts of your application.
47+
</Tip>
48+
49+
## Demo
50+
51+
Here is a short demo video (2 min, 28 sec) that shows how you can add an AI agent to your React application.
52+
53+
<Note>
54+
This demo is from 7 Apr 2023. We've built a lot features since then and will
55+
add a new demo soon.
56+
</Note>
57+
58+
<iframe
59+
width="100%"
60+
height="400"
61+
src="https://www.youtube.com/embed/tPFDtd_C5vI"
62+
title="Proficent AI Demo"
63+
frameborder="0"
64+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
65+
allowfullscreen
66+
></iframe>
67+
68+
## What can I build with it?
69+
70+
Proficient agents are abstract virtual robots that can be used for various purposes. In your
71+
application, you can present your agents in many forms such as:
72+
73+
- chatbots that know your business and respond to customer queries
74+
- virtual tutors that teach your users a variety of subjects
75+
- AI assistants that engage with your product's users
76+
77+
Basically, all types of applications that require an abstract AI entity to interact with their users can use a Proficient AI agent.
78+
79+
<Note>
80+
Reach out to us via [Discord](https://discord.gg/DVbwTM8erb) or
81+
[email](mailto:[email protected]) if you're not sure whether you can use a
82+
Proficient agent for your project. We'd be more than happy to help you.
83+
</Note>
84+
85+
## Architecture
86+
87+
We can visualize the architecture of a typical application powered by Proficient AI with the following diagram.
88+
89+
<Frame type="simple" caption="System architecture visualization">
90+
<img src="/images/architecture.png" />
91+
</Frame>
92+
93+
### Key takeaways
94+
95+
There are a few key things to note here:
96+
97+
<CardGroup cols={2}>
98+
99+
<Card title="Agents live in the Proficient cloud" icon="cloud" iconType="solid">
100+
Agents are virtual entitites that you operate through the Proficient AI
101+
platform.
102+
</Card>
103+
104+
<Card
105+
title="Proficient connects to all parts of your application"
106+
icon="rectangle-terminal"
107+
iconType="solid"
108+
>
109+
Although simple use cases may not even need a custom backend.
110+
</Card>
111+
112+
<Card
113+
title="Agents can connect to various LLMs"
114+
icon="microchip"
115+
iconType="solid"
116+
>
117+
Proficient is connected to many different models so you don't have to write
118+
your own integration.
119+
</Card>
120+
121+
<Card
122+
title="Proficient stores interactions and user data"
123+
icon="database"
124+
iconType="solid"
125+
>
126+
You can access your data at any time using the API or admin dashboard.
127+
</Card>
128+
129+
</CardGroup>
130+
131+
## Proficient APIs
132+
133+
All operations on the Proficient platform are divided into two categories each of which is represented by
134+
a standalone API.
135+
136+
### 1. Client API
137+
138+
The [Client API](/client-api) is designed for client applications that are allowed to access only
139+
a subset of all available operations. For example, agents can't be configured from a client application. On
140+
the other hand, an authenticated user sending a message to an agent can be implemented with the Client API.
141+
142+
<Card title="Client API Reference" icon="rectangle-terminal" href="/client-api">
143+
View all Client API endpoints and operations that you can carry out from your
144+
client applications.
145+
</Card>
146+
147+
### 2. Admin API
148+
149+
The [Admin API](/admin-api) is used by backend applications. With admin-level
150+
access, you can use this API to create, configure and delete agents, monitor interactions, update user data
151+
and more.
152+
153+
<Card title="Admin API Reference" icon="rectangle-terminal" href="/client-api">
154+
View all Admin API endpoints and operations that you can carry out from
155+
privileged environments.
156+
</Card>

Diff for: ‎fern/api/docs/logo.png

5.95 KB
Loading

Diff for: ‎fern/api/docs/node-admin.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Node.js Admin SDK"
3+
icon: "node"
4+
---
5+
6+
The Node.js Admin SDK allows you to consume the [Admin API](/admin-api) in your Node.js & TypeScript/JavaScript
7+
application. This is a well-typed and well-documented library that makes it easy for developers to connect
8+
to Proficient AI services from backend applications.
9+
10+
## Installation
11+
12+
You can install the Node.js Admin SDK via [npm](https://www.npmjs.com/package/@proficient/admin) or [Yarn](https://yarnpkg.com/package/@proficient/admin).
13+
14+
<CodeGroup>
15+
{ddd}
16+
```bash npm
17+
npm i -E @proficient/admin
18+
```
19+
20+
```bash yarn
21+
yarn add -E @proficient/admin
22+
```
23+
24+
</CodeGroup>
25+
26+
<br />
27+
28+
<Snippet file="exact-version.mdx" />

Diff for: ‎fern/api/docs/overview.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: "Overview"
3+
---
4+
5+
We provide developers with a number of SDKs/API wrappers to help simplify the integration
6+
process. Our Client and Admin API wrappers are generated with [Fern](https://buildwithfern.com),
7+
which allows us to automatically synchronize these libraries with our systems and the source of
8+
truth.
9+
10+
<Tip>
11+
Many more SDKs are coming soon. Reach out to us via
12+
[Discord](https://discord.gg/DVbwTM8erb) or
13+
[email](mailto:[email protected]) if you'd like to use Proficient but need
14+
an SDK for another language or platform.
15+
</Tip>
16+
17+
<Card title="React" icon="react" href="/sdks/react">
18+
The React SDK for client applications using React.
19+
</Card>
20+
21+
<Card title="JavaScript" icon="js" href="/sdks/js-client">
22+
The Client SDK for TypeScript/JavaScript applications.
23+
</Card>
24+
25+
<Card title="Node.js" icon="node" href="/sdks/node-admin">
26+
The Admin SDK for Node.js backends.
27+
</Card>

0 commit comments

Comments
 (0)