Skip to content

Commit ffdc5a2

Browse files
Finalize quickstart
1 parent 0d98ec1 commit ffdc5a2

File tree

5 files changed

+75
-58
lines changed

5 files changed

+75
-58
lines changed

docs/automation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import Thumbnail from "@site/src/components/Thumbnail";
2121
**Automations** allow you to transform one-time conversations into reliable, repeatable business processes. Once you've
2222
built and tested a workflow in the PromptQL Playground, you can deploy it as an API endpoint that can be called
2323
programmatically or integrated into your existing systems. That means services like Zapier, Slack, or even your internal
24-
systems can trigger the automation whenever it’s neededno coding required.
24+
systems can trigger the automation whenever it’s needed; no coding required.
2525

2626
This is ideal for any repetitive task that benefits from AI-powered insights, like:
2727

docs/how-to-talk-to-promptql.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,7 @@ The best way to get started is to ask something simple but real. Start with a me
8585
analysis you've done manually before. From there, PromptQL will learn your expectations, surface useful patterns, and
8686
help you turn those insights into reliable, repeatable workflows.
8787

88-
We recommend picking up with [our overview of PromptQL's capabilities](/capabilities.mdx) but, if you're eager, jump in
89-
to one of these use cases:
88+
Jump into one of these use cases:
9089

9190
- [Making decisions](/decision-making.mdx)
9291
- [Automating tasks](/automation.mdx)

docs/quickstart.mdx

Lines changed: 72 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,34 @@ keywords:
88
- getting started
99
- guide
1010
sidebar_class_name: quickstart-icon
11+
toc_max_heading_level: 4
1112
---
1213

1314
import Thumbnail from "@site/src/components/Thumbnail";
1415

1516
# Quickstart with PromptQL
1617

18+
## Introduction
19+
1720
This guide is designed to give you a high-level overview of PromptQL and how you can use it to make better decisions
18-
about your business and automate tasksall without any coding knowledge required.
21+
about your business and automate tasks; all without any coding knowledge required.
1922

2023
:::info Prerequisites
2124

2225
Before continuing, you'll need a [Hasura Cloud account](https://cloud.hasura.io/signup/new_user).
2326

2427
If you have your own project, you can apply the information below to it. Otherwise, we have a
25-
[collection of sandboxes](/index.mdx#demos) which allow you to try PromptQL and get a feel for the experience.
28+
[collection of sandboxes](/index.mdx#demos) which allow you to try PromptQL and get a feel for the experience. Below,
29+
we'll use the `sandbox-gtm` example.
30+
31+
If you're looking to build a new project from scratch, check out
32+
[these guides](/how-to-build-with-promptql/overview.mdx).
2633

2734
:::
2835

29-
## Open your project
36+
## Guide
37+
38+
### Open your project
3039

3140
Each PromptQL project can be accessed via a unique URL. You can access all your projects
3241
[from the PromptQL Console](https://promptql.console.hasura.io/).
@@ -42,58 +51,29 @@ ask questions about your data and create automations.
4251

4352
<Thumbnail src="/img/get-started/pql-playground.png" alt="The PromptQL Playground." width="1000px" />
4453

45-
## Talk to your data
54+
### Talk to your data
4655

4756
Primarily, you'll interact with PromptQL in one of two ways: either by asking questions, or creating automations.
4857

49-
### Ask a complex question
50-
51-
Using [the `sandbox-gtm` project](https://promptql.console.hasura.io/public/sandbox-gtm/playground), we're going to ask
52-
the following question:
53-
54-
```plaintext
55-
Which enterprise deals are at risk of slipping this quarter based on engagement patterns?
56-
```
57-
58-
If you're using your own project, ask a question. Otherwise, [click here](#) to be dropped into the playground directly
59-
with the question pre-loaded!
60-
61-
<details>
62-
<summary>
63-
Why is this complex?
64-
</summary>
65-
66-
This is complex because it requires:
67-
68-
1. Defining "enterprise deals" - Could be based on:
69-
70-
- Account tier/type
71-
- Deal size
72-
- Number of users/usage metrics
73-
- Industry/vertical
74-
75-
2. Determining "risk of slipping" by analyzing:
58+
#### Ask a complex question
7659

77-
- Sales engagement (calls, tasks, events)
78-
- Buyer engagement signals (6sense scores, successful touches)
79-
- Deal velocity compared to similar won deals
80-
- Current stage vs time left in quarter
81-
- Historical patterns of similar deals that slipped
60+
Using the `sandbox-gtm` project, we're going to ask the following question:
8261

83-
3. Understanding "engagement patterns" through:
62+
> _Which enterprise deals are at risk of slipping this quarter based on engagement patterns?_
8463
85-
- Call transcripts and topics discussed
86-
- Email sequence responses
87-
- Product usage metrics
88-
- Multiple stakeholder involvement
89-
- Comparison to successful deal patterns
64+
While this question seems simple, it's complex because it requires defining what qualifies as an enterprise deal,
65+
identifying signals that indicate a deal is at risk—such as low engagement or delayed progress—and analyzing various
66+
engagement patterns, including sales activities, buyer signals, and product usage, all in comparison to historical and
67+
successful deal benchmarks.
9068

91-
</details>
69+
If you're using your own project, start by asking a similarly strategic question relevant to your data. Otherwise,
70+
[click here](https://promptql.console.hasura.io/share/05437507-6b31-4037-a302-0dbcec5de2ae) to be dropped into a thread
71+
replay.
9272

93-
#### Query plan
73+
##### Query plan
9474

95-
PromptQL will respond with a **query plan**. This is a step-by-step breakdown in plain language of how it will process
96-
your request, including any data retrieval, filtering, or AI operations it will perform.
75+
When you ask a question, PromptQL will respond with a **query plan**. This is a step-by-step breakdown in plain language
76+
of how it will process your request, including any data retrieval, filtering, or AI operations it will perform.
9777

9878
<Thumbnail
9979
src="/img/get-started/pql-query-plan.png"
@@ -104,6 +84,9 @@ your request, including any data retrieval, filtering, or AI operations it will
10484
It helps make PromptQL's approach transparent by explaining what it's going to do before it does it, including any
10585
assumptions it's making about the data or process.
10686

87+
Take a look at the query plan generated for your question and see how PromptQL takes a complex question and breaks it
88+
down into a series of steps, just like a human would.
89+
10790
:::tip Query plans are modifiable
10891

10992
You can edit a query plan by clicking the pencil next to a query plan.
@@ -113,16 +96,19 @@ and self-corrects for future threads!
11396

11497
:::
11598

116-
#### Execution
99+
##### Execution
117100

118101
The query plan is then **executed** against your data.
119102

120103
<Thumbnail src="/img/get-started/pql-execution.png" alt="A query plan's execution of Python and SQL." width="1000px" />
121104

122-
PromptQL writes Python code that includes SQL queries to retrieve data, and then processes that data using Python's data
123-
structures and the AI functions provided to it.
105+
PromptQL pulls the necessary data and uses AI to help make sense of it. Behind the scenes, it fetches information from
106+
your database and organizes it using Python, so you can focus on the insights, not the code.
107+
108+
If you're curious, expand the execution in your project and see the code PromptQL is executing against your datasource.
109+
And, just like the query plan, if you see something that should be different, let PromptQL know!
124110

125-
#### Artifacts
111+
##### Artifacts
126112

127113
Typically, the execution of a query plan will result in an **artifact**.
128114

@@ -135,6 +121,8 @@ Typically, the execution of a query plan will result in an **artifact**.
135121
Artifacts are structured outputs like tables, text, or visualizations that store the processed data or analysis results,
136122
which can be referenced later in the conversation, exported, or used to start new threads for further analysis.
137123

124+
We have a more in-depth guide for making decisions with PromptQL; check it out [here](/decision-making.mdx).
125+
138126
:::tip This is a conversation!
139127

140128
Talking with PromptQL is like talking to a human. This means it's an iterative process wherein you ask a question, it
@@ -143,13 +131,42 @@ provide, the better the answers become.
143131

144132
:::
145133

146-
### Give it a task to automate
134+
#### Give it a task to automate
135+
136+
Using the same sandbox project, we'll ask PromptQL to generate an automation for us:
137+
138+
> I need an automation to help me identify risky opportunities in my sales pipeline. I want to input a date range and
139+
> get back a list of opportunities that need attention. Specifically, I want to know which deals:
140+
>
141+
> - Haven't had any recent activity
142+
> - Are missing important contact relationships
143+
> - Show low engagement from the customer
144+
> - Are taking longer than expected to close
145+
>
146+
> Can you create something that gives me a risk score for each opportunity and suggests specific actions I should take?
147+
> I'd like the results in a format that makes it easy for me to prioritize which deals need immediate attention.
148+
149+
This task-based prompt asks PromptQL to build an **automation**: a reusable workflow that runs against your data and
150+
gives you consistent, structured results. Rather than just answering a one-time question, automations are designed to
151+
help you monitor, score, or act on key insights regularly.
152+
153+
<Thumbnail
154+
src="/img/get-started/playground-quickstart-automation.png"
155+
alt="A PromptQL-generated automation."
156+
width="1000px"
157+
/>
158+
159+
In this example, PromptQL will identify the relevant data, define what makes a deal “risky,” build a scoring system to
160+
prioritize those deals, and suggest actions—all packaged in a format that’s easy to review and reuse. Just like with
161+
query plans, PromptQL explains each step and lets you modify the logic, so you stay in control of the process.
147162

148-
TODO: After conversation with Sooraj on Monday, 23 June
163+
If you're using your own project, give PromptQL a similar task to automate. Otherwise,
164+
[click here](https://promptql.console.hasura.io/share/88a988ff-b44b-42b8-9859-846fa4be3f9c) to be dropped into a thread
165+
replay.
149166

150-
- Reusable programs
151-
- Ability to export executable code and run it from an API
167+
We also have a dedicated guide to building your own automations available [here](/automation.mdx).
152168

153169
## Next steps
154170

155-
- Dev mode
171+
Now that you've had your first set of conversations with PromptQL, we recommend checking out these docs around its
172+
[core capabilities](/capabilities.mdx).

src/css/custom.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,7 @@ h6 code {
330330

331331
blockquote {
332332
border-left: solid 2px var(--blockquote-margin);
333+
font-style: italic;
333334
}
334335

335336
/* -------------- TYPOGRAPHY COLORS -------------- */
Loading

0 commit comments

Comments
 (0)