Merge pull request #2 from agorischek/docs

Add `ideas`

README.md

@@ -3,10 +3,10 @@
 Add variation to your content through randomized placeholders — Great for
 inspiring creativity in language model prompts.
 
-[![Version](https://img.shields.io/npm/v/fill-in-the-blank)](https://www.npmjs.com/package/fill-in-the-blank "Version")
-[![Workflow](https://img.shields.io/github/actions/workflow/status/agorischek/fill-in-the-blank/.github/workflows/ci.yml)](https://github.com/agorischek/fill-in-the-blank/actions/workflows/.github/workflows/ci.yml "Workflow")
-[![License](https://img.shields.io/github/license/agorischek/fill-in-the-blank)](https://github.com/agorischek/fill-in-the-blank#readme/blob/main/LICENSE "License")
-[![Badges](https://img.shields.io/badge/badges-rolled-white)](https://github.com/agorischek/badge-roll "Badges")
+[![Version](https://img.shields.io/npm/v/fill-in-the-blank)](https://www.npmjs.com/package/fill-in-the-blank 'Version')
+[![Workflow](https://img.shields.io/github/actions/workflow/status/agorischek/fill-in-the-blank/.github/workflows/ci.yml)](https://github.com/agorischek/fill-in-the-blank/actions/workflows/.github/workflows/ci.yml 'Workflow')
+[![License](https://img.shields.io/github/license/agorischek/fill-in-the-blank)](https://github.com/agorischek/fill-in-the-blank#readme/blob/main/LICENSE 'License')
+[![Badges](https://img.shields.io/badge/badges-rolled-white)](https://github.com/agorischek/badge-roll 'Badges')
 
 ```ts
 const prompt = `Would a ${animal} make a good ${profession}?`;
@@ -56,10 +56,17 @@ To get more varied responses from a language model, you can include the
 const prompt = 'Write a poem.' + creativity;
 ```
 
-This will insert a variety of ideas that the model can use to guide its
-response. Note that the behavior will be highly dependent on your model,
-settings, and other prompt content, and getting desirable results will likely
-require iteration.
+This will insert a random topic that the model can use to guide its response.
+
+To generate multiple possible topics, use the `ideas` blank:
+
+```ts
+const prompt = `Write a story by combining two of these ideas: ${ideas}`;
+```
+
+Note that the behavior will be highly dependent on your model, settings, and
+other prompt content, and getting desirable results will likely require
+iteration.
 
 ## Q&A
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fill-in-the-blank",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Word generator",
   "main": "dist/index.js",
   "type": "module",

src/prompting/creativity.ts

@@ -1,7 +1,6 @@
 import {
   animal,
   appliance,
-  color,
   emotion,
   exercise,
   musicGenre,
@@ -12,19 +11,28 @@ import {
 } from '../index.js';
 import { wrap } from '../shared/wrap.js';
 
-/** Provides a variety of topics for a model to consider when generating a response
- *
- * @remarks
- * The results of using `creativity` will vary greatly depending on your model, settings, and other prompt content.
- * Expect to iterate on your prompt and settings to get the desired results.
- *
+const kinds = [
+  exercise,
+  animal,
+  emotion,
+  plant,
+  vehicle,
+  appliance,
+  shape,
+  musicGenre,
+  profession,
+];
+
+/** Provides random inspiration for a model to consider when generating a response
  * @example
  * ```ts
  * const prompt = "Tell me a joke." + creativity;
- * // "Tell me a joke. Consider mentioning one of the following topics..."
+ * // "Tell me a joke. Use 'toaster' for creative inspiration."
  * ```
  */
-export const creativity = wrap(
-  () =>
-    ` Consider mentioning whichever **ONE** of these is most relevant: ${exercise}, ${animal}, the color ${color}, being ${emotion}, ${plant}, ${vehicle}, ${appliance}, ${shape}, ${musicGenre} music, or ${profession}.`,
-);
+export const creativity = wrap(() => {
+  const index = Math.floor(Math.random() * kinds.length);
+  const topic = kinds[index]();
+  const content = ` Use '${topic}' for creative inspiration.`;
+  return content;
+});

src/prompting/ideas.ts

@@ -0,0 +1,30 @@
+import {
+  animal,
+  appliance,
+  color,
+  emotion,
+  exercise,
+  musicGenre,
+  plant,
+  profession,
+  shape,
+  vehicle,
+} from '../index.js';
+import { wrap } from '../shared/wrap.js';
+
+/** Provides a variety of ideas for a model to consider when generating a response
+ *
+ * @remarks
+ * The results of using `ideas` will vary greatly depending on your model, settings, and other prompt content.
+ * Expect to iterate on your prompt and settings to get the desired results.
+ *
+ * @example
+ * ```ts
+ * const prompt = "Write me a story. Here are some ideas to get started: ${ideas}";
+ * // "Write me a story. Here are some ideas to get started: running, bunny, the color blue..."
+ * ```
+ */
+export const ideas = wrap(
+  () =>
+    `${exercise}, ${animal}, the color ${color}, being ${emotion}, ${plant}, ${vehicle}, ${appliance}, ${shape}, ${musicGenre} music, and ${profession}.`,
+);