promptgun 0.14.17 → 0.14.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,19 +3,6 @@
|
|
|
3
3
|
The simplest, most advanced LLM prompting library.
|
|
4
4
|
|
|
5
5
|
# How to use
|
|
6
|
-
### Text output – streamed
|
|
7
|
-
```typescript
|
|
8
|
-
const stream = ai.chat('How to make bread?')
|
|
9
|
-
let recipe = ''
|
|
10
|
-
for await (const chunk of stream) {
|
|
11
|
-
recipe += chunk
|
|
12
|
-
}
|
|
13
|
-
```
|
|
14
|
-
### Text output – single
|
|
15
|
-
```typescript
|
|
16
|
-
const fruit = await ai.chat('What company makes the iPhone?')
|
|
17
|
-
```
|
|
18
|
-
|
|
19
6
|
### Data output - streamed
|
|
20
7
|
Stream data-aware:
|
|
21
8
|
```typescript
|
|
@@ -64,6 +51,19 @@ const restaurants /* type: {name: string, address?: string}[] */ = await ai
|
|
|
64
51
|
)
|
|
65
52
|
```
|
|
66
53
|
|
|
54
|
+
### Text output – streamed
|
|
55
|
+
```typescript
|
|
56
|
+
const stream = ai.chat('How to make bread?')
|
|
57
|
+
let recipe = ''
|
|
58
|
+
for await (const chunk of stream) {
|
|
59
|
+
recipe += chunk
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
### Text output – single
|
|
63
|
+
```typescript
|
|
64
|
+
const fruit = await ai.chat('What company makes the iPhone?')
|
|
65
|
+
```
|
|
66
|
+
|
|
67
67
|
### Image out
|
|
68
68
|
```typescript
|
|
69
69
|
await ai
|
|
@@ -100,6 +100,6 @@ Get your PromptGrid API key for free at <a href="https://promptgrid.ai">PromptGr
|
|
|
100
100
|
Post at our [feedback and help board](https://promptgun.featurebase.app/dashboard/onboarding). We **love** to hear from you 👌☀️❤️.
|
|
101
101
|
|
|
102
102
|
## Terms of use
|
|
103
|
-
|
|
103
|
+
If you supply `promptGridApiKey`, which is completely optional, some metadata of your prompt code, including the code of the callback you provide to the "completeChat" clause of a Promptgun call and where you call your prompts in your code, will be saved to your PromptGrid account.
|
|
104
104
|
The content of individual prompt calls will not be stored in PromptGrid unless you opt in at <a href="https://promptgrid.ai/prompts">promptgrid.ai/prompts</a>.
|
|
105
105
|
You can delete any data stored on PromptGrid at any time.
|