956 lines
23 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../quickstart/">
<link rel="next" href="../cmd/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.12">
<title>Model and languages - bilingual book maker</title>
<link rel="stylesheet" href="../assets/stylesheets/main.2afb09e1.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#model-and-languages" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="bilingual book maker" class="md-header__button md-logo" aria-label="bilingual book maker" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
bilingual book maker
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Model and languages
</span>
</div>
</div>
</div>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../installation/" class="md-tabs__link">
Getting started
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Usage
</a>
</li>
<li class="md-tabs__item">
<a href="../disclaimer/" class="md-tabs__link">
Disclaimer
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="bilingual book maker" class="md-nav__button md-logo" aria-label="bilingual book maker" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
bilingual book maker
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../quickstart/" class="md-nav__link">
<span class="md-ellipsis">
QuickStart
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Usage
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Usage
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Model and languages
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Model and languages
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#models" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
<nav class="md-nav" aria-label="Models">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openai-models" class="md-nav__link">
<span class="md-ellipsis">
OPENAI models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#caiyun" class="md-nav__link">
<span class="md-ellipsis">
CAIYUN
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#deepl" class="md-nav__link">
<span class="md-ellipsis">
DEEPL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#claude" class="md-nav__link">
<span class="md-ellipsis">
Claude
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#custom-api" class="md-nav__link">
<span class="md-ellipsis">
Custom API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#google" class="md-nav__link">
<span class="md-ellipsis">
Google
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#languages" class="md-nav__link">
<span class="md-ellipsis">
Languages
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../cmd/" class="md-nav__link">
<span class="md-ellipsis">
Command line options
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../book_source/" class="md-nav__link">
<span class="md-ellipsis">
Translate from different source
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../env_settings/" class="md-nav__link">
<span class="md-ellipsis">
Environment setting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../prompt/" class="md-nav__link">
<span class="md-ellipsis">
Tweak the prompt
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../disclaimer/" class="md-nav__link">
<span class="md-ellipsis">
Disclaimer
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#models" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
<nav class="md-nav" aria-label="Models">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openai-models" class="md-nav__link">
<span class="md-ellipsis">
OPENAI models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#caiyun" class="md-nav__link">
<span class="md-ellipsis">
CAIYUN
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#deepl" class="md-nav__link">
<span class="md-ellipsis">
DEEPL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#claude" class="md-nav__link">
<span class="md-ellipsis">
Claude
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#custom-api" class="md-nav__link">
<span class="md-ellipsis">
Custom API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#google" class="md-nav__link">
<span class="md-ellipsis">
Google
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#languages" class="md-nav__link">
<span class="md-ellipsis">
Languages
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="model-and-languages">Model and Languages</h1>
<h2 id="models">Models</h2>
<p><code>-m, --model &lt;Model&gt;</code> <br></p>
<p>Currently <code>bbook_maker</code> supports these models: <code>chatgptapi</code> , <code>gpt3</code> , <code>google</code> , <code>caiyun</code> , <code>deepl</code> , <code>deeplfree</code> , <code>gpt4</code> , <code>gpt4omini</code> , <code>o1-preview</code> , <code>o1</code> , <code>o1-mini</code> , <code>o3-mini</code> , <code>claude</code> , <code>customapi</code>.
Default model is <code>chatgptapi</code> . </p>
<h3 id="openai-models">OPENAI models</h3>
<p>There are three models you can choose from.</p>
<ul>
<li>
<p>gpt3</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model gpt3 --openai_key ${openai_key}
</code></pre>
</li>
<li>
<p>chatgpiapi</p>
<p><code>chatgptapi</code> is <a href="https://openai.com/blog/introducing-chatgpt-and-whisper-apis">GPT-3.5-turbo</a>, which is used by ChatGPT currently.</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model chatgptapi --openai_key ${openai_key}
</code></pre>
</li>
<li>
<p>gpt4</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model gpt4 --openai_key ${openai_key}
</code></pre>
<p>If using <code>gpt4</code> , you can add <code>--use_context</code> to add a context paragraph to each passage sent to the model for translation.</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model gpt4 --openai_key ${openai_key} --use_context
</code></pre>
<p>The option <code>--use_context</code> prompts the GPT4 model to create a one-paragraph summary. </p>
<p>If it is the beginning of the translation, it will summarize the entire passage sent (the size depending on <code>--accumulated_num</code> ).</p>
<p>If it has any proceeding passage, it will amend the summary to include details from the most recent passage, creating a running one-paragraph context payload of the important details of the entire translated work, which improves consistency of flow and tone of each translation.</p>
</li>
</ul>
<p><strong>Note 1: Use <code>--openai_key</code> option to specify OpenAI API key. If you have multiple keys, separate them by commas (xxx, xxx, xxx) to reduce errors caused by API call limits.</strong></p>
<p><strong>Note 2: You can just set the environment variable <code>BBM_OPENAI_API_KEY</code> instead the openai_key. See <a href="settings.md">Environment setting</a>.</strong></p>
<h3 id="caiyun">CAIYUN</h3>
<p>Using Caiyun model to translate. The api currently only support: </p>
<ol>
<li>Simplified Chinese &lt;-&gt; English</li>
<li>Simplified Chinese &lt;-&gt; Japanese</li>
</ol>
<p>The official Caiyun has provided a test token (3975l6lr5pcbvidl6jl2). You can apply your own token by following this [tutorial].(https://bobtranslate.com/service/translate/caiyun.html)</p>
<pre><code>bbook_maker --model caiyun --caiyun_key 3975l6lr5pcbvidl6jl2 --book_name test_books/animal_farm.epub
</code></pre>
<h3 id="deepl">DEEPL</h3>
<p>There are two models you can choose from.</p>
<ul>
<li>
<p>deepl: <a href="https://rapidapi.com/splintPRO/api/dpl-translator">DeepL Translator</a>. <br></p>
<p>Need to pay to get the token. Use <code>--model deepl --deepl_key ${deepl_key}</code></p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model deepl --deepl_key ${deepl_key}
</code></pre>
</li>
<li>
<p>deeplfree: DeepL free model</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model deeplfree
</code></pre>
</li>
</ul>
<h3 id="claude">Claude</h3>
<p>Support <a href="https://console.anthropic.com/docs">Claude</a> model. Use <code>--model claude --claude_key ${claude_key}</code> .</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model claude --claude_key ${claude_key}
</code></pre>
<h3 id="custom-api">Custom API</h3>
<p>Support CustomAPI model. Use <code>--model customapi --custom_api ${custom_api}</code> .</p>
<pre><code>bbook_maker --book_name test_books/animal_farm.epub --model customapi --custom_api ${custom_api}
</code></pre>
<h3 id="google">Google</h3>
<p>Support google model. Use <code>--model google</code></p>
<h2 id="languages">Languages</h2>
<p><code>--language &lt;LANGUAGE&gt;</code> <br></p>
<p>Set target languages. All models except for <code>caiyun</code> supports lots of languages. You can use <code>bbook_maker --help</code> to check available languages. Default target language is <code>"Simplified Chinese"</code> .</p>
<pre><code class="language-sh">bbook_maker --book_name test_books/animal_farm.epub --model chatgptapi --openai_key ${openai_key} --language ja
</code></pre>
<pre><code class="language-sh">bbook_maker --book_name test_books/animal_farm.epub --model chatgptapi --openai_key ${openai_key} --language &quot;Simplified Chinese&quot;
</code></pre>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.tabs.sticky", "content.code.copy"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.c8b220af.min.js"></script>
</body>
</html>