dspex

# Generated by SnakeBridge v0.12.0 - DO NOT EDIT MANUALLY
# Regenerate with: mix compile
# Library: dspy 3.1.2
# Python module: dspy.propose.utils

defmodule Dspy.Propose.Utils do
  @moduledoc """
  Submodule bindings for `dspy.propose.utils`.
  """

  def __snakebridge_python_name__, do: "dspy.propose.utils"
  def __snakebridge_library__, do: "dspy"

  @doc """

  """
  @spec create_example_string(term(), term(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def create_example_string(fields, example, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :create_example_string, [fields, example], opts)
  end

  @doc """

  """
  @spec create_instruction_set_history_string(term(), term(), term(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def create_instruction_set_history_string(base_program, trial_logs, top_n, opts \\ []) do
    SnakeBridge.Runtime.call(
      __MODULE__,
      :create_instruction_set_history_string,
      [base_program, trial_logs, top_n],
      opts
    )
  end

  @doc """

  """
  @spec create_predictor_level_history_string(term(), term(), term(), term(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def create_predictor_level_history_string(
        base_program,
        predictor_i,
        trial_logs,
        top_n,
        opts \\ []
      ) do
    SnakeBridge.Runtime.call(
      __MODULE__,
      :create_predictor_level_history_string,
      [base_program, predictor_i, trial_logs, top_n],
      opts
    )
  end

  @doc """

  """
  @spec get_dspy_source_code(term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def get_dspy_source_code(module, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :get_dspy_source_code, [module], opts)
  end

  @doc """

  """
  @spec get_program_instruction_set_string(term(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def get_program_instruction_set_string(program, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :get_program_instruction_set_string, [program], opts)
  end

  @doc """

  """
  @spec parse_list_of_instructions(term(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def parse_list_of_instructions(instruction_string, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :parse_list_of_instructions, [instruction_string], opts)
  end

  @doc """

  """
  @spec strip_prefix(term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  def strip_prefix(text, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :strip_prefix, [text], opts)
  end
end