docs: document that instructions are derived from functions

lucgagan · Nov 12, 2023 · bf45904 · bf45904
1 parent 4d626c0
commit bf45904
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/prompt.ts b/src/prompt.ts
@@ -1,5 +1,11 @@
 import { TaskMessage } from "./types";
 
+/**
+ * The prompt itself is very simple because the vast majority of the logic is derived from
+ * the instructions contained in the parameter and function descriptions provided to `openai.beta.chat.completions`.
+ * @see https://www.npmjs.com/package/openai#automated-function-calls
+ * @see https://openai.com/blog/function-calling-and-other-api-updates
+ */
 export const prompt = (message: TaskMessage) => {
   return `This is your task: