Deployed 70e580e to develop in chatgpt-telegram-bot/en with MkDocs 1.4.2 and mike 1.1.2

chatgpt-telegram-bot/en/develop/index.html

@@ -361,6 +361,19 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#demo" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        <span class="md-typeset">
+          Demo
+        </span>
+      
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#features" class="md-nav__link">
     <span class="md-ellipsis">
@@ -386,6 +399,19 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#inline-mode" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        <span class="md-typeset">
+          Inline Mode
+        </span>
+      
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -431,6 +457,19 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#environment-variables" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        <span class="md-typeset">
+          Environment variables
+        </span>
+      
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -531,15 +570,63 @@
 <p>(с) Generated by ChatGPT</p>
 </blockquote>
 <p>But seriously, the project uses your ChatGPT token to access the ChatGPT API and let you chat with ChatGPT directly in Telegram.</p>
-<h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">⚓︎</a></h2>
+<div class="admonition danger">
+<p class="admonition-title">Disclaimer</p>
+<p>This is a personal project and is not affiliated with OpenAI in any way.</p>
+</div>
+<h2 id="demo">Demo<a class="headerlink" href="#demo" title="Permanent link">⚓︎</a></h2>
 <p>See for yourself how easy and convenient it is to use ChatGPT in Telegram. It is better to see once than to hear 100 times.</p>
-<video controls>
+<video controls width="450">
       <source id="mp4" src="demo.mp4" type="video/mp4">
 </video>
 
+<h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">⚓︎</a></h2>
+<p>Key Features:</p>
+<ul>
+<li>Saving the context of a conversation</li>
+<li><img alt="🆕" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f195.svg" title=":new:" /> Access can be restricted by specifying a list of allowed users.</li>
+<li><img alt="🆕" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f195.svg" title=":new:" /> Support for multiple chats for one user</li>
+<li>Support markdown in answers</li>
+<li><img alt="🆕" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f195.svg" title=":new:" /> Ability to set behavior for the conversation, which will be preserved even when the context is cleared</li>
+<li>Docker and Proxy support</li>
+<li><img alt="🆕" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f195.svg" title=":new:" /> Possibility to check expenses for the current month</li>
+<li><img alt="🆕" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f195.svg" title=":new:" /> Tells you how many tokens you spent to generate a response</li>
+<li><img alt="🆕" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f195.svg" title=":new:" /> Support Telegram Inline Mode</li>
+</ul>
 <h3 id="commands">Commands<a class="headerlink" href="#commands" title="Permanent link">⚓︎</a></h3>
-<p><code>/clear_context</code> - Clears the conversation context. In fact, it deletes the chat and creates a new one.</p>
+<p>List of available commands to control the bot.</p>
+<h4 id="chat-commands">Chat commands<a class="headerlink" href="#chat-commands" title="Permanent link">⚓︎</a></h4>
+<p><code>/chat chat_name</code> - allows you to create a new chat or switch to an existing one.</p>
+<p><code>/chat</code> - allows you to return to normal chat. Also displays a list of created chats.</p>
+<p><code>/close_chat</code> - closes the chat room. You get to the default chat room.</p>
+<p><code>/clear_context</code> - clears the chat context. In fact, it deletes the chat and creates a new one. The behavior is maintained, as opposed to closing the chat room.</p>
 <p><code>/prompt your_question</code> - Allows you to ask a question outside the context of the main conversation.</p>
