notdiamond 2.1.2 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/README.md +20 -20
- package/client.d.mts +3 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -3
- package/client.d.ts.map +1 -1
- package/client.js +3 -3
- package/client.js.map +1 -1
- package/client.mjs +3 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/model-router.d.mts +2 -2
- package/resources/model-router.d.mts.map +1 -1
- package/resources/model-router.d.ts +2 -2
- package/resources/model-router.d.ts.map +1 -1
- package/resources/{prompt-adaptation.d.mts → prompt-optimization.d.mts} +20 -130
- package/resources/prompt-optimization.d.mts.map +1 -0
- package/resources/{prompt-adaptation.d.ts → prompt-optimization.d.ts} +20 -130
- package/resources/prompt-optimization.d.ts.map +1 -0
- package/resources/{prompt-adaptation.js → prompt-optimization.js} +7 -35
- package/resources/prompt-optimization.js.map +1 -0
- package/resources/{prompt-adaptation.mjs → prompt-optimization.mjs} +5 -33
- package/resources/prompt-optimization.mjs.map +1 -0
- package/src/client.ts +13 -15
- package/src/resources/index.ts +6 -7
- package/src/resources/model-router.ts +4 -2
- package/src/resources/{prompt-adaptation.ts → prompt-optimization.ts} +23 -153
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/prompt-adaptation.d.mts.map +0 -1
- package/resources/prompt-adaptation.d.ts.map +0 -1
- package/resources/prompt-adaptation.js.map +0 -1
- package/resources/prompt-adaptation.mjs.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model-router.d.mts","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,
|
|
1
|
+
{"version":3,"file":"model-router.d.mts","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,qBAAqB;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAI9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;IAE1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,EAAE,KAAK,CAClB,qBAAqB,CAAC,eAAe,GAAG,4BAA4B,CAAC,kBAAkB,CACxF,CAAC;IAEF;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC,GAAG,MAAM,CAAC;IAErE;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;;;;;;;;;;;OAaG;IACH,UAAiB,kBAAkB;QACjC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
|
-
import * as
|
|
2
|
+
import * as PromptOptimizationAPI from "./prompt-optimization.js";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.js";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
5
|
export declare class ModelRouter extends APIResource {
|
|
@@ -98,7 +98,7 @@ export interface ModelRouterSelectModelParams {
|
|
|
98
98
|
* Body param: List of LLM providers to route between. Specify at least one
|
|
99
99
|
* provider in format {provider, model}
|
|
100
100
|
*/
|
|
101
|
-
llm_providers: Array<
|
|
101
|
+
llm_providers: Array<PromptOptimizationAPI.RequestProvider | ModelRouterSelectModelParams.OpenRouterProvider>;
|
|
102
102
|
/**
|
|
103
103
|
* Body param: Array of message objects in OpenAI format (with 'role' and 'content'
|
|
104
104
|
* keys)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model-router.d.ts","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,
|
|
1
|
+
{"version":3,"file":"model-router.d.ts","sourceRoot":"","sources":["../src/resources/model-router.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,qBAAqB;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAI9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;IAE1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,EAAE,KAAK,CAClB,qBAAqB,CAAC,eAAe,GAAG,4BAA4B,CAAC,kBAAkB,CACxF,CAAC;IAEF;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC,GAAG,MAAM,CAAC;IAErE;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;;;;;;;;;;;OAaG;IACH,UAAiB,kBAAkB;QACjC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -1,34 +1,8 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
|
-
import * as
|
|
2
|
+
import * as PromptOptimizationAPI from "./prompt-optimization.mjs";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
-
export declare class
|
|
6
|
-
/**
|
|
7
|
-
* Get LLM usage costs for a specific prompt optimization run.
|
|
8
|
-
*
|
|
9
|
-
* This endpoint returns the total cost and detailed usage records for all LLM
|
|
10
|
-
* requests made during a prompt optimization run. Use this to track costs
|
|
11
|
-
* associated with optimizing prompts for different target models.
|
|
12
|
-
*
|
|
13
|
-
* **Cost Breakdown:**
|
|
14
|
-
*
|
|
15
|
-
* - Total cost across all models used in the optimization
|
|
16
|
-
* - Individual usage records with provider, model, tokens, and costs
|
|
17
|
-
* - Timestamps for each LLM request
|
|
18
|
-
*
|
|
19
|
-
* **Access Control:**
|
|
20
|
-
*
|
|
21
|
-
* - Only accessible by the user who created the optimization run
|
|
22
|
-
* - Requires prompt optimization access
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* ```ts
|
|
26
|
-
* const response = await client.promptAdaptation.getCost(
|
|
27
|
-
* 'optimization_run_id',
|
|
28
|
-
* );
|
|
29
|
-
* ```
|
|
30
|
-
*/
|
|
31
|
-
getCost(optimizationRunID: string, options?: RequestOptions): APIPromise<PromptAdaptationGetCostResponse>;
|
|
5
|
+
export declare class PromptOptimization extends APIResource {
|
|
32
6
|
/**
|
|
33
7
|
* Retrieve the complete results of a prompt optimization run, including optimized
|
|
34
8
|
* prompts for all target models.
|
|
@@ -81,12 +55,12 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
81
55
|
* @example
|
|
82
56
|
* ```ts
|
|
83
57
|
* const response =
|
|
84
|
-
* await client.
|
|
58
|
+
* await client.promptOptimization.getOptimizationResults(
|
|
85
59
|
* 'optimization_run_id',
|
|
86
60
|
* );
|
|
87
61
|
* ```
|
|
88
62
|
*/
|
|
89
|
-
getOptimizationResults(optimizationRunID: string, options?: RequestOptions): APIPromise<
|
|
63
|
+
getOptimizationResults(optimizationRunID: string, options?: RequestOptions): APIPromise<PromptOptimizationGetOptimizationResultsResponse>;
|
|
90
64
|
/**
|
|
91
65
|
* Check the status of a prompt optimization run.
|
|
92
66
|
*
|
|
@@ -122,12 +96,12 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
122
96
|
* @example
|
|
123
97
|
* ```ts
|
|
124
98
|
* const response =
|
|
125
|
-
* await client.
|
|
99
|
+
* await client.promptOptimization.getOptimziationStatus(
|
|
126
100
|
* 'optimization_run_id',
|
|
127
101
|
* );
|
|
128
102
|
* ```
|
|
129
103
|
*/
|
|
130
|
-
getOptimziationStatus(optimizationRunID: string, options?: RequestOptions): APIPromise<
|
|
104
|
+
getOptimziationStatus(optimizationRunID: string, options?: RequestOptions): APIPromise<PromptOptimizationGetOptimziationStatusResponse>;
|
|
131
105
|
/**
|
|
132
106
|
* Adapt your prompt from one LLM to work optimally across different target LLMs.
|
|
133
107
|
*
|
|
@@ -185,7 +159,7 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
185
159
|
*
|
|
186
160
|
* @example
|
|
187
161
|
* ```ts
|
|
188
|
-
* const response = await client.
|
|
162
|
+
* const response = await client.promptOptimization.optimize({
|
|
189
163
|
* fields: ['question'],
|
|
190
164
|
* system_prompt: 'You are a mathematical assistant that counts digits accurately.',
|
|
191
165
|
* target_models: [
|
|
@@ -242,7 +216,7 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
242
216
|
* });
|
|
243
217
|
* ```
|
|
244
218
|
*/
|
|
245
|
-
optimize(body:
|
|
219
|
+
optimize(body: PromptOptimizationOptimizeParams, options?: RequestOptions): APIPromise<PromptOptimizationOptimizeResponse>;
|
|
246
220
|
}
|
|
247
221
|
/**
|
|
248
222
|
* A training or test example for prompt adaptation.
|
|
@@ -308,90 +282,6 @@ export interface RequestProvider {
|
|
|
308
282
|
*/
|
|
309
283
|
output_price?: number | null;
|
|
310
284
|
}
|
|
311
|
-
/**
|
|
312
|
-
* Response model for GET /v2/prompt/adapt/{adaptation_run_id}/costs endpoint.
|
|
313
|
-
*
|
|
314
|
-
* Contains the total LLM costs and detailed usage records for a prompt adaptation
|
|
315
|
-
* run. Use this to track costs associated with optimizing prompts for different
|
|
316
|
-
* target models.
|
|
317
|
-
*/
|
|
318
|
-
export interface PromptAdaptationGetCostResponse {
|
|
319
|
-
/**
|
|
320
|
-
* Unique identifier for the adaptation run
|
|
321
|
-
*/
|
|
322
|
-
adaptation_run_id: string;
|
|
323
|
-
/**
|
|
324
|
-
* Total cost in USD across all LLM requests in this adaptation run
|
|
325
|
-
*/
|
|
326
|
-
total_cost: number;
|
|
327
|
-
/**
|
|
328
|
-
* Detailed usage records for each LLM request made during the adaptation
|
|
329
|
-
*/
|
|
330
|
-
usage_records: Array<PromptAdaptationGetCostResponse.UsageRecord>;
|
|
331
|
-
}
|
|
332
|
-
export declare namespace PromptAdaptationGetCostResponse {
|
|
333
|
-
/**
|
|
334
|
-
* Individual LLM usage record with token counts and cost breakdown.
|
|
335
|
-
*
|
|
336
|
-
* Returned by GET /llm-usage endpoint and included in AdaptationRunCostResponse.
|
|
337
|
-
* Each record represents a single LLM API call with detailed usage metrics.
|
|
338
|
-
*/
|
|
339
|
-
interface UsageRecord {
|
|
340
|
-
/**
|
|
341
|
-
* Unique identifier for this usage record
|
|
342
|
-
*/
|
|
343
|
-
id: string;
|
|
344
|
-
/**
|
|
345
|
-
* Adaptation run ID this usage is associated with
|
|
346
|
-
*/
|
|
347
|
-
adaptation_run_id: string;
|
|
348
|
-
/**
|
|
349
|
-
* Cost of input tokens in USD
|
|
350
|
-
*/
|
|
351
|
-
input_cost: number;
|
|
352
|
-
/**
|
|
353
|
-
* Number of input tokens consumed
|
|
354
|
-
*/
|
|
355
|
-
input_tokens: number;
|
|
356
|
-
/**
|
|
357
|
-
* Model name (e.g., 'gpt-4', 'claude-3-opus-20240229')
|
|
358
|
-
*/
|
|
359
|
-
model: string;
|
|
360
|
-
/**
|
|
361
|
-
* Organization ID associated with the request
|
|
362
|
-
*/
|
|
363
|
-
organization_id: string;
|
|
364
|
-
/**
|
|
365
|
-
* Cost of output tokens in USD
|
|
366
|
-
*/
|
|
367
|
-
output_cost: number;
|
|
368
|
-
/**
|
|
369
|
-
* Number of output tokens generated
|
|
370
|
-
*/
|
|
371
|
-
output_tokens: number;
|
|
372
|
-
/**
|
|
373
|
-
* LLM provider (e.g., 'openai', 'anthropic', 'google')
|
|
374
|
-
*/
|
|
375
|
-
provider: string;
|
|
376
|
-
/**
|
|
377
|
-
* Type of task: 'pre-optimization evaluation', 'optimization', or
|
|
378
|
-
* 'post-optimization evaluation'
|
|
379
|
-
*/
|
|
380
|
-
task_type: string;
|
|
381
|
-
/**
|
|
382
|
-
* Unix timestamp when the request was made
|
|
383
|
-
*/
|
|
384
|
-
timestamp: number;
|
|
385
|
-
/**
|
|
386
|
-
* Total cost (input + output) in USD
|
|
387
|
-
*/
|
|
388
|
-
total_cost: number;
|
|
389
|
-
/**
|
|
390
|
-
* User ID who made the request
|
|
391
|
-
*/
|
|
392
|
-
user_id: string;
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
285
|
/**
|
|
396
286
|
* Response model for GET /v2/prompt/adaptResults/{adaptation_run_id} endpoint.
|
|
397
287
|
*
|
|
@@ -405,7 +295,7 @@ export declare namespace PromptAdaptationGetCostResponse {
|
|
|
405
295
|
* - Optimized prompts for each target model with pre/post optimization scores
|
|
406
296
|
* - Evaluation metrics and cost information for each model
|
|
407
297
|
*/
|
|
408
|
-
export interface
|
|
298
|
+
export interface PromptOptimizationGetOptimizationResultsResponse {
|
|
409
299
|
/**
|
|
410
300
|
* Unique ID for this adaptation run
|
|
411
301
|
*/
|
|
@@ -421,7 +311,7 @@ export interface PromptAdaptationGetOptimizationResultsResponse {
|
|
|
421
311
|
/**
|
|
422
312
|
* Results for each target model with optimized prompts and improvement scores
|
|
423
313
|
*/
|
|
424
|
-
target_models: Array<
|
|
314
|
+
target_models: Array<PromptOptimizationGetOptimizationResultsResponse.TargetModel>;
|
|
425
315
|
/**
|
|
426
316
|
* Timestamp of last update to this adaptation run
|
|
427
317
|
*/
|
|
@@ -449,7 +339,7 @@ export interface PromptAdaptationGetOptimizationResultsResponse {
|
|
|
449
339
|
* - Cost of running the baseline evaluation
|
|
450
340
|
* - Job status for the origin model evaluation
|
|
451
341
|
*/
|
|
452
|
-
origin_model?:
|
|
342
|
+
origin_model?: PromptOptimizationGetOptimizationResultsResponse.OriginModel | null;
|
|
453
343
|
/**
|
|
454
344
|
* Whether this adaptation run was created with prototype mode (3-24 training
|
|
455
345
|
* examples allowed). Prototype mode may have degraded performance compared to
|
|
@@ -457,7 +347,7 @@ export interface PromptAdaptationGetOptimizationResultsResponse {
|
|
|
457
347
|
*/
|
|
458
348
|
prototype_mode?: boolean;
|
|
459
349
|
}
|
|
460
|
-
export declare namespace
|
|
350
|
+
export declare namespace PromptOptimizationGetOptimizationResultsResponse {
|
|
461
351
|
/**
|
|
462
352
|
* Optimized prompt results for a single target model in prompt adaptation.
|
|
463
353
|
*
|
|
@@ -506,7 +396,7 @@ export declare namespace PromptAdaptationGetOptimizationResultsResponse {
|
|
|
506
396
|
* - **failed**: Job encountered an error and did not complete
|
|
507
397
|
* - **cancelled**: Job was cancelled due to a restart operation
|
|
508
398
|
*/
|
|
509
|
-
result_status?:
|
|
399
|
+
result_status?: PromptOptimizationAPI.JobStatus | null;
|
|
510
400
|
/**
|
|
511
401
|
* Optimized system prompt for this target model. Use this as the system message in
|
|
512
402
|
* your LLM calls
|
|
@@ -557,7 +447,7 @@ export declare namespace PromptAdaptationGetOptimizationResultsResponse {
|
|
|
557
447
|
* - **failed**: Job encountered an error and did not complete
|
|
558
448
|
* - **cancelled**: Job was cancelled due to a restart operation
|
|
559
449
|
*/
|
|
560
|
-
result_status?:
|
|
450
|
+
result_status?: PromptOptimizationAPI.JobStatus | null;
|
|
561
451
|
/**
|
|
562
452
|
* Original system prompt used for the origin model
|
|
563
453
|
*/
|
|
@@ -589,7 +479,7 @@ export declare namespace PromptAdaptationGetOptimizationResultsResponse {
|
|
|
589
479
|
* - Stop polling once status is 'completed' or 'failed'
|
|
590
480
|
* - Optimization typically takes 10-30 minutes total
|
|
591
481
|
*/
|
|
592
|
-
export interface
|
|
482
|
+
export interface PromptOptimizationGetOptimziationStatusResponse {
|
|
593
483
|
/**
|
|
594
484
|
* Unique identifier for this optimization run. Use this to poll status and
|
|
595
485
|
* retrieve optimized prompts when complete
|
|
@@ -621,14 +511,14 @@ export interface PromptAdaptationGetOptimziationStatusResponse {
|
|
|
621
511
|
* /v2/prompt/optimizeResults/{optimization_run_id}
|
|
622
512
|
* 4. Use the optimized prompts with your target models
|
|
623
513
|
*/
|
|
624
|
-
export interface
|
|
514
|
+
export interface PromptOptimizationOptimizeResponse {
|
|
625
515
|
/**
|
|
626
516
|
* Unique identifier for this optimization run. Use this to poll status and
|
|
627
517
|
* retrieve optimized prompts when complete
|
|
628
518
|
*/
|
|
629
519
|
optimization_run_id: string;
|
|
630
520
|
}
|
|
631
|
-
export interface
|
|
521
|
+
export interface PromptOptimizationOptimizeParams {
|
|
632
522
|
/**
|
|
633
523
|
* List of field names that will be substituted into the template. Must match keys
|
|
634
524
|
* in golden records
|
|
@@ -682,7 +572,7 @@ export interface PromptAdaptationOptimizeParams {
|
|
|
682
572
|
*/
|
|
683
573
|
train_goldens?: Array<GoldenRecord> | null;
|
|
684
574
|
}
|
|
685
|
-
export declare namespace
|
|
686
|
-
export { type GoldenRecord as GoldenRecord, type JobStatus as JobStatus, type RequestProvider as RequestProvider, type
|
|
575
|
+
export declare namespace PromptOptimization {
|
|
576
|
+
export { type GoldenRecord as GoldenRecord, type JobStatus as JobStatus, type RequestProvider as RequestProvider, type PromptOptimizationGetOptimizationResultsResponse as PromptOptimizationGetOptimizationResultsResponse, type PromptOptimizationGetOptimziationStatusResponse as PromptOptimizationGetOptimziationStatusResponse, type PromptOptimizationOptimizeResponse as PromptOptimizationOptimizeResponse, type PromptOptimizationOptimizeParams as PromptOptimizationOptimizeParams, };
|
|
687
577
|
}
|
|
688
|
-
//# sourceMappingURL=prompt-
|
|
578
|
+
//# sourceMappingURL=prompt-optimization.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prompt-optimization.d.mts","sourceRoot":"","sources":["../src/resources/prompt-optimization.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,qBAAqB;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,sBAAsB,CACpB,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gDAAgD,CAAC;IAI/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,qBAAqB,CACnB,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+CAA+C,CAAC;IAI9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiHG;IACH,QAAQ,CACN,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAElC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gDAAgD;IAC/D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,gDAAgD,CAAC,WAAW,CAAC,CAAC;IAEnF;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAE/D;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,gDAAgD,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnF;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,yBAAiB,gDAAgD,CAAC;IAChE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAiB,WAAW;QAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,uBAAuB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE3D,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC,sBAAsB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE1D,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;;;;;;;WAYG;QACH,aAAa,CAAC,EAAE,qBAAqB,CAAC,SAAS,GAAG,IAAI,CAAC;QAEvD;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,4BAA4B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACrD;IAED;;;;;;;;;;;;;OAaG;IACH,UAAiB,WAAW;QAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,KAAK,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;;;;;;;;;;WAYG;QACH,aAAa,CAAC,EAAE,qBAAqB,CAAC,SAAS,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,+CAA+C;IAC9D;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,kCAAkC;IACjD;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEtC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,6BAA6B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gDAAgD,IAAI,gDAAgD,EACzG,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
|
|
@@ -1,34 +1,8 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
|
-
import * as
|
|
2
|
+
import * as PromptOptimizationAPI from "./prompt-optimization.js";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.js";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
-
export declare class
|
|
6
|
-
/**
|
|
7
|
-
* Get LLM usage costs for a specific prompt optimization run.
|
|
8
|
-
*
|
|
9
|
-
* This endpoint returns the total cost and detailed usage records for all LLM
|
|
10
|
-
* requests made during a prompt optimization run. Use this to track costs
|
|
11
|
-
* associated with optimizing prompts for different target models.
|
|
12
|
-
*
|
|
13
|
-
* **Cost Breakdown:**
|
|
14
|
-
*
|
|
15
|
-
* - Total cost across all models used in the optimization
|
|
16
|
-
* - Individual usage records with provider, model, tokens, and costs
|
|
17
|
-
* - Timestamps for each LLM request
|
|
18
|
-
*
|
|
19
|
-
* **Access Control:**
|
|
20
|
-
*
|
|
21
|
-
* - Only accessible by the user who created the optimization run
|
|
22
|
-
* - Requires prompt optimization access
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* ```ts
|
|
26
|
-
* const response = await client.promptAdaptation.getCost(
|
|
27
|
-
* 'optimization_run_id',
|
|
28
|
-
* );
|
|
29
|
-
* ```
|
|
30
|
-
*/
|
|
31
|
-
getCost(optimizationRunID: string, options?: RequestOptions): APIPromise<PromptAdaptationGetCostResponse>;
|
|
5
|
+
export declare class PromptOptimization extends APIResource {
|
|
32
6
|
/**
|
|
33
7
|
* Retrieve the complete results of a prompt optimization run, including optimized
|
|
34
8
|
* prompts for all target models.
|
|
@@ -81,12 +55,12 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
81
55
|
* @example
|
|
82
56
|
* ```ts
|
|
83
57
|
* const response =
|
|
84
|
-
* await client.
|
|
58
|
+
* await client.promptOptimization.getOptimizationResults(
|
|
85
59
|
* 'optimization_run_id',
|
|
86
60
|
* );
|
|
87
61
|
* ```
|
|
88
62
|
*/
|
|
89
|
-
getOptimizationResults(optimizationRunID: string, options?: RequestOptions): APIPromise<
|
|
63
|
+
getOptimizationResults(optimizationRunID: string, options?: RequestOptions): APIPromise<PromptOptimizationGetOptimizationResultsResponse>;
|
|
90
64
|
/**
|
|
91
65
|
* Check the status of a prompt optimization run.
|
|
92
66
|
*
|
|
@@ -122,12 +96,12 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
122
96
|
* @example
|
|
123
97
|
* ```ts
|
|
124
98
|
* const response =
|
|
125
|
-
* await client.
|
|
99
|
+
* await client.promptOptimization.getOptimziationStatus(
|
|
126
100
|
* 'optimization_run_id',
|
|
127
101
|
* );
|
|
128
102
|
* ```
|
|
129
103
|
*/
|
|
130
|
-
getOptimziationStatus(optimizationRunID: string, options?: RequestOptions): APIPromise<
|
|
104
|
+
getOptimziationStatus(optimizationRunID: string, options?: RequestOptions): APIPromise<PromptOptimizationGetOptimziationStatusResponse>;
|
|
131
105
|
/**
|
|
132
106
|
* Adapt your prompt from one LLM to work optimally across different target LLMs.
|
|
133
107
|
*
|
|
@@ -185,7 +159,7 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
185
159
|
*
|
|
186
160
|
* @example
|
|
187
161
|
* ```ts
|
|
188
|
-
* const response = await client.
|
|
162
|
+
* const response = await client.promptOptimization.optimize({
|
|
189
163
|
* fields: ['question'],
|
|
190
164
|
* system_prompt: 'You are a mathematical assistant that counts digits accurately.',
|
|
191
165
|
* target_models: [
|
|
@@ -242,7 +216,7 @@ export declare class PromptAdaptation extends APIResource {
|
|
|
242
216
|
* });
|
|
243
217
|
* ```
|
|
244
218
|
*/
|
|
245
|
-
optimize(body:
|
|
219
|
+
optimize(body: PromptOptimizationOptimizeParams, options?: RequestOptions): APIPromise<PromptOptimizationOptimizeResponse>;
|
|
246
220
|
}
|
|
247
221
|
/**
|
|
248
222
|
* A training or test example for prompt adaptation.
|
|
@@ -308,90 +282,6 @@ export interface RequestProvider {
|
|
|
308
282
|
*/
|
|
309
283
|
output_price?: number | null;
|
|
310
284
|
}
|
|
311
|
-
/**
|
|
312
|
-
* Response model for GET /v2/prompt/adapt/{adaptation_run_id}/costs endpoint.
|
|
313
|
-
*
|
|
314
|
-
* Contains the total LLM costs and detailed usage records for a prompt adaptation
|
|
315
|
-
* run. Use this to track costs associated with optimizing prompts for different
|
|
316
|
-
* target models.
|
|
317
|
-
*/
|
|
318
|
-
export interface PromptAdaptationGetCostResponse {
|
|
319
|
-
/**
|
|
320
|
-
* Unique identifier for the adaptation run
|
|
321
|
-
*/
|
|
322
|
-
adaptation_run_id: string;
|
|
323
|
-
/**
|
|
324
|
-
* Total cost in USD across all LLM requests in this adaptation run
|
|
325
|
-
*/
|
|
326
|
-
total_cost: number;
|
|
327
|
-
/**
|
|
328
|
-
* Detailed usage records for each LLM request made during the adaptation
|
|
329
|
-
*/
|
|
330
|
-
usage_records: Array<PromptAdaptationGetCostResponse.UsageRecord>;
|
|
331
|
-
}
|
|
332
|
-
export declare namespace PromptAdaptationGetCostResponse {
|
|
333
|
-
/**
|
|
334
|
-
* Individual LLM usage record with token counts and cost breakdown.
|
|
335
|
-
*
|
|
336
|
-
* Returned by GET /llm-usage endpoint and included in AdaptationRunCostResponse.
|
|
337
|
-
* Each record represents a single LLM API call with detailed usage metrics.
|
|
338
|
-
*/
|
|
339
|
-
interface UsageRecord {
|
|
340
|
-
/**
|
|
341
|
-
* Unique identifier for this usage record
|
|
342
|
-
*/
|
|
343
|
-
id: string;
|
|
344
|
-
/**
|
|
345
|
-
* Adaptation run ID this usage is associated with
|
|
346
|
-
*/
|
|
347
|
-
adaptation_run_id: string;
|
|
348
|
-
/**
|
|
349
|
-
* Cost of input tokens in USD
|
|
350
|
-
*/
|
|
351
|
-
input_cost: number;
|
|
352
|
-
/**
|
|
353
|
-
* Number of input tokens consumed
|
|
354
|
-
*/
|
|
355
|
-
input_tokens: number;
|
|
356
|
-
/**
|
|
357
|
-
* Model name (e.g., 'gpt-4', 'claude-3-opus-20240229')
|
|
358
|
-
*/
|
|
359
|
-
model: string;
|
|
360
|
-
/**
|
|
361
|
-
* Organization ID associated with the request
|
|
362
|
-
*/
|
|
363
|
-
organization_id: string;
|
|
364
|
-
/**
|
|
365
|
-
* Cost of output tokens in USD
|
|
366
|
-
*/
|
|
367
|
-
output_cost: number;
|
|
368
|
-
/**
|
|
369
|
-
* Number of output tokens generated
|
|
370
|
-
*/
|
|
371
|
-
output_tokens: number;
|
|
372
|
-
/**
|
|
373
|
-
* LLM provider (e.g., 'openai', 'anthropic', 'google')
|
|
374
|
-
*/
|
|
375
|
-
provider: string;
|
|
376
|
-
/**
|
|
377
|
-
* Type of task: 'pre-optimization evaluation', 'optimization', or
|
|
378
|
-
* 'post-optimization evaluation'
|
|
379
|
-
*/
|
|
380
|
-
task_type: string;
|
|
381
|
-
/**
|
|
382
|
-
* Unix timestamp when the request was made
|
|
383
|
-
*/
|
|
384
|
-
timestamp: number;
|
|
385
|
-
/**
|
|
386
|
-
* Total cost (input + output) in USD
|
|
387
|
-
*/
|
|
388
|
-
total_cost: number;
|
|
389
|
-
/**
|
|
390
|
-
* User ID who made the request
|
|
391
|
-
*/
|
|
392
|
-
user_id: string;
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
285
|
/**
|
|
396
286
|
* Response model for GET /v2/prompt/adaptResults/{adaptation_run_id} endpoint.
|
|
397
287
|
*
|
|
@@ -405,7 +295,7 @@ export declare namespace PromptAdaptationGetCostResponse {
|
|
|
405
295
|
* - Optimized prompts for each target model with pre/post optimization scores
|
|
406
296
|
* - Evaluation metrics and cost information for each model
|
|
407
297
|
*/
|
|
408
|
-
export interface
|
|
298
|
+
export interface PromptOptimizationGetOptimizationResultsResponse {
|
|
409
299
|
/**
|
|
410
300
|
* Unique ID for this adaptation run
|
|
411
301
|
*/
|
|
@@ -421,7 +311,7 @@ export interface PromptAdaptationGetOptimizationResultsResponse {
|
|
|
421
311
|
/**
|
|
422
312
|
* Results for each target model with optimized prompts and improvement scores
|
|
423
313
|
*/
|
|
424
|
-
target_models: Array<
|
|
314
|
+
target_models: Array<PromptOptimizationGetOptimizationResultsResponse.TargetModel>;
|
|
425
315
|
/**
|
|
426
316
|
* Timestamp of last update to this adaptation run
|
|
427
317
|
*/
|
|
@@ -449,7 +339,7 @@ export interface PromptAdaptationGetOptimizationResultsResponse {
|
|
|
449
339
|
* - Cost of running the baseline evaluation
|
|
450
340
|
* - Job status for the origin model evaluation
|
|
451
341
|
*/
|
|
452
|
-
origin_model?:
|
|
342
|
+
origin_model?: PromptOptimizationGetOptimizationResultsResponse.OriginModel | null;
|
|
453
343
|
/**
|
|
454
344
|
* Whether this adaptation run was created with prototype mode (3-24 training
|
|
455
345
|
* examples allowed). Prototype mode may have degraded performance compared to
|
|
@@ -457,7 +347,7 @@ export interface PromptAdaptationGetOptimizationResultsResponse {
|
|
|
457
347
|
*/
|
|
458
348
|
prototype_mode?: boolean;
|
|
459
349
|
}
|
|
460
|
-
export declare namespace
|
|
350
|
+
export declare namespace PromptOptimizationGetOptimizationResultsResponse {
|
|
461
351
|
/**
|
|
462
352
|
* Optimized prompt results for a single target model in prompt adaptation.
|
|
463
353
|
*
|
|
@@ -506,7 +396,7 @@ export declare namespace PromptAdaptationGetOptimizationResultsResponse {
|
|
|
506
396
|
* - **failed**: Job encountered an error and did not complete
|
|
507
397
|
* - **cancelled**: Job was cancelled due to a restart operation
|
|
508
398
|
*/
|
|
509
|
-
result_status?:
|
|
399
|
+
result_status?: PromptOptimizationAPI.JobStatus | null;
|
|
510
400
|
/**
|
|
511
401
|
* Optimized system prompt for this target model. Use this as the system message in
|
|
512
402
|
* your LLM calls
|
|
@@ -557,7 +447,7 @@ export declare namespace PromptAdaptationGetOptimizationResultsResponse {
|
|
|
557
447
|
* - **failed**: Job encountered an error and did not complete
|
|
558
448
|
* - **cancelled**: Job was cancelled due to a restart operation
|
|
559
449
|
*/
|
|
560
|
-
result_status?:
|
|
450
|
+
result_status?: PromptOptimizationAPI.JobStatus | null;
|
|
561
451
|
/**
|
|
562
452
|
* Original system prompt used for the origin model
|
|
563
453
|
*/
|
|
@@ -589,7 +479,7 @@ export declare namespace PromptAdaptationGetOptimizationResultsResponse {
|
|
|
589
479
|
* - Stop polling once status is 'completed' or 'failed'
|
|
590
480
|
* - Optimization typically takes 10-30 minutes total
|
|
591
481
|
*/
|
|
592
|
-
export interface
|
|
482
|
+
export interface PromptOptimizationGetOptimziationStatusResponse {
|
|
593
483
|
/**
|
|
594
484
|
* Unique identifier for this optimization run. Use this to poll status and
|
|
595
485
|
* retrieve optimized prompts when complete
|
|
@@ -621,14 +511,14 @@ export interface PromptAdaptationGetOptimziationStatusResponse {
|
|
|
621
511
|
* /v2/prompt/optimizeResults/{optimization_run_id}
|
|
622
512
|
* 4. Use the optimized prompts with your target models
|
|
623
513
|
*/
|
|
624
|
-
export interface
|
|
514
|
+
export interface PromptOptimizationOptimizeResponse {
|
|
625
515
|
/**
|
|
626
516
|
* Unique identifier for this optimization run. Use this to poll status and
|
|
627
517
|
* retrieve optimized prompts when complete
|
|
628
518
|
*/
|
|
629
519
|
optimization_run_id: string;
|
|
630
520
|
}
|
|
631
|
-
export interface
|
|
521
|
+
export interface PromptOptimizationOptimizeParams {
|
|
632
522
|
/**
|
|
633
523
|
* List of field names that will be substituted into the template. Must match keys
|
|
634
524
|
* in golden records
|
|
@@ -682,7 +572,7 @@ export interface PromptAdaptationOptimizeParams {
|
|
|
682
572
|
*/
|
|
683
573
|
train_goldens?: Array<GoldenRecord> | null;
|
|
684
574
|
}
|
|
685
|
-
export declare namespace
|
|
686
|
-
export { type GoldenRecord as GoldenRecord, type JobStatus as JobStatus, type RequestProvider as RequestProvider, type
|
|
575
|
+
export declare namespace PromptOptimization {
|
|
576
|
+
export { type GoldenRecord as GoldenRecord, type JobStatus as JobStatus, type RequestProvider as RequestProvider, type PromptOptimizationGetOptimizationResultsResponse as PromptOptimizationGetOptimizationResultsResponse, type PromptOptimizationGetOptimziationStatusResponse as PromptOptimizationGetOptimziationStatusResponse, type PromptOptimizationOptimizeResponse as PromptOptimizationOptimizeResponse, type PromptOptimizationOptimizeParams as PromptOptimizationOptimizeParams, };
|
|
687
577
|
}
|
|
688
|
-
//# sourceMappingURL=prompt-
|
|
578
|
+
//# sourceMappingURL=prompt-optimization.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prompt-optimization.d.ts","sourceRoot":"","sources":["../src/resources/prompt-optimization.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,qBAAqB;OAC1B,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,sBAAsB,CACpB,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gDAAgD,CAAC;IAI/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,qBAAqB,CACnB,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+CAA+C,CAAC;IAI9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiHG;IACH,QAAQ,CACN,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAElC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gDAAgD;IAC/D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,gDAAgD,CAAC,WAAW,CAAC,CAAC;IAEnF;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IAE/D;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,gDAAgD,CAAC,WAAW,GAAG,IAAI,CAAC;IAEnF;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,yBAAiB,gDAAgD,CAAC;IAChE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAiB,WAAW;QAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,uBAAuB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE3D,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC,sBAAsB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE1D,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;;;;;;;;;WAYG;QACH,aAAa,CAAC,EAAE,qBAAqB,CAAC,SAAS,GAAG,IAAI,CAAC;QAEvD;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,4BAA4B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACrD;IAED;;;;;;;;;;;;;OAaG;IACH,UAAiB,WAAW;QAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,KAAK,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;;;;;;;;;;WAYG;QACH,aAAa,CAAC,EAAE,qBAAqB,CAAC,SAAS,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,+CAA+C;IAC9D;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,kCAAkC;IACjD;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAEtC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,6BAA6B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gDAAgD,IAAI,gDAAgD,EACzG,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
|
|
@@ -1,38 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.
|
|
4
|
+
exports.PromptOptimization = void 0;
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
6
|
const path_1 = require("../internal/utils/path.js");
|
|
7
|
-
class
|
|
8
|
-
/**
|
|
9
|
-
* Get LLM usage costs for a specific prompt optimization run.
|
|
10
|
-
*
|
|
11
|
-
* This endpoint returns the total cost and detailed usage records for all LLM
|
|
12
|
-
* requests made during a prompt optimization run. Use this to track costs
|
|
13
|
-
* associated with optimizing prompts for different target models.
|
|
14
|
-
*
|
|
15
|
-
* **Cost Breakdown:**
|
|
16
|
-
*
|
|
17
|
-
* - Total cost across all models used in the optimization
|
|
18
|
-
* - Individual usage records with provider, model, tokens, and costs
|
|
19
|
-
* - Timestamps for each LLM request
|
|
20
|
-
*
|
|
21
|
-
* **Access Control:**
|
|
22
|
-
*
|
|
23
|
-
* - Only accessible by the user who created the optimization run
|
|
24
|
-
* - Requires prompt optimization access
|
|
25
|
-
*
|
|
26
|
-
* @example
|
|
27
|
-
* ```ts
|
|
28
|
-
* const response = await client.promptAdaptation.getCost(
|
|
29
|
-
* 'optimization_run_id',
|
|
30
|
-
* );
|
|
31
|
-
* ```
|
|
32
|
-
*/
|
|
33
|
-
getCost(optimizationRunID, options) {
|
|
34
|
-
return this._client.get((0, path_1.path) `/v2/prompt/optimize/${optimizationRunID}/costs`, options);
|
|
35
|
-
}
|
|
7
|
+
class PromptOptimization extends resource_1.APIResource {
|
|
36
8
|
/**
|
|
37
9
|
* Retrieve the complete results of a prompt optimization run, including optimized
|
|
38
10
|
* prompts for all target models.
|
|
@@ -85,7 +57,7 @@ class PromptAdaptation extends resource_1.APIResource {
|
|
|
85
57
|
* @example
|
|
86
58
|
* ```ts
|
|
87
59
|
* const response =
|
|
88
|
-
* await client.
|
|
60
|
+
* await client.promptOptimization.getOptimizationResults(
|
|
89
61
|
* 'optimization_run_id',
|
|
90
62
|
* );
|
|
91
63
|
* ```
|
|
@@ -128,7 +100,7 @@ class PromptAdaptation extends resource_1.APIResource {
|
|
|
128
100
|
* @example
|
|
129
101
|
* ```ts
|
|
130
102
|
* const response =
|
|
131
|
-
* await client.
|
|
103
|
+
* await client.promptOptimization.getOptimziationStatus(
|
|
132
104
|
* 'optimization_run_id',
|
|
133
105
|
* );
|
|
134
106
|
* ```
|
|
@@ -193,7 +165,7 @@ class PromptAdaptation extends resource_1.APIResource {
|
|
|
193
165
|
*
|
|
194
166
|
* @example
|
|
195
167
|
* ```ts
|
|
196
|
-
* const response = await client.
|
|
168
|
+
* const response = await client.promptOptimization.optimize({
|
|
197
169
|
* fields: ['question'],
|
|
198
170
|
* system_prompt: 'You are a mathematical assistant that counts digits accurately.',
|
|
199
171
|
* target_models: [
|
|
@@ -254,5 +226,5 @@ class PromptAdaptation extends resource_1.APIResource {
|
|
|
254
226
|
return this._client.post('/v2/prompt/optimize', { body, ...options });
|
|
255
227
|
}
|
|
256
228
|
}
|
|
257
|
-
exports.
|
|
258
|
-
//# sourceMappingURL=prompt-
|
|
229
|
+
exports.PromptOptimization = PromptOptimization;
|
|
230
|
+
//# sourceMappingURL=prompt-optimization.js.map
|