dspex

# Generated by SnakeBridge v0.14.0 - DO NOT EDIT MANUALLY
# Regenerate with: mix compile
# Library: dspy 3.1.2
# Python module: dspy.dsp.colbertv2

defmodule Dspy.Dsp.Colbertv2 do
  @moduledoc """
  Submodule bindings for `dspy.dsp.colbertv2`.

  ## Version

  - Requested: 3.1.2
  - Observed at generation: 3.1.2

  ## Runtime Options

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

      Dspy.Dsp.Colbertv2.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.Dsp.Colbertv2.predict(data, __runtime__: [timeout_profile: :ml_inference])

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

      # Route to a pool and enforce strict affinity
      Dspy.Dsp.Colbertv2.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.dsp.colbertv2"
  @doc false
  def __snakebridge_library__, do: "dspy"

  @doc """
  Python binding for `dspy.dsp.colbertv2.colbertv2_get_request`.

  ## Parameters

  - `args` (term())
  - `kwargs` (term())

  ## Returns

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

  @doc """
  Python binding for `dspy.dsp.colbertv2.colbertv2_get_request_v2`.

  ## Parameters

  - `url` (String.t())
  - `query` (String.t())
  - `k` (integer())

  ## Returns

  - `term()`
  """
  @spec colbertv2_get_request_v2(String.t(), String.t(), integer(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def colbertv2_get_request_v2(url, query, k, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :colbertv2_get_request_v2, [url, query, k], opts)
  end

  @doc """
  Python binding for `dspy.dsp.colbertv2.colbertv2_get_request_v2_wrapped`.

  ## Parameters

  - `args` (term())
  - `kwargs` (term())

  ## Returns

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

  @doc """
  Python binding for `dspy.dsp.colbertv2.colbertv2_post_request`.

  ## Parameters

  - `args` (term())
  - `kwargs` (term())

  ## Returns

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

  @doc """
  Python binding for `dspy.dsp.colbertv2.colbertv2_post_request_v2`.

  ## Parameters

  - `url` (String.t())
  - `query` (String.t())
  - `k` (integer())

  ## Returns

  - `term()`
  """
  @spec colbertv2_post_request_v2(String.t(), String.t(), integer(), keyword()) ::
          {:ok, term()} | {:error, Snakepit.Error.t()}
  def colbertv2_post_request_v2(url, query, k, opts \\ []) do
    SnakeBridge.Runtime.call(__MODULE__, :colbertv2_post_request_v2, [url, query, k], opts)
  end

  @doc """
  Python binding for `dspy.dsp.colbertv2.colbertv2_post_request_v2_wrapped`.

  ## Parameters

  - `args` (term())
  - `kwargs` (term())

  ## Returns

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