qualifire 1.4.0 → 1.5.0

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { EvaluationProxyAPIRequest, type EvaluationRequestV2, type EvaluationResponse } from './types';
-export type { EvaluationProxyAPIRequest, EvaluationRequestV2, EvaluationResponse, Framework, LLMMessage, ModelMode, PolicyTarget, } from './types';
+import { type CompilePromptResponse, EvaluationProxyAPIRequest, type EvaluationRequestV2, type EvaluationResponse } from './types';
+export type { CompilePromptResponse, EvaluationProxyAPIRequest, EvaluationRequestV2, EvaluationResponse, Framework, LLMMessage, ModelMode, PolicyTarget, ToolResponse, } from './types';
 /**
  * Represents the Qualifire SDK.
  */
@@ -174,4 +174,34 @@ export declare class Qualifire {
         output: string;
         evaluationId: string;
     }) => Promise<EvaluationResponse | undefined>;
+    /**
+     * 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: ({ promptId, revisionId, params, }: {
+        promptId: string;
+        revisionId?: string;
+        params?: Record<string, string>;
+    }) => Promise<CompilePromptResponse>;
 }

package/lib/index.js

@@ -337,6 +337,54 @@ class Qualifire {
             const jsonResponse = await response.json();
             return jsonResponse;
         };
+        /**
+         * 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);
+         * ```
+         */
+        this.compilePrompt = async ({ promptId, revisionId, params, }) => {
+            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;
+        };
         const key = apiKey || process.env.QUALIFIRE_API_KEY;
         const qualifireBaseUrl = baseUrl || process.env.QUALIFIRE_BASE_URL || 'https://proxy.qualifire.ai';
         if (!key) {

package/lib/types.d.ts

@@ -268,4 +268,37 @@ 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>;
+declare const ToolResponseSchema: z.ZodObject<{
+    type: z.ZodString;
+    function: z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        parameters: z.ZodRecord<z.ZodString, z.ZodAny>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+declare const CompilePromptResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    revision: z.ZodNumber;
+    messages: z.ZodArray<z.ZodObject<{
+        role: z.ZodString;
+        content: z.ZodOptional<z.ZodString>;
+        tool_calls: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            arguments: z.ZodRecord<z.ZodString, z.ZodAny>;
+            id: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    tools: z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        function: z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+            parameters: z.ZodRecord<z.ZodString, z.ZodAny>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    parameters: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$strip>;
+export type ToolResponse = z.infer<typeof ToolResponseSchema>;
+export type CompilePromptResponse = z.infer<typeof CompilePromptResponseSchema>;
 export {};

package/lib/types.js

@@ -230,3 +230,15 @@ const EvaluationResponseSchema = zod_1.z.object({
     score: zod_1.z.number(),
     status: zod_1.z.string(),
 });
+const ToolResponseSchema = zod_1.z.object({
+    type: zod_1.z.string(),
+    function: exports.LLMToolDefinitionSchema,
+});
+const CompilePromptResponseSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    revision: zod_1.z.number(),
+    messages: zod_1.z.array(LLMMessageSchema),
+    tools: zod_1.z.array(ToolResponseSchema),
+    parameters: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qualifire",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Qualifire client SDK",
   "main": "./lib/index.js",
   "files": [