fix tool choice

Author: anthonyjgrove

src/__tests__/__snapshots__/Client.test.ts.snap

@@ -24,7 +24,7 @@ exports[`client getOpenAiPrompt returnsmapped prompt 1`] = `
   },
   "seed": null,
   "temperature": 0.7,
-  "tool_choice": "none",
+  "tool_choice": undefined,
   "tools": undefined,
   "top_p": 1,
 }

src/helpers/__tests__/__snapshots__/openAi.test.ts.snap

@@ -0,0 +1,58 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`openAi helpers mapPromptToOpenAIConfig should map the configuration to OpenAI parameters correctly - tools 1`] = `
+{
+  "frequency_penalty": 0.1,
+  "max_tokens": 150,
+  "messages": [
+    {
+      "content": "Hello world",
+      "name": undefined,
+      "role": "user",
+    },
+  ],
+  "model": "text-davinci-002",
+  "presence_penalty": 0.1,
+  "response_format": {
+    "type": "json_object",
+  },
+  "seed": 42,
+  "temperature": 0.7,
+  "tool_choice": "auto",
+  "tools": [
+    {
+      "function": {
+        "description": "description",
+        "name": "exampleTool",
+        "parameters": {},
+      },
+      "type": "function",
+    },
+  ],
+  "top_p": 0.5,
+}
+`;
+
+exports[`openAi helpers mapPromptToOpenAIConfig should map the configuration to OpenAI parameters correctly 1`] = `
+{
+  "frequency_penalty": 0.1,
+  "max_tokens": 150,
+  "messages": [
+    {
+      "content": "Hello world",
+      "name": undefined,
+      "role": "user",
+    },
+  ],
+  "model": "text-davinci-002",
+  "presence_penalty": 0.1,
+  "response_format": {
+    "type": "json_object",
+  },
+  "seed": 42,
+  "temperature": 0.7,
+  "tool_choice": undefined,
+  "tools": undefined,
+  "top_p": 0.5,
+}
+`;

src/helpers/__tests__/openAi.test.ts

@@ -59,25 +59,18 @@ describe('openAi helpers', () => {
   })
 
   describe('mapPromptToOpenAIConfig', () => {
-    const mockPromptConfig = createPromptConfigurationFixture()
-
     it('should map the configuration to OpenAI parameters correctly', () => {
-      const result = mapPromptToOpenAIConfig(mockPromptConfig)
-      expect(result).toEqual({
-        messages: [{ role: 'user', name: undefined, content: 'Hello world' }],
-        model: 'text-davinci-002',
-        top_p: 0.5,
-        max_tokens: 150,
-        temperature: 0.7,
-        seed: 42,
-        presence_penalty: 0.1,
-        frequency_penalty: 0.1,
-        tool_choice: 'none',
-        response_format: {
-          type: 'json_object'
-        },
-        tools: undefined
-      })
+      const result = mapPromptToOpenAIConfig(createPromptConfigurationFixture())
+      expect(result).toMatchSnapshot()
+    })
+
+    it('should map the configuration to OpenAI parameters correctly - tools', () => {
+      const result = mapPromptToOpenAIConfig(
+        createPromptConfigurationFixture({
+          promptTools: [createPromptToolFixture({ name: 'exampleTool' })]
+        })
+      )
+      expect(result).toMatchSnapshot()
     })
 
     // Additional test cases to test other configurations and scenarios can be added here.
@@ -92,9 +85,9 @@ describe('openAi helpers', () => {
 
     it('should return "none" if there are no tools or toolChoice is "none"', () => {
       const tools: PromptTool[] = []
-      expect(mapToolChoiceToOpenAI(tools, 'none')).toBe('none')
-      expect(mapToolChoiceToOpenAI(tools)).toBe('none')
-      expect(mapToolChoiceToOpenAI(tools, 'auto')).toBe('none')
+      expect(mapToolChoiceToOpenAI(tools, 'none')).toBe(undefined)
+      expect(mapToolChoiceToOpenAI(tools)).toBe(undefined)
+      expect(mapToolChoiceToOpenAI(tools, 'auto')).toBe(undefined)
     })
 
     it('should return tool function object if a valid toolChoice matches a tool', () => {

src/helpers/openAi.ts

@@ -69,9 +69,9 @@ export const mapMessagesToOpenAI = (promptMessages: PromptMessage[]): ChatComple
   })
 }
 
-export const mapToolChoiceToOpenAI = (tools: PromptTool[], toolChoice?: string | null): ChatCompletionToolChoiceOption => {
+export const mapToolChoiceToOpenAI = (tools: PromptTool[], toolChoice?: string | null): ChatCompletionToolChoiceOption | undefined => {
   if (tools.length === 0) {
-    return 'none'
+    return undefined
   }
   if (toolChoice === 'auto' || (!toolChoice && tools.length !== 0)) {
     return 'auto'