support override and append messages, user field

Author: anthonyjgrove

src/Client.ts

@@ -1,6 +1,6 @@
 import { ChatCompletionCreateParamsNonStreaming } from 'openai/resources'
 
-import { getMissingPromptVariables, renderPromptWithVariables, validatePromptVariables } from './helpers'
+import { addAppendedMessages, addOverrideMessages, getMissingPromptVariables, renderPromptWithVariables, validatePromptVariables } from './helpers'
 import { mapPromptToOpenAIConfig } from './helpers/openAi'
 import { api, createApiClient } from './openapi/client'
 import {
@@ -10,6 +10,7 @@ import {
   EvaluationGroupBody,
   PromptConfiguration,
   PromptConfigurationBody,
+  PromptMessage,
   PromptTool,
   PromptToolBody
 } from './types'
@@ -34,26 +35,56 @@ export default class PromptFoundry {
     return this.client.getPrompt({ params: { promptId: id }, headers: { 'X-API-KEY': this.apiKey } })
   }
 
-  public async getPrompt({ id, variables }: { id: string; variables: Record<string, string> }): Promise<PromptConfiguration> {
+  public async getPrompt({
+    id,
+    variables,
+    appendMessages,
+    overrideMessages
+  }: {
+    id: string
+    variables: Record<string, string>
+    appendMessages?: PromptMessage[]
+    overrideMessages?: PromptMessage[]
+    userId?: string
+  }): Promise<PromptConfiguration> {
     const result = await this.getRawPrompt({ id })
 
     if (!validatePromptVariables(result, variables)) {
       const missingVariables = getMissingPromptVariables(result, variables)
       throw new Error(`Missing variables in prompt: ${missingVariables.join(', ')}`)
     }
-    return renderPromptWithVariables(result, variables)
+
+    const updatedWithVariables = renderPromptWithVariables(result, variables)
+
+    if (overrideMessages) {
+      return addOverrideMessages(updatedWithVariables, overrideMessages)
+    }
+
+    if (appendMessages) {
+      return addAppendedMessages(updatedWithVariables, appendMessages)
+    }
+
+    return updatedWithVariables
   }
 
   public async getOpenAiPrompt({
     id,
-    variables
+    variables,
+    user,
+    appendMessages,
+    overrideMessages
   }: {
     id: string
     variables: Record<string, string>
+    appendMessages?: PromptMessage[]
+    overrideMessages?: PromptMessage[]
+    user?: string
   }): Promise<ChatCompletionCreateParamsNonStreaming> {
-    const updatedWithVariables = await this.getPrompt({ id, variables })
+    const updatedWithVariables = await this.getPrompt({ id, variables, appendMessages, overrideMessages })
 
-    return mapPromptToOpenAIConfig(updatedWithVariables)
+    return mapPromptToOpenAIConfig(updatedWithVariables, {
+      user
+    })
   }
 
   public createPrompt(data: PromptConfigurationBody): Promise<PromptConfiguration> {

src/helpers/openAi.ts

@@ -114,7 +114,10 @@ const getTools = (tools: PromptTool[]): ChatCompletionTool[] | undefined => {
   return tools.map((tool) => mapToolToOpenAi(tool))
 }
 
-export const mapPromptToOpenAIConfig = (promptConfig: PromptConfiguration): ChatCompletionCreateParamsNonStreaming => {
+export const mapPromptToOpenAIConfig = (
+  promptConfig: PromptConfiguration,
+  { user }: { user?: string } = {}
+): ChatCompletionCreateParamsNonStreaming => {
   const { messages: promptMessages, parameters, tools } = promptConfig
 
   const messages = mapMessagesToOpenAI(promptMessages)
@@ -132,6 +135,7 @@ export const mapPromptToOpenAIConfig = (promptConfig: PromptConfiguration): Chat
     response_format: {
       type: parameters.responseFormat === 'JSON' ? 'json_object' : 'text'
     },
-    tools: getTools(tools)
+    tools: getTools(tools),
+    user
   }
 }

src/helpers/template.ts

@@ -49,6 +49,20 @@ export function renderPromptWithVariables(prompt: PromptConfiguration, variables
   }
 }
 
+export function addAppendedMessages(prompt: PromptConfiguration, messages: PromptMessage[]): PromptConfiguration {
+  return {
+    ...prompt,
+    messages: [...prompt.messages, ...messages]
+  }
+}
+
+export function addOverrideMessages(prompt: PromptConfiguration, messages: PromptMessage[]): PromptConfiguration {
+  return {
+    ...prompt,
+    messages
+  }
+}
+
 export function getMissingPromptVariables(prompt: PromptConfiguration, variables: Record<string, string>): string[] {
   const variablesInPrompt = extractVariablesFromMessages(prompt.messages)