getOpenAiPrompt

Author: anthonyjgrove

package-lock.json

@@ -83,6 +83,7 @@
   },
   "dependencies": {
     "axios": "^1.7.2",
+    "openai": "^4.47.1",
     "openapi-client-axios": "^7.5.4"
   }
 }

package.json

@@ -1,4 +1,7 @@
+import { ChatCompletionCreateParamsNonStreaming } from 'openai/resources'
+
 import APIClient from './ApiClient'
+import { mapPromptToOpenAIConfig } from './helpers/openAi'
 import { PromptConfiguration } from './types'
 
 export default class PromptFoundry {
@@ -19,4 +22,10 @@ export default class PromptFoundry {
   public async getPrompt({ promptId }: { promptId: string }): Promise<PromptConfiguration> {
     return this.client.get<PromptConfiguration>(`/prompts/${promptId}`)
   }
+
+  public async getOpenAiPrompt({ promptId }: { promptId: string }): Promise<ChatCompletionCreateParamsNonStreaming> {
+    const result = await this.client.get<PromptConfiguration>(`/prompts/${promptId}`)
+
+    return mapPromptToOpenAIConfig(result)
+  }
 }

src/Client.ts

@@ -0,0 +1 @@
+export * from './openAi'

src/helpers/index.ts

@@ -0,0 +1,30 @@
+import { ChatCompletionCreateParamsNonStreaming, ChatCompletionMessageParam, ChatCompletionRole } from 'openai/resources'
+
+import { PromptConfiguration, PromptMessage } from '../types'
+
+export const mapMessagesToOpenAI = (promptMessages: PromptMessage[]): ChatCompletionMessageParam[] => {
+  return promptMessages.map((message) => ({
+    role: message.role.toLowerCase() as ChatCompletionRole,
+    content: message.content
+  })) as ChatCompletionMessageParam[]
+}
+
+export const mapPromptToOpenAIConfig = (promptInstance: PromptConfiguration): ChatCompletionCreateParamsNonStreaming => {
+  const { promptMessages, promptParameters } = promptInstance
+
+  const messages = mapMessagesToOpenAI(promptMessages)
+
+  return {
+    messages,
+    model: promptParameters.modelName,
+    top_p: promptParameters.topP,
+    max_tokens: promptParameters.maxTokens,
+    temperature: promptParameters.temperature,
+    seed: promptParameters.seed,
+    presence_penalty: promptParameters.presencePenalty,
+    frequency_penalty: promptParameters.frequencyPenalty,
+    response_format: {
+      type: promptParameters.responseFormat === 'json' ? 'json_object' : 'text'
+    }
+  }
+}

src/helpers/openAi.ts

@@ -1,5 +1,6 @@
 import Client from './Client'
 
+export * from './helpers'
 export type * from './types'
 
 export default Client

src/index.ts

@@ -1,3 +1,4 @@
 import { Components } from './openapi'
 
 export type PromptConfiguration = Components.Schemas.PromptConfiguration
+export type PromptMessage = Components.Schemas.PromptConfiguration['promptMessages'][0]

src/types/index.ts

@@ -52,6 +52,16 @@ declare namespace Components {
                  * 1
                  */
                 topP: number;
+                /**
+                 * example:
+                 * 100
+                 */
+                maxTokens: number | null;
+                /**
+                 * example:
+                 * 97946543
+                 */
+                seed: number | null;
             };
             /**
              * Variables to be used in the prompt messages.