dspex

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

defmodule Dspy.Dsp.Utils.Dpr do
  @moduledoc """
  Submodule bindings for `dspy.dsp.utils.dpr`.
  """

  def __snakebridge_python_name__, do: "dspy.dsp.utils.dpr"
  def __snakebridge_library__, do: "dspy"

  @doc """
  Source: DPR Implementation from Facebook Research

  https://github.com/facebookresearch/DPR/tree/master/dpr
  Original license: https://github.com/facebookresearch/DPR/blob/main/LICENSE

  Parameters:
  - `text` (term())

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

  @doc """
  Source: DPR Implementation from Facebook Research

  https://github.com/facebookresearch/DPR/tree/master/dpr
  Original license: https://github.com/facebookresearch/DPR/blob/main/LICENSE

  Parameters:
  - `text` (term())

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

  @doc """
  Source: DPR Implementation from Facebook Research

  https://github.com/facebookresearch/DPR/tree/master/dpr
  Original license: https://github.com/facebookresearch/DPR/blob/main/LICENSE

  Parameters:
  - `tokenized_answers` (term())
  - `text` (term())

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

  @doc """
  Returns each occurrence of an answer as (offset, endpos) in terms of *characters*.

  Parameters:
  - `tokenized_answers` (term())
  - `text` (term())

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

  @doc """
  Source: DPR Implementation from Facebook Research

  https://github.com/facebookresearch/DPR/tree/master/dpr
  Original license: https://github.com/facebookresearch/DPR/blob/main/LICENSE

  Returns:
  - `Dspy.Dsp.Utils.Dpr.SimpleTokenizer.t()`
  """
  @spec s_tokenizer() ::
          {:ok, Dspy.Dsp.Utils.Dpr.SimpleTokenizer.t()} | {:error, Snakepit.Error.t()}
  def s_tokenizer() do
    SnakeBridge.Runtime.get_module_attr(__MODULE__, "STokenizer")
  end

  @doc """
  Strips accents from a piece of text.

  Parameters:
  - `text` (term())

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