dspex

# Generated by SnakeBridge v0.13.0 - DO NOT EDIT MANUALLY
# Regenerate with: mix compile
# Library: dspy 3.1.2
# Python module: dspy.predict.aggregation

defmodule Dspy.Predict.Aggregation do
  @moduledoc """
  Submodule bindings for `dspy.predict.aggregation`.

  ## Version

  - Requested: 3.1.2
  - Observed at generation: 3.1.2

  ## Runtime Options

  All functions accept a `__runtime__` option for controlling execution behavior:

      Dspy.Predict.Aggregation.some_function(args, __runtime__: [timeout: 120_000])

  ### Supported runtime options

  - `:timeout` - Call timeout in milliseconds (default: 120,000ms / 2 minutes)
  - `:timeout_profile` - Use a named profile (`:default`, `:ml_inference`, `:batch_job`, `:streaming`)
  - `:stream_timeout` - Timeout for streaming operations (default: 1,800,000ms / 30 minutes)
  - `:session_id` - Override the session ID for this call
  - `:pool_name` - Target a specific Snakepit pool (multi-pool setups)
  - `:affinity` - Override session affinity (`:hint`, `:strict_queue`, `:strict_fail_fast`)

  ### Timeout Profiles

  - `:default` - 2 minute timeout for regular calls
  - `:ml_inference` - 10 minute timeout for ML/LLM workloads
  - `:batch_job` - Unlimited timeout for long-running jobs
  - `:streaming` - 2 minute timeout, 30 minute stream_timeout

  ### Example with timeout override

      # For a long-running ML inference call
      Dspy.Predict.Aggregation.predict(data, __runtime__: [timeout_profile: :ml_inference])

      # Or explicit timeout
      Dspy.Predict.Aggregation.predict(data, __runtime__: [timeout: 600_000])

      # Route to a pool and enforce strict affinity
      Dspy.Predict.Aggregation.predict(data, __runtime__: [pool_name: :strict_pool, affinity: :strict_queue])

  See `SnakeBridge.Defaults` for global timeout configuration.

  """

  @doc false
  def __snakebridge_python_name__, do: "dspy.predict.aggregation"
  @doc false
  def __snakebridge_library__, do: "dspy"

  @doc """
  Python binding for `dspy.predict.aggregation.default_normalize`.

  ## Parameters

  - `s` (term())

  ## Returns

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

  @doc """
  Returns the most common completion for the target field (or the last field) in the signature.

  When normalize returns None, that completion is ignored.
  In case of a tie, earlier completion are prioritized.

  ## Parameters

  - `prediction_or_completions` (term())
  - `normalize` (term() default: <function default_normalize at 0x7ef40aefda80>)
  - `field` (term() default: None)

  ## Returns

  - `term()`
  """
  @spec majority(term()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  @spec majority(term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  @spec majority(term(), term()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  @spec majority(term(), term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  @spec majority(term(), term(), term()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
  @spec majority(term(), term(), term(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def majority(prediction_or_completions) do
    SnakeBridge.Runtime.call(__MODULE__, :majority, [prediction_or_completions], [])
  end

  def majority(prediction_or_completions, opts)
      when is_list(opts) and
             (opts == [] or
                (is_tuple(hd(opts)) and tuple_size(hd(opts)) == 2 and is_atom(elem(hd(opts), 0)))) do
    SnakeBridge.Runtime.call(__MODULE__, :majority, [prediction_or_completions], opts)
  end

  def majority(prediction_or_completions, normalize) do
    SnakeBridge.Runtime.call(__MODULE__, :majority, [prediction_or_completions, normalize], [])
  end

  def majority(prediction_or_completions, normalize, opts)
      when is_list(opts) and
             (opts == [] or
                (is_tuple(hd(opts)) and tuple_size(hd(opts)) == 2 and is_atom(elem(hd(opts), 0)))) do
    SnakeBridge.Runtime.call(__MODULE__, :majority, [prediction_or_completions, normalize], opts)
  end

  def majority(prediction_or_completions, normalize, field) do
    SnakeBridge.Runtime.call(
      __MODULE__,
      :majority,
      [prediction_or_completions, normalize, field],
      []
    )
  end

  def majority(prediction_or_completions, normalize, field, opts)
      when is_list(opts) and
             (opts == [] or
                (is_tuple(hd(opts)) and tuple_size(hd(opts)) == 2 and is_atom(elem(hd(opts), 0)))) do
    SnakeBridge.Runtime.call(
      __MODULE__,
      :majority,
      [prediction_or_completions, normalize, field],
      opts
    )
  end
end