@spec rephrase(text(), String.t(), Keyword.t()) :: {:ok, map()} | {:error, String.t()}

Rephrases the given text to the target language.

The text parameter can be a single string or a list of strings, and the target_lang parameter available languages can be found in the Improve text documentation.

Options

The accepted options are:

• :writing_style - Changes the writing style of your improvements, the value must be a string.
• :tone - Changes the tone of your improvements, the value must be a string.

The values for :writing_style can be:

• "simple", "business", "academic", "casual", "default", "prefer_simple", "prefer_business", "prefer_academic", "prefer_casual".

The values for :tone can be:

• "friendly", "enthusiastic", "confident", "diplomatic", "default", "prefer_enthusiastic", "prefer_friendly", "prefer_confident", "prefer_diplomatic".

Examples

iex> Deepl.Writer.rephrase("this is a example sentence to imprve", "en-US")
{:ok,
 %{
   "improvements" => [
     %{
       "detected_source_language" => "en",
       "target_language" => "en-US",
       "text" => "This is a sample sentence to improve"
     }
   ]
 }}

iex> Deepl.Writer.rephrase(
...>  ["this is a example sentence to imprve", "this exmaple too"],
...>  "en-US",
...>  writing_style: "casual"
...> )
{:ok,
 %{
   "improvements" => [
     %{
       "detected_source_language" => "en",
       "target_language" => "en-US",
       "text" => "Here's an example sentence that could be improved:"
     },
     %{
       "detected_source_language" => "en",
       "target_language" => "en-US",
       "text" => "Here's another example to consider."
     }
   ]
 }}

@spec rephrase!(text(), String.t(), Keyword.t()) :: map()

Rephrases the given text to the target language.

This function behaves like rephrase/3, but raises an error if the rephrasing fails.