feat: guide tool usage

Signed-off-by: Dan Selman <danscode@selman.org>
accordproject · May 28, 2024 · d465c4d · d465c4d
1 parent c3a1196
commit d465c4d
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/src/Conversation.ts b/src/Conversation.ts
@@ -1,6 +1,6 @@
 import OpenAI from 'openai';
 import { RunnableToolFunction } from "openai/lib/RunnableFunction";
-import { OPENAI_MODEL } from "./prompt";
+import { CONVERSATION_PROMPT, OPENAI_MODEL } from "./prompt";
 import { GraphModel } from "./graphmodel";
 import { ConversationOptions } from './types';
 
@@ -41,8 +41,7 @@ export class Conversation {
                 messages: [
                     {
                         role: 'system',
-                        content:
-                            'Please use our database, which you can access using functions to answer the following questions.',
+                        content: CONVERSATION_PROMPT,
                     },
                     { role: 'user', content }
                 ],

diff --git a/src/demo/index.ts b/src/demo/index.ts
@@ -174,7 +174,9 @@ async function run() {
       const convo = new Conversation(graphModel, {
         toolOptions: {
           getById: true,
-          chatWithData: true
+          chatWithData: true,
+          fullTextSearch: true,
+          similaritySearch: true
         }
       });
       let result = await convo.appendUserMessage('Tell me a joke about actors');

diff --git a/src/graphmodel.ts b/src/graphmodel.ts
@@ -689,7 +689,7 @@ export class GraphModel {
                 result.push({
                     type: "function",
                     function: {
-                        description: `Full-text search over ${index.type}`,
+                        description: `Fulltext search over ${index.type}`,
                         name: `fulltext_${index.type.toLowerCase()}`,
                         function: (async (args: { search: string, count?: number }) => {
                             const { search, count } = args;
@@ -726,7 +726,7 @@ export class GraphModel {
                 result.push({
                     type: "function",
                     function: {
-                        description: `Similiarity/conceptual search over ${index.type}.${index.property}`,
+                        description: `Similiarity search over ${index.type}.${index.property}`,
                         name: `similarity_${index.type.toLowerCase()}_${index.property.toLowerCase()}`,
                         function: (async (args: { query: string, property: string, count?: number }) => {
                             const { query, count } = args;

diff --git a/src/prompt.ts b/src/prompt.ts
@@ -52,6 +52,9 @@ Do not enclose the result in a markdown code block.
 `}
 }
 
+export const CONVERSATION_PROMPT = `Please use our database, which you can access using functions to answer the following questions. 
+Favor using the 'chat_with_data' tool over Fulltext search of Similarity search tools.`;
+
 export const OPENAI_MODEL = 'gpt-4o';
 
 export const TOOL_GET_EMBEDDINGS_NAME = "get_embeddings";