-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprompt_optimization.py
More file actions
810 lines (653 loc) · 35.8 KB
/
Copy pathprompt_optimization.py
File metadata and controls
810 lines (653 loc) · 35.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Iterable, Optional
import httpx
from ..types import prompt_optimization_optimize_params
from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
from .._utils import path_template, maybe_transform, async_maybe_transform
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from .._base_client import make_request_options
from ..types.golden_record_param import GoldenRecordParam
from ..types.request_provider_param import RequestProviderParam
from ..types.prompt_optimization_optimize_response import PromptOptimizationOptimizeResponse
from ..types.prompt_optimization_retrieve_costs_response import PromptOptimizationRetrieveCostsResponse
from ..types.prompt_optimization_get_optimziation_status_response import PromptOptimizationGetOptimziationStatusResponse
from ..types.prompt_optimization_get_optimization_results_response import (
PromptOptimizationGetOptimizationResultsResponse,
)
__all__ = ["PromptOptimizationResource", "AsyncPromptOptimizationResource"]
class PromptOptimizationResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> PromptOptimizationResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/Not-Diamond/not-diamond-python#accessing-raw-response-data-eg-headers
"""
return PromptOptimizationResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> PromptOptimizationResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/Not-Diamond/not-diamond-python#with_streaming_response
"""
return PromptOptimizationResourceWithStreamingResponse(self)
def get_optimization_results(
self,
optimization_run_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationGetOptimizationResultsResponse:
"""
Retrieve the complete results of a prompt optimization run, including optimized
prompts for all target models.
This endpoint returns the optimized prompts and evaluation metrics for each
target model in your optimization request. Call this endpoint after the
optimization status is 'completed' to get your optimized prompts.
**Response Structure:**
- **origin_model**: Baseline performance of your original prompt on the origin
model
- Includes: system_prompt, user_message_template, score, evaluation metrics,
cost
- **target_models**: Array of results for each target model
- Includes: optimized system_prompt, user_message_template, template_fields
- pre_optimization_score: Performance before optimization
- post_optimization_score: Performance after optimization
- Evaluation metrics and cost information
**Using Optimized Prompts:**
1. Extract the `system_prompt` and `user_message_template` from each target
model result
2. Use `user_message_template_fields` to know which fields to substitute
3. Apply the optimized prompts when calling the respective target models
4. Compare pre/post optimization scores to see improvement
**Status Handling:**
- If optimization is still processing, target model results will have
`result_status: "processing"`
- Only completed target models will have system_prompt and template values
- Failed target models will have `result_status: "failed"` with null values
**Cost Information:**
- Each model result includes cost in USD for the optimization process
- Costs vary based on model pricing and number of evaluation examples
- Typical range: $0.10 - $2.00 per target model
**Best Practices:**
1. Wait for status 'completed' before calling this endpoint
2. Check result_status for each target model
3. Validate that post_optimization_score > pre_optimization_score
4. Save optimized prompts for production use
5. A/B test optimized prompts against originals in production
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not optimization_run_id:
raise ValueError(
f"Expected a non-empty value for `optimization_run_id` but received {optimization_run_id!r}"
)
return self._get(
path_template("/v2/prompt/optimizeResults/{optimization_run_id}", optimization_run_id=optimization_run_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationGetOptimizationResultsResponse,
)
def get_optimziation_status(
self,
optimization_run_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationGetOptimziationStatusResponse:
"""
Check the status of a prompt optimization run.
Use this endpoint to poll the status of your optimization request. Processing is
asynchronous, so you'll need to check periodically until the status indicates
completion.
**Status Values:**
- `created`: Initial state, not yet processing
- `queued`: Waiting for processing capacity (check queue_position)
- `processing`: Currently optimizing prompts
- `completed`: All target models have been processed successfully
- `failed`: One or more target models failed to process
**Polling Recommendations:**
- Poll every 30-60 seconds during processing
- Check queue_position if status is 'queued' to estimate wait time
- Stop polling once status is 'completed' or 'failed'
- Use GET /v2/prompt/optimizeResults to retrieve results after completion
**Queue Position:**
- Only present when status is 'queued'
- Lower numbers mean earlier processing (position 1 is next)
- Typical wait time: 1-5 minutes per position
**Note:** This endpoint only returns status information. To get the actual
optimized prompts and evaluation results, use GET /v2/prompt/optimizeResults
once status is 'completed'.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not optimization_run_id:
raise ValueError(
f"Expected a non-empty value for `optimization_run_id` but received {optimization_run_id!r}"
)
return self._get(
path_template("/v2/prompt/optimizeStatus/{optimization_run_id}", optimization_run_id=optimization_run_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationGetOptimziationStatusResponse,
)
def optimize(
self,
*,
fields: SequenceNotStr[str],
system_prompt: str,
target_models: Iterable[RequestProviderParam],
template: str,
evaluation_config: Optional[str] | Omit = omit,
evaluation_metric: Optional[str] | Omit = omit,
goldens: Optional[Iterable[GoldenRecordParam]] | Omit = omit,
origin_model: Optional[RequestProviderParam] | Omit = omit,
origin_model_evaluation_score: Optional[float] | Omit = omit,
prototype_mode: bool | Omit = omit,
test_goldens: Optional[Iterable[GoldenRecordParam]] | Omit = omit,
train_goldens: Optional[Iterable[GoldenRecordParam]] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationOptimizeResponse:
"""
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 Optimization Works:**
1. You provide your current prompt and optionally your current origin model
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 optimized prompts that perform well on your target models
**Evaluation Metrics:** Choose either a standard metric or provide custom
evaluation:
- **Standard metrics**: LLMaaJ:Sem_Sim_1 (semantic similarity), JSON_Match
- **Custom evaluation**: Provide evaluation_config with your own LLM judge,
prompt, and cutoff
**Dataset Requirements:**
- Minimum 25 examples in train_goldens (more examples = better optimization)
- **Prototype mode**: Set `prototype_mode: true` to use as few as 3 examples for
prototyping
- Recommended when you don't have enough data yet to build a proof-of-concept
- Note: Performance may be degraded compared to standard mode (25+ examples)
- Trade-off: Faster iteration with less data vs. potentially less
generalizability
- Each example must have fields matching your template placeholders
- Supervised evaluation requires 'answer' field in each golden record
- Unsupervised evaluation can work without answers
**Training Time:**
- Processing is asynchronous and typically takes 10-30 minutes
- Time depends on: number of target models, dataset size, model availability
- Use the returned optimization_run_id to check status and retrieve results
**Example Workflow:**
```
1. POST /v2/prompt/optimize - Submit optimization request
2. GET /v2/prompt/optimizeStatus/{id} - Poll status until completed
3. GET /v2/prompt/optimizeResults/{id} - Retrieve optimized prompts
4. Use optimized prompts in production with target models
```
Args:
fields: List of field names that will be substituted into the template. Must match keys
in golden records
system_prompt: System prompt to use with the origin model. This sets the context and role for
the LLM
target_models: List of models to optimize the prompt for. Maximum count depends on your
subscription tier (Free: 1, Starter: 3, Startup: 5, Enterprise: 10)
template: User message template with placeholders for fields. Use curly braces for field
substitution
goldens: Training examples (legacy parameter). Use train_goldens and test_goldens for
better control. Minimum 25 examples (or 3 with prototype_mode=true)
origin_model: Model for specifying an LLM provider in API requests.
origin_model_evaluation_score: Optional baseline score for the origin model. If provided, can skip origin model
evaluation
prototype_mode: Enable prototype mode to use as few as 3 training examples (instead of 25).
Note: Performance may be degraded with fewer examples. Recommended for
prototyping AI applications when you don't have enough data yet
test_goldens: Test examples for evaluation. Required if train_goldens is provided. Used to
measure final performance on held-out data
train_goldens: Training examples for prompt optimization. Minimum 25 examples required (or 3
with prototype_mode=true). Cannot be used with 'goldens' parameter
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/v2/prompt/optimize",
body=maybe_transform(
{
"fields": fields,
"system_prompt": system_prompt,
"target_models": target_models,
"template": template,
"evaluation_config": evaluation_config,
"evaluation_metric": evaluation_metric,
"goldens": goldens,
"origin_model": origin_model,
"origin_model_evaluation_score": origin_model_evaluation_score,
"prototype_mode": prototype_mode,
"test_goldens": test_goldens,
"train_goldens": train_goldens,
},
prompt_optimization_optimize_params.PromptOptimizationOptimizeParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationOptimizeResponse,
)
def retrieve_costs(
self,
optimization_run_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationRetrieveCostsResponse:
"""
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
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not optimization_run_id:
raise ValueError(
f"Expected a non-empty value for `optimization_run_id` but received {optimization_run_id!r}"
)
return self._get(
path_template("/v2/prompt/optimize/{optimization_run_id}/costs", optimization_run_id=optimization_run_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationRetrieveCostsResponse,
)
class AsyncPromptOptimizationResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncPromptOptimizationResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/Not-Diamond/not-diamond-python#accessing-raw-response-data-eg-headers
"""
return AsyncPromptOptimizationResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncPromptOptimizationResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/Not-Diamond/not-diamond-python#with_streaming_response
"""
return AsyncPromptOptimizationResourceWithStreamingResponse(self)
async def get_optimization_results(
self,
optimization_run_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationGetOptimizationResultsResponse:
"""
Retrieve the complete results of a prompt optimization run, including optimized
prompts for all target models.
This endpoint returns the optimized prompts and evaluation metrics for each
target model in your optimization request. Call this endpoint after the
optimization status is 'completed' to get your optimized prompts.
**Response Structure:**
- **origin_model**: Baseline performance of your original prompt on the origin
model
- Includes: system_prompt, user_message_template, score, evaluation metrics,
cost
- **target_models**: Array of results for each target model
- Includes: optimized system_prompt, user_message_template, template_fields
- pre_optimization_score: Performance before optimization
- post_optimization_score: Performance after optimization
- Evaluation metrics and cost information
**Using Optimized Prompts:**
1. Extract the `system_prompt` and `user_message_template` from each target
model result
2. Use `user_message_template_fields` to know which fields to substitute
3. Apply the optimized prompts when calling the respective target models
4. Compare pre/post optimization scores to see improvement
**Status Handling:**
- If optimization is still processing, target model results will have
`result_status: "processing"`
- Only completed target models will have system_prompt and template values
- Failed target models will have `result_status: "failed"` with null values
**Cost Information:**
- Each model result includes cost in USD for the optimization process
- Costs vary based on model pricing and number of evaluation examples
- Typical range: $0.10 - $2.00 per target model
**Best Practices:**
1. Wait for status 'completed' before calling this endpoint
2. Check result_status for each target model
3. Validate that post_optimization_score > pre_optimization_score
4. Save optimized prompts for production use
5. A/B test optimized prompts against originals in production
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not optimization_run_id:
raise ValueError(
f"Expected a non-empty value for `optimization_run_id` but received {optimization_run_id!r}"
)
return await self._get(
path_template("/v2/prompt/optimizeResults/{optimization_run_id}", optimization_run_id=optimization_run_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationGetOptimizationResultsResponse,
)
async def get_optimziation_status(
self,
optimization_run_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationGetOptimziationStatusResponse:
"""
Check the status of a prompt optimization run.
Use this endpoint to poll the status of your optimization request. Processing is
asynchronous, so you'll need to check periodically until the status indicates
completion.
**Status Values:**
- `created`: Initial state, not yet processing
- `queued`: Waiting for processing capacity (check queue_position)
- `processing`: Currently optimizing prompts
- `completed`: All target models have been processed successfully
- `failed`: One or more target models failed to process
**Polling Recommendations:**
- Poll every 30-60 seconds during processing
- Check queue_position if status is 'queued' to estimate wait time
- Stop polling once status is 'completed' or 'failed'
- Use GET /v2/prompt/optimizeResults to retrieve results after completion
**Queue Position:**
- Only present when status is 'queued'
- Lower numbers mean earlier processing (position 1 is next)
- Typical wait time: 1-5 minutes per position
**Note:** This endpoint only returns status information. To get the actual
optimized prompts and evaluation results, use GET /v2/prompt/optimizeResults
once status is 'completed'.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not optimization_run_id:
raise ValueError(
f"Expected a non-empty value for `optimization_run_id` but received {optimization_run_id!r}"
)
return await self._get(
path_template("/v2/prompt/optimizeStatus/{optimization_run_id}", optimization_run_id=optimization_run_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationGetOptimziationStatusResponse,
)
async def optimize(
self,
*,
fields: SequenceNotStr[str],
system_prompt: str,
target_models: Iterable[RequestProviderParam],
template: str,
evaluation_config: Optional[str] | Omit = omit,
evaluation_metric: Optional[str] | Omit = omit,
goldens: Optional[Iterable[GoldenRecordParam]] | Omit = omit,
origin_model: Optional[RequestProviderParam] | Omit = omit,
origin_model_evaluation_score: Optional[float] | Omit = omit,
prototype_mode: bool | Omit = omit,
test_goldens: Optional[Iterable[GoldenRecordParam]] | Omit = omit,
train_goldens: Optional[Iterable[GoldenRecordParam]] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationOptimizeResponse:
"""
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 Optimization Works:**
1. You provide your current prompt and optionally your current origin model
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 optimized prompts that perform well on your target models
**Evaluation Metrics:** Choose either a standard metric or provide custom
evaluation:
- **Standard metrics**: LLMaaJ:Sem_Sim_1 (semantic similarity), JSON_Match
- **Custom evaluation**: Provide evaluation_config with your own LLM judge,
prompt, and cutoff
**Dataset Requirements:**
- Minimum 25 examples in train_goldens (more examples = better optimization)
- **Prototype mode**: Set `prototype_mode: true` to use as few as 3 examples for
prototyping
- Recommended when you don't have enough data yet to build a proof-of-concept
- Note: Performance may be degraded compared to standard mode (25+ examples)
- Trade-off: Faster iteration with less data vs. potentially less
generalizability
- Each example must have fields matching your template placeholders
- Supervised evaluation requires 'answer' field in each golden record
- Unsupervised evaluation can work without answers
**Training Time:**
- Processing is asynchronous and typically takes 10-30 minutes
- Time depends on: number of target models, dataset size, model availability
- Use the returned optimization_run_id to check status and retrieve results
**Example Workflow:**
```
1. POST /v2/prompt/optimize - Submit optimization request
2. GET /v2/prompt/optimizeStatus/{id} - Poll status until completed
3. GET /v2/prompt/optimizeResults/{id} - Retrieve optimized prompts
4. Use optimized prompts in production with target models
```
Args:
fields: List of field names that will be substituted into the template. Must match keys
in golden records
system_prompt: System prompt to use with the origin model. This sets the context and role for
the LLM
target_models: List of models to optimize the prompt for. Maximum count depends on your
subscription tier (Free: 1, Starter: 3, Startup: 5, Enterprise: 10)
template: User message template with placeholders for fields. Use curly braces for field
substitution
goldens: Training examples (legacy parameter). Use train_goldens and test_goldens for
better control. Minimum 25 examples (or 3 with prototype_mode=true)
origin_model: Model for specifying an LLM provider in API requests.
origin_model_evaluation_score: Optional baseline score for the origin model. If provided, can skip origin model
evaluation
prototype_mode: Enable prototype mode to use as few as 3 training examples (instead of 25).
Note: Performance may be degraded with fewer examples. Recommended for
prototyping AI applications when you don't have enough data yet
test_goldens: Test examples for evaluation. Required if train_goldens is provided. Used to
measure final performance on held-out data
train_goldens: Training examples for prompt optimization. Minimum 25 examples required (or 3
with prototype_mode=true). Cannot be used with 'goldens' parameter
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/v2/prompt/optimize",
body=await async_maybe_transform(
{
"fields": fields,
"system_prompt": system_prompt,
"target_models": target_models,
"template": template,
"evaluation_config": evaluation_config,
"evaluation_metric": evaluation_metric,
"goldens": goldens,
"origin_model": origin_model,
"origin_model_evaluation_score": origin_model_evaluation_score,
"prototype_mode": prototype_mode,
"test_goldens": test_goldens,
"train_goldens": train_goldens,
},
prompt_optimization_optimize_params.PromptOptimizationOptimizeParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationOptimizeResponse,
)
async def retrieve_costs(
self,
optimization_run_id: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PromptOptimizationRetrieveCostsResponse:
"""
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
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not optimization_run_id:
raise ValueError(
f"Expected a non-empty value for `optimization_run_id` but received {optimization_run_id!r}"
)
return await self._get(
path_template("/v2/prompt/optimize/{optimization_run_id}/costs", optimization_run_id=optimization_run_id),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=PromptOptimizationRetrieveCostsResponse,
)
class PromptOptimizationResourceWithRawResponse:
def __init__(self, prompt_optimization: PromptOptimizationResource) -> None:
self._prompt_optimization = prompt_optimization
self.get_optimization_results = to_raw_response_wrapper(
prompt_optimization.get_optimization_results,
)
self.get_optimziation_status = to_raw_response_wrapper(
prompt_optimization.get_optimziation_status,
)
self.optimize = to_raw_response_wrapper(
prompt_optimization.optimize,
)
self.retrieve_costs = to_raw_response_wrapper(
prompt_optimization.retrieve_costs,
)
class AsyncPromptOptimizationResourceWithRawResponse:
def __init__(self, prompt_optimization: AsyncPromptOptimizationResource) -> None:
self._prompt_optimization = prompt_optimization
self.get_optimization_results = async_to_raw_response_wrapper(
prompt_optimization.get_optimization_results,
)
self.get_optimziation_status = async_to_raw_response_wrapper(
prompt_optimization.get_optimziation_status,
)
self.optimize = async_to_raw_response_wrapper(
prompt_optimization.optimize,
)
self.retrieve_costs = async_to_raw_response_wrapper(
prompt_optimization.retrieve_costs,
)
class PromptOptimizationResourceWithStreamingResponse:
def __init__(self, prompt_optimization: PromptOptimizationResource) -> None:
self._prompt_optimization = prompt_optimization
self.get_optimization_results = to_streamed_response_wrapper(
prompt_optimization.get_optimization_results,
)
self.get_optimziation_status = to_streamed_response_wrapper(
prompt_optimization.get_optimziation_status,
)
self.optimize = to_streamed_response_wrapper(
prompt_optimization.optimize,
)
self.retrieve_costs = to_streamed_response_wrapper(
prompt_optimization.retrieve_costs,
)
class AsyncPromptOptimizationResourceWithStreamingResponse:
def __init__(self, prompt_optimization: AsyncPromptOptimizationResource) -> None:
self._prompt_optimization = prompt_optimization
self.get_optimization_results = async_to_streamed_response_wrapper(
prompt_optimization.get_optimization_results,
)
self.get_optimziation_status = async_to_streamed_response_wrapper(
prompt_optimization.get_optimziation_status,
)
self.optimize = async_to_streamed_response_wrapper(
prompt_optimization.optimize,
)
self.retrieve_costs = async_to_streamed_response_wrapper(
prompt_optimization.retrieve_costs,
)