Skip to content

Commit d374268

Browse files
authored
Merge pull request #1 from max-datagamma/main
Minor grammar corrections for CLI docs
2 parents 513256e + c38060c commit d374268

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/WebGenAI-CLI.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
API Logic Server / GenAI provides CLI commands that accepts a Natural Language prompt (e.g, CRM system), and produces:
44

5-
* a Microservice: an Admin App and a JSON:API
6-
* a project you can download and customize in your IDE using rules and python
7-
* deploy as a container using automatically generated scripts.
5+
* a Microservice, an Admin App and a JSON API
6+
* a project that you can download and customize in your IDE using rules and Python
7+
* which can be deployed as a container using automatically generated scripts.
88

99
API Logic Server / GenAI uses:
1010

@@ -37,19 +37,19 @@ Projects are created in the currrent working directory, here, the manager.
3737

3838
You can review created projects by using the app, and/or reviewing the [data model](Database-Connectivity.md){:target="_blank" rel="noopener"}. Of course, it's simple to resubmit a new prompt and re-create the project.
3939

40-
However, this will be completely new rendition of your idea, and it may change things you like about the project. ***Conversations*** enable you to keep what you already have, while making desired changed.
40+
However, this will be a completely new rendition of your idea, and it may change things you like about the project. ***Conversations*** enable you to keep what you already have, while making desired changes.
4141

42-
When you create a project, the API Logic Server / GenAI saves your prompt and response in a conversatation-directory. Conversations are saved in 2 different conversations-directories:
42+
When you create a project, the API Logic Server / GenAI saves your prompt and response in a conversation-directory. Conversations are saved in 2 different conversation-directories:
4343

4444
* the manager's `system/genai/temp/<project>` directory
4545

4646
* the created project's `doc` directory.
4747

48-
You can iterate interative prompts, or by adding files to the manager's `system/genai/temp/<project>` directory.
48+
You can iterate with interactive prompts, or by adding files to the manager's `system/genai/temp/<project>` directory.
4949

5050
&nbsp;
5151

52-
### Conversations - Interative
52+
### Conversations - Interactive
5353

5454
The figure below creates and iterates a project, using the manager:
5555

@@ -64,7 +64,7 @@ als genai-iterate —-project-name=conv —using='add payments'
6464

6565
### Conversations - Files
6666

67-
Alternatively, you can iterate projects by adding files to Manager's temp directory:
67+
Alternatively, you can iterate projects by adding files to the Manager's temp directory:
6868

6969
```bash title='iterate project using files (Note: genai, not genai-iterate)'
7070
als genai-create --project-name=conv --using='customer orders'
@@ -99,13 +99,13 @@ As of release 11.2.10, you can declare Natural Language Logic when you create pr
9999

100100
### Create Projects with Logic
101101

102-
As shown below, you can the CLI `als genai` command to designate a prompt file that generates a system, including logic.
102+
As shown below, you can use the CLI `als genai` command to designate a prompt file that generates a system, including logic.
103103

104104

105105
Note:
106106

107107
1. Logic files can contain derivations and constraints
108-
2. The system will create model attributes for derived columns. Note these can dramatically improve performance.
108+
2. The system will create model attributes for derived columns. Note that these can dramatically improve performance.
109109

110110
You can declare logic formally, or informally.
111111

@@ -117,7 +117,7 @@ You can use familiar dot notation in declaring rules, e.g.
117117

118118
![Create Projects with Logic](images/web_genai/logic/new-projects.png)
119119

120-
```bash title='Formal Logic - Familar Dot Notation'
120+
```bash title='Formal Logic - Familiar Dot Notation'
121121
Create a system with customers, orders, items and products.
122122

123123
Include a notes field for orders.
@@ -235,13 +235,13 @@ GenAI is part of API Logic Server. As shown below:
235235
* GenAI
236236
237237
* Use ChatGPT APIs, and creates a model file from the response
238-
* Submits that to `als create --from-model=my_model.py`
238+
* Submit that to `als create --from-model=my_model.py`
239239
240240
241241
242242
![GenAI Automation](images/web_genai/how-does-it-work.png)
243243
244-
### Error Revovery
244+
### Error Recovery
245245
246246
AI results are not consistent, so you may sometimes need to correct errors and resume. This requires a bit of background about genai processing.
247247
@@ -251,7 +251,7 @@ AI results are not consistent, so you may sometimes need to correct errors and r
251251
252252
`genai` processing is shown below (internal steps denoted in grey):
253253
254-
1. You create your.prompt file, and invoke `als genai --using=your.prompt`. genai then creates your project as follows:
254+
1. You create your .prompt file, and invoke `als genai --using=your.prompt`. genai then creates your project as follows:
255255
256256
a. Submits your prompt to the `ChatGPT API`
257257
@@ -271,7 +271,7 @@ AI results are not consistent, so you may sometimes need to correct errors and r
271271
272272
#### Recovery options
273273
274-
AI somtimes fails - here's how to recover after your correct the response or the model file.
274+
AI somtimes fails - here's how to recover after you correct the response or the model file.
275275

276276
##### From the Model File
277277

0 commit comments

Comments
 (0)