notdiamond 2.2.1 → 2.2.4

package/src/resources/prompt-optimization.ts

@@ -119,20 +119,21 @@ export class PromptOptimization extends APIResource {
   }
 
   /**
-   * Adapt your prompt from one LLM to work optimally across different target LLMs.
+   * Optimize your prompt from one LLM to work optimally across different target
+   * LLMs.
    *
    * This endpoint automatically optimizes your prompt (system prompt + user message
    * template) to improve accuracy on your use case across various models. Each model
    * has unique characteristics, and what works well for GPT-5 might not work as well
    * for Claude or Gemini.
    *
-   * **How Prompt Adaptation Works:**
+   * **How Prompt Optimization Works:**
    *
    * 1. You provide your current prompt and optionally your current origin model
-   * 2. You specify the target models you want to adapt your prompt to
+   * 2. You specify the target models you want to optimize your prompt to
    * 3. You provide evaluation examples (golden records) with expected answers
    * 4. The system runs optimization to find the best prompt for each target model
-   * 5. You receive adapted prompts that perform well on your target models
+   * 5. You receive optimized prompts that perform well on your target models
    *
    * **Evaluation Metrics:** Choose either a standard metric or provide custom
    * evaluation:
@@ -169,10 +170,6 @@ export class PromptOptimization extends APIResource {
    * 4. Use optimized prompts in production with target models
    * ```
    *
-   * **Related Documentation:** See
-   * https://docs.notdiamond.ai/docs/adapting-prompts-to-new-models for detailed
-   * guide.
-   *
    * @example
    * ```ts
    * const response = await client.promptOptimization.optimize({
@@ -238,6 +235,39 @@ export class PromptOptimization extends APIResource {
   ): APIPromise<PromptOptimizationOptimizeResponse> {
     return this._client.post('/v2/prompt/optimize', { body, ...options });
   }
+
+  /**
+   * Get LLM usage costs for a specific prompt optimization run.
+   *
+   * This endpoint returns the total cost and detailed usage records for all LLM
+   * requests made during a prompt optimization run. Use this to track costs
+   * associated with optimizing prompts for different target models.
+   *
+   * **Cost Breakdown:**
+   *
+   * - Total cost across all models used in the optimization
+   * - Individual usage records with provider, model, tokens, and costs
+   * - Timestamps for each LLM request
+   *
+   * **Access Control:**
+   *
+   * - Only accessible by the user who created the optimization run
+   * - Requires prompt optimization access
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.promptOptimization.retrieveCosts(
+   *     'optimization_run_id',
+   *   );
+   * ```
+   */
+  retrieveCosts(
+    optimizationRunID: string,
+    options?: RequestOptions,
+  ): APIPromise<PromptOptimizationRetrieveCostsResponse> {
+    return this._client.get(path`/v2/prompt/optimize/${optimizationRunID}/costs`, options);
+  }
 }
 
 /**
@@ -313,7 +343,8 @@ export interface RequestProvider {
 }
 
 /**
- * Response model for GET /v2/prompt/adaptResults/{adaptation_run_id} endpoint.
+ * Response model for GET /v2/prompt/optimizeResults/{optimization_run_id}
+ * endpoint.
  *
  * Contains the complete results of a prompt adaptation run, including optimized
  * prompts and evaluation metrics for all target models. Use this to retrieve your
@@ -572,6 +603,106 @@ export interface PromptOptimizationOptimizeResponse {
   optimization_run_id: string;
 }
 
+/**
+ * Response model for GET /v2/prompt/optimize/{optimization_run_id}/costs endpoint.
+ *
+ * Contains the total LLM costs and detailed usage records for a prompt adaptation
+ * run. Use this to track costs associated with optimizing prompts for different
+ * target models.
+ */
+export interface PromptOptimizationRetrieveCostsResponse {
+  /**
+   * Unique identifier for the adaptation run
+   */
+  optimization_run_id: string;
+
+  /**
+   * Total cost in USD across all LLM requests in this adaptation run
+   */
+  total_cost: number;
+
+  /**
+   * Detailed usage records for each LLM request made during the adaptation
+   */
+  usage_records: Array<PromptOptimizationRetrieveCostsResponse.UsageRecord>;
+}
+
+export namespace PromptOptimizationRetrieveCostsResponse {
+  /**
+   * Individual LLM usage record with token counts and cost breakdown.
+   *
+   * Returned by GET /llm-usage endpoint and included in AdaptationRunCostResponse.
+   * Each record represents a single LLM API call with detailed usage metrics.
+   */
+  export interface UsageRecord {
+    /**
+     * Unique identifier for this usage record
+     */
+    id: string;
+
+    /**
+     * Adaptation run ID this usage is associated with
+     */
+    adaptation_run_id: string;
+
+    /**
+     * Cost of input tokens in USD
+     */
+    input_cost: number;
+
+    /**
+     * Number of input tokens consumed
+     */
+    input_tokens: number;
+
+    /**
+     * Model name (e.g., 'gpt-4', 'claude-3-opus-20240229')
+     */
+    model: string;
+
+    /**
+     * Organization ID associated with the request
+     */
+    organization_id: string;
+
+    /**
+     * Cost of output tokens in USD
+     */
+    output_cost: number;
+
+    /**
+     * Number of output tokens generated
+     */
+    output_tokens: number;
+
+    /**
+     * LLM provider (e.g., 'openai', 'anthropic', 'google')
+     */
+    provider: string;
+
+    /**
+     * Type of task: 'pre-optimization evaluation', 'optimization', or
+     * 'post-optimization evaluation'
+     */
+    task_type: string;
+
+    /**
+     * Unix timestamp when the request was made
+     */
+    timestamp: number;
+
+    /**
+     * Total cost (input + output) in USD
+     */
+    total_cost: number;
+
+    /**
+     * User ID who made the request
+     */
+    user_id: string;
+  }
+}
+
 export interface PromptOptimizationOptimizeParams {
   /**
    * List of field names that will be substituted into the template. Must match keys
@@ -586,7 +717,7 @@ export interface PromptOptimizationOptimizeParams {
   system_prompt: string;
 
   /**
-   * List of models to adapt the prompt for. Maximum count depends on your
+   * List of models to optimize the prompt for. Maximum count depends on your
    * subscription tier (Free: 1, Starter: 3, Startup: 5, Enterprise: 10)
    */
   target_models: Array<RequestProvider>;
@@ -646,6 +777,7 @@ export declare namespace PromptOptimization {
     type PromptOptimizationGetOptimizationResultsResponse as PromptOptimizationGetOptimizationResultsResponse,
     type PromptOptimizationGetOptimziationStatusResponse as PromptOptimizationGetOptimziationStatusResponse,
     type PromptOptimizationOptimizeResponse as PromptOptimizationOptimizeResponse,
+    type PromptOptimizationRetrieveCostsResponse as PromptOptimizationRetrieveCostsResponse,
     type PromptOptimizationOptimizeParams as PromptOptimizationOptimizeParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.2.1'; // x-release-please-version
+export const VERSION = '2.2.4'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.2.1";
+export declare const VERSION = "2.2.4";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.2.1";
+export declare const VERSION = "2.2.4";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.2.1'; // x-release-please-version
+exports.VERSION = '2.2.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.2.1'; // x-release-please-version
+export const VERSION = '2.2.4'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map