[FIRE-1020] feature: add compile_prompt function to the client (#24)

Author: amos-qualifire

src/index.ts

@@ -5,22 +5,25 @@ import { GeminiAICanonicalEvaluationStrategy } from './frameworks/gemini/gemini-
 import { OpenAICanonicalEvaluationStrategy } from './frameworks/openai/openai-converter';
 import { VercelAICanonicalEvaluationStrategy } from './frameworks/vercelai/vercelai-converter';
 import {
+  type CompilePromptResponse,
   EvaluationProxyAPIRequest,
   EvaluationProxyAPIRequestSchema,
-  EvaluationRequestV2Schema,
   type EvaluationRequestV2,
+  EvaluationRequestV2Schema,
   type EvaluationResponse,
   type Framework,
 } from './types';
 
 export type {
+  CompilePromptResponse,
   EvaluationProxyAPIRequest,
   EvaluationRequestV2,
   EvaluationResponse,
   Framework,
   LLMMessage,
   ModelMode,
   PolicyTarget,
+  ToolResponse,
 } from './types';
 
 /**
@@ -418,4 +421,66 @@ export class Qualifire {
     const jsonResponse = await response.json();
     return jsonResponse as EvaluationResponse;
   };
+
+  /**
+   * Compiles a prompt from Qualifire Studio with the specified parameters.
+   *
+   * @param promptId - The ID of the prompt to compile.
+   * @param revisionId - Optional revision ID to use. If not provided, uses the latest revision.
+   * @param params - Optional dictionary of parameters to substitute in the prompt template.
+   * @returns A CompilePromptResponse containing the compiled prompt details.
+   *
+   * @example
+   * ```ts
+   * const qualifire = new Qualifire({ apiKey: 'your_api_key' });
+   *
+   * const response = await qualifire.compilePrompt({
+   *   promptId: 'prompt-123',
+   *   revisionId: 'rev-456',
+   *   params: {
+   *     user_name: 'John',
+   *     language: 'French'
+   *   }
+   * });
+   *
+   * console.log(response.messages);
+   * console.log(response.tools);
+   * ```
+   */
+  compilePrompt = async ({
+    promptId,
+    revisionId,
+    params,
+  }: {
+    promptId: string;
+    revisionId?: string;
+    params?: Record<string, string>;
+  }): Promise<CompilePromptResponse> => {
+    let url = `${this.baseUrl}/api/v1/studio/prompts/${promptId}/compile`;
+    if (revisionId) {
+      url = `${url}?revision=${revisionId}`;
+    }
+
+    const headers = {
+      'Content-Type': 'application/json',
+      'X-Qualifire-API-Key': this.sdkKey,
+    };
+
+    const body = JSON.stringify({
+      variables: params || {},
+    });
+
+    const response = await fetch(url, {
+      method: 'POST',
+      headers,
+      body,
+    });
+
+    if (!response.ok) {
+      throw new Error(`Qualifire API error: ${response.statusText}`);
+    }
+
+    const jsonResponse = await response.json();
+    return jsonResponse as CompilePromptResponse;
+  };
 }

src/types.ts

@@ -270,3 +270,20 @@ export type EvaluationResponse = z.infer<typeof EvaluationResponseSchema>;
 export type LLMToolDefinition = z.infer<typeof LLMToolDefinitionSchema>;
 export type LLMToolCall = z.infer<typeof LLMToolCallSchema>;
 export type EvaluationRequestV2 = z.infer<typeof EvaluationRequestV2Schema>;
+
+const ToolResponseSchema = z.object({
+  type: z.string(),
+  function: LLMToolDefinitionSchema,
+});
+
+const CompilePromptResponseSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  revision: z.number(),
+  messages: z.array(LLMMessageSchema),
+  tools: z.array(ToolResponseSchema),
+  parameters: z.record(z.string(), z.any()),
+});
+
+export type ToolResponse = z.infer<typeof ToolResponseSchema>;
+export type CompilePromptResponse = z.infer<typeof CompilePromptResponseSchema>;