Opik Agent Optimizer API Reference

1
FewShotBayesianOptimizer(
2
    model: str,
3
    min_examples: int = 2,
4
    max_examples: int = 8,
5
    seed: int = 42,
6
    n_threads: int = 8,
7
    verbose: int = 1,
8
    model_kwargs: Any
9
)

1
evaluate_prompt(
2
    prompt: ChatPrompt,
3
    dataset: Dataset,
4
    metric: Callable,
5
    n_threads: int,
6
    verbose: int = 1,
7
    dataset_item_ids: Optional = None,
8
    experiment_config: Optional = None,
9
    n_samples: Optional = None,
10
    seed: Optional = None,
11
    agent_class: Optional = None
12
)

1
get_history()

1
optimize_prompt(
2
    prompt: ChatPrompt,
3
    dataset: Dataset,
4
    metric: Callable,
5
    n_trials: int = 10,
6
    agent_class: Optional = None,
7
    experiment_config: Optional = None,
8
    n_samples: Optional = None
9
)

1
update_optimization(
2
    optimization: Optimization,
3
    status: str
4
)

1
MetaPromptOptimizer(
2
    model: str,
3
    reasoning_model: Optional = None,
4
    rounds: int = 3,
5
    num_prompts_per_round: int = 4,
6
    num_threads: Optional = None,
7
    verbose: int = 1,
8
    enable_context: bool = True,
9
    n_threads: int = 12,
10
    model_kwargs: Any
11
)

1
evaluate_prompt(
2
    prompt: ChatPrompt,
3
    dataset: Dataset,
4
    metric: Callable,
5
    n_threads: int,
6
    verbose: int = 1,
7
    dataset_item_ids: Optional = None,
8
    experiment_config: Optional = None,
9
    n_samples: Optional = None,
10
    seed: Optional = None,
11
    agent_class: Optional = None
12
)

1
get_history()

1
optimize_prompt(
2
    prompt: ChatPrompt,
3
    dataset: Dataset,
4
    metric: Callable,
5
    experiment_config: Optional = None,
6
    n_samples: Optional = None,
7
    auto_continue: bool = False,
8
    agent_class: Optional = None,
9
    kwargs: Any
10
)

1
update_optimization(
2
    optimization: Optimization,
3
    status: str
4
)

1
EvolutionaryOptimizer(
2
    model: str,
3
    population_size: int = 30,
4
    num_generations: int = 15,
5
    mutation_rate: float = 0.2,
6
    crossover_rate: float = 0.8,
7
    tournament_size: int = 4,
8
    num_threads: Optional = None,
9
    elitism_size: int = 3,
10
    adaptive_mutation: bool = True,
11
    enable_moo: bool = True,
12
    enable_llm_crossover: bool = True,
13
    seed: Optional = 42,
14
    output_style_guidance: Optional = None,
15
    infer_output_style: bool = False,
16
    verbose: int = 1,
17
    n_threads: int = 12,
18
    model_kwargs: Any
19
)

1
evaluate_prompt(
2
    prompt: ChatPrompt,
3
    dataset: Dataset,
4
    metric: Callable,
5
    n_threads: int,
6
    verbose: int = 1,
7
    dataset_item_ids: Optional = None,
8
    experiment_config: Optional = None,
9
    n_samples: Optional = None,
10
    seed: Optional = None,
11
    agent_class: Optional = None
12
)

1
get_history()

1
get_llm_crossover_system_prompt()

1
optimize_prompt(
2
    prompt: ChatPrompt,
3
    dataset: Dataset,
4
    metric: Callable,
5
    experiment_config: Optional = None,
6
    n_samples: Optional = None,
7
    auto_continue: bool = False,
8
    agent_class: Optional = None,
9
    kwargs: Any
10
)

1
update_optimization(
2
    optimization: Optimization,
3
    status: str
4
)

1
ChatPrompt(
2
    name: str = 'chat-prompt',
3
    system: Optional = None,
4
    user: Optional = None,
5
    messages: Optional = None,
6
    tools: Optional = None,
7
    function_map: Optional = None,
8
    model: Optional = None,
9
    invoke: Optional = None,
10
    project_name: Optional = 'Default Project',
11
    model_kwargs: Any
12
)

1
copy()

1
get_messages(
2
    dataset_item: Optional = None
3
)

1
set_messages(
2
    messages: List
3
)

1
to_dict()

1
OptimizationResult(
2
    optimizer: <class 'str'> = 'Optimizer',
3
    prompt: List[Dict[str, str]],
4
    score: <class 'float'>,
5
    metric_name: <class 'str'>,
6
    optimization_id: Optional[str] = None,
7
    dataset_id: Optional[str] = None,
8
    initial_prompt: Optional[List[Dict[str, str]]] = None,
9
    initial_score: Optional[float] = None,
10
    details: Dict[str, Any] = PydanticUndefined,
11
    history: List[Dict[str, Any]] = [],
12
    llm_calls: Optional[int] = None,
13
    demonstrations: Optional[List[Dict[str, Any]]] = None,
14
    mipro_prompt: Optional[str] = None,
15
    tool_prompts: Optional[Dict[str, str]] = None
16
)