+<p><code>/current_chat</code> - returns the name of the current chat.</p>
+<h4 id="behavior-commands">Behavior commands<a class="headerlink" href="#behavior-commands" title="Permanent link">⚓︎</a></h4>
+<p>In fact, the first message at the beginning of the chat, which tells how the AI should react. It is saved when the context is cleared, but is not saved when the chat is closed.</p>
+<div class="admonition note">
+<p>These commands work within the current chat, and do not affect other chats.</p>
+</div>
+<p><code>/behavior behavior_description</code> - sets the bot's behavior for the current chat. </p>
+<p><code>/current_behavior</code> - get the current behavior setting for the current chat.</p>
+<p><code>/clear_behavior</code> - removes the behavior settings for the current chat.</p>
+<h4 id="other-commands">Other commands<a class="headerlink" href="#other-commands" title="Permanent link">⚓︎</a></h4>
+<p><code>/balance</code> - Allows you to see the amount of money spent this month. Works only when you specify bot admins.</p>
+<h3 id="inline-mode">Inline Mode<a class="headerlink" href="#inline-mode" title="Permanent link">⚓︎</a></h3>
+<p>Inline mode allows you to use the bot in group chat, private chat, or in comments. Here's how it works:</p>
+<video controls width="300">
+      <source id="mp4" src="inline.mp4" type="video/mp4">
+</video>
+
+<p>But for this mode to work it needs to be set up:</p>
+<video controls width="450">
+      <source id="mp4" src="inline-setting.mp4" type="video/mp4">
+</video>
+
+<div class="admonition warning">
+<p class="admonition-title">setinlinefeedback</p>
+<p>Be sure to activate <code>/setinlinefeedback</code>, otherwise nothing will work.</p>
+</div>
 <h2 id="privacy">Privacy<a class="headerlink" href="#privacy" title="Permanent link">⚓︎</a></h2>
 <p>See my last name in the domain? <a href="https://mark.struchkov.dev">I'm a developer</a>, <a href="https://struchkov.dev/blog/ru/">blogger</a>, and publicly active. I don't have the benefit of getting dirty under my own name. I assure you that your data is not transferred to third parties, even I do not know about your requests to ChatGPT. You can see for yourself by examining the code, it's opensource.</p>
 <h2 id="lets-get-started">Let's get started<a class="headerlink" href="#lets-get-started" title="Permanent link">⚓︎</a></h2>
@@ -551,35 +638,46 @@
 <li>You also need <a href="https://platform.openai.com/account/api-keys">ChatGPT access token</a>.</li>
 <li>You must know your telegramId. <a href="https://t.me/myidbot">You can find it out here.</a>.</li>
 </ul>
+<h3 id="environment-variables">Environment variables<a class="headerlink" href="#environment-variables" title="Permanent link">⚓︎</a></h3>
+<ul>
+<li><code>TELEGRAM_BOT_TOKEN</code> - The bot access token you got from GodFather. Example: 1234567890:XXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</li>
+<li><code>TELEGRAM_BOT_USERNAME</code> - Specify a name with the ending bot here, not a public name. Example: Undusted_bot</li>
+<li><code>TELEGRAM_PERSON_ID</code> - The IDs of the users on Telegram who are allowed access. Example: 1234567, 56789045</li>
+<li><code>ADMIN_TELEGRAM_PERSON_ID</code> - The IDs of the users on Telegram who are allowed admin access. Example: 1234567</li>
+<li><code>CHAT_GPT_TOKEN</code> - OpenAI API access token.</li>
+</ul>
 <h3 id="docker-run">Docker Run<a class="headerlink" href="#docker-run" title="Permanent link">⚓︎</a></h3>
 <div class="admonition note">
 <p class="admonition-title">Support</p>
-<p>The following platforms are supported: linux/amd64,linux/arm64/v8</p>
+<p>The following platforms are supported: linux/amd64, linux/arm64/v8</p>
 </div>
 <div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--name<span class="w"> </span>chatgpt-telegram-bot<span class="w"> </span><span class="se">\</span>
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_BOT_TOKEN</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
 </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_BOT_USERNAME</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PERSON_ID</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">CHAT_GPT_TOKEN</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">ADMIN_TELEGRAM_PERSON_ID</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w">    </span>upagge/chatgpt-telegram-bot:develop
+</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">CHAT_GPT_TOKEN</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w">    </span>upagge/chatgpt-telegram-bot:develop
 </span></code></pre></div>
-<div class="admonition warning">
-<p><code>TELEGRAM_BOT_USERNAME</code> - Specify a name with the ending bot here, not a public name.</p>
-</div>
 <h4 id="telegram-proxy">Telegram Proxy<a class="headerlink" href="#telegram-proxy" title="Permanent link">⚓︎</a></h4>
 <p>If you have Telegram blocked, you can specify proxy settings to connect.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Requests to OpenAI will not be made through a proxy</p>
