Skip to content

Commit 51cf3cf

Browse files
authored
Update README.md
1 parent 7c8e05d commit 51cf3cf

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,37 @@ With Parlant, they've been able to quickly integrate feedback from customer serv
6969
- [Meta Llama 3](https://www.llama.com/) (via [Together AI](https://www.together.ai/) or [Cerebras](https://cerebras.ai/))
7070
- [Anthropic](https://www.anthropic.com/api) (also via [AWS Bedrock](https://aws.amazon.com/bedrock/))
7171

72+
## Getting started
73+
```bash
74+
$ pip install parlant
75+
$ parlant-server
76+
$ # Open http://localhost:8000 and play
77+
```
78+
79+
Install client SDKs:
80+
```bash
81+
$ # For Python clients:
82+
$ pip install parlant-client
83+
$ # For TypeScript clients:
84+
$ npm install parlant-client
85+
```
86+
87+
To start building with Parlant, visit our [documentation portal](https://parlant.io/docs/quickstart/introduction).
88+
89+
Need help? Send us a message on [Discord](https://discord.gg/duxWqxKk6J). We're happy to answer questions and help you get up and running!
90+
7291
## Usage Example
92+
Adding a guideline for an agent—for example, to ask a counter-question to get more info when a customer asks a question:
93+
```bash
94+
parlant guideline create \
95+
--agent-id CUSTOMER_SUCCESS_AGENT_ID
96+
--condition "a free-tier customer is asking how to use our product" \
97+
--action "first seek to understsand what they're trying to achieve"
98+
```
99+
73100
In Parlant, Customer-Agent interaction happens asynchronously, to enable more natural customer interactions, rather than forcing a strict and unnatural request-reply mode.
74101

75-
Here's a basic example (using the TypeScript client SDK):
102+
Here's a basic example of a simple client (using the TypeScript client SDK):
76103

77104
```typescript
78105
import { ParlantClient } from 'parlant-client';
@@ -107,25 +134,6 @@ const { trace } = await client.sessions.inspectEvent(
107134
);
108135
```
109136

110-
## Getting started
111-
```bash
112-
$ pip install parlant
113-
$ parlant-server
114-
$ # Open http://localhost:8000 and play
115-
```
116-
117-
Install client SDKs:
118-
```bash
119-
$ # For Python clients:
120-
$ pip install parlant-client
121-
$ # For TypeScript clients:
122-
$ npm install parlant-client
123-
```
124-
125-
To start building with Parlant, visit our [documentation portal](https://parlant.io/docs/quickstart/introduction).
126-
127-
Need help? Send us a message on [Discord](https://discord.gg/duxWqxKk6J). We're happy to answer questions and help you get up and running!
128-
129137
## Contributing
130138
We're currently finalizing our Contributor License Agreement (CLA). Full contribution guidelines will be available soon!
131139

0 commit comments

Comments
 (0)