+</div>
 <div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span>--name<span class="w"> </span>chatgpt-telegram-bot<span class="w"> </span><span class="se">\</span>
 </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_BOT_TOKEN</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
 </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_BOT_USERNAME</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
 </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PERSON_ID</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">CHAT_GPT_TOKEN</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">ADMIN_TELEGRAM_PERSON_ID</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_ENABLE</span><span class="o">=</span><span class="nb">true</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">CHAT_GPT_TOKEN</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_HOST</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_ENABLE</span><span class="o">=</span><span class="nb">true</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_PORT</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_HOST</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_TYPE</span><span class="o">=</span>SOCKS5<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_PORT</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_USERNAME</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_TYPE</span><span class="o">=</span>SOCKS5<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_PASSWORD</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_USERNAME</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-12"><a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w">    </span>upagge/chatgpt-telegram-bot:latest
+</span><span id="__span-1-12"><a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w">    </span>--env<span class="w"> </span><span class="nv">TELEGRAM_PROXY_PASSWORD</span><span class="o">=</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-1-13"><a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w">    </span>upagge/chatgpt-telegram-bot:latest
 </span></code></pre></div>
 <div class="admonition note">
 <ul>
@@ -605,14 +703,16 @@
 </span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w">      </span><span class="nt">TELEGRAM_BOT_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${TELEGRAM_BOT_TOKEN}</span>
 </span><span id="__span-2-10"><a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w">      </span><span class="nt">TELEGRAM_BOT_USERNAME</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${TELEGRAM_BOT_USERNAME}</span>
 </span><span id="__span-2-11"><a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="w">      </span><span class="nt">TELEGRAM_PERSON_ID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${TELEGRAM_PERSON_ID}</span>
-</span><span id="__span-2-12"><a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="w">      </span><span class="nt">CHAT_GPT_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${CHAT_GPT_TOKEN}</span>
+</span><span id="__span-2-12"><a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="w">      </span><span class="nt">ADMIN_TELEGRAM_PERSON_ID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${ADMIN_TELEGRAM_PERSON_ID}</span>
+</span><span id="__span-2-13"><a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="w">      </span><span class="nt">CHAT_GPT_TOKEN</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${CHAT_GPT_TOKEN}</span>
 </span></code></pre></div>
 </div>
 <div class="tabbed-block">
 <div class="language-text highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>TELEGRAM_BOT_TOKEN=
 </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>TELEGRAM_BOT_USERNAME=
 </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>TELEGRAM_PERSON_ID=
-</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>CHAT_GPT_TOKEN=
+</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>ADMIN_TELEGRAM_PERSON_ID=
+</span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>CHAT_GPT_TOKEN=
 </span></code></pre></div>
 </div>
 </div>
@@ -642,6 +742,10 @@
 <summary>What model is used?</summary>
 <p>For now the <code>gpt-3.5-turbo</code> model is used. In future versions you will be able to choose the model.</p>
 </details>
+<details class="question">
+<summary>What happens if my reply is longer than the allowed number of characters in one Telegram message?</summary>
+<p>That's okay, the answer will be broken up into several posts.</p>
+</details>
 <h2 id="other-questions">Other Questions<a class="headerlink" href="#other-questions" title="Permanent link">⚓︎</a></h2>
 <p>If you don't understand something, you can ask a question here <img alt="👇" class="twemoji" src="https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f447.svg" title=":point_down:" /> or in a <a href="https://github.com/uPagge/openai-chatgpt-telegram-bot/discussions">discussion on GitHub.</a></p>
 

chatgpt-telegram-bot/en/develop/sitemap.xml

@@ -2,7 +2,7 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://docs.struchkov.dev/chatgpt-telegram-bot/en/develop/</loc>
-         <lastmod>2023-03-27</lastmod>
+         <lastmod>2023-03-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>