mirror of
https://github.com/chidiwilliams/buzz.git
synced 2026-03-14 14:45:46 +01:00
29 lines
No EOL
26 KiB
HTML
29 lines
No EOL
26 KiB
HTML
<!doctype html>
|
||
<html lang="en-US" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-preferences">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.1">
|
||
<title data-rh="true">Preferences | Buzz</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://chidiwilliams.github.io/buzz/img/favicon.ico"><meta data-rh="true" name="twitter:image" content="https://chidiwilliams.github.io/buzz/img/favicon.ico"><meta data-rh="true" property="og:url" content="https://chidiwilliams.github.io/buzz/docs/preferences"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Preferences | Buzz"><meta data-rh="true" name="description" content="Open the Preferences window from the Menu bar, or click Ctrl/Cmd + ,."><meta data-rh="true" property="og:description" content="Open the Preferences window from the Menu bar, or click Ctrl/Cmd + ,."><link data-rh="true" rel="icon" href="/buzz/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chidiwilliams.github.io/buzz/docs/preferences"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/preferences" hreflang="en-US"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/zh/docs/preferences" hreflang="zh-CN"><link data-rh="true" rel="alternate" href="https://chidiwilliams.github.io/buzz/docs/preferences" hreflang="x-default"><link rel="stylesheet" href="/buzz/assets/css/styles.5917496c.css">
|
||
<link rel="preload" href="/buzz/assets/js/runtime~main.9d96f918.js" as="script">
|
||
<link rel="preload" href="/buzz/assets/js/main.87e50cc1.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/buzz/"><div class="navbar__logo"><img src="/buzz/img/favicon.ico" alt="Buzz" class="themedImage_ToTc themedImage--light_HNdA"><img src="/buzz/img/favicon.ico" alt="Buzz" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Buzz</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/buzz/docs">Docs</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/buzz/docs/preferences" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en-US">English</a></li><li><a href="/buzz/zh/docs/preferences" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh-CN">简体中文</a></li></ul></div></div><div class="navbar__items navbar__items--right"><a href="https://github.com/chidiwilliams/buzz" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs/installation">Installation</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/buzz/docs/usage/file_import">Usage</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/buzz/docs/preferences">Preferences</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs/cli">CLI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/buzz/docs/faq">FAQ</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/buzz/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Preferences</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Preferences</h1></header><p>Open the Preferences window from the Menu bar, or click <code>Ctrl/Cmd + ,</code>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="general-preferences">General Preferences<a href="#general-preferences" class="hash-link" aria-label="Direct link to General Preferences" title="Direct link to General Preferences"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="openai-api-preferences">OpenAI API preferences<a href="#openai-api-preferences" class="hash-link" aria-label="Direct link to OpenAI API preferences" title="Direct link to OpenAI API preferences"></a></h3><p><strong>API Key</strong> - key to authenticate your requests to OpenAI API. To get API key from OpenAI see <a href="https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key" target="_blank" rel="noopener noreferrer">this article</a>.</p><p><strong>Base URL</strong> - By default all requests are sent to API provided by OpenAI company. Their API URL is <code>https://api.openai.com/v1/</code>. Compatible APIs are also provided by other companies. List of available API URLs and services to run yourself are available on <a href="https://github.com/chidiwilliams/buzz/discussions/827" target="_blank" rel="noopener noreferrer">discussion page</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="default-export-file-name">Default export file name<a href="#default-export-file-name" class="hash-link" aria-label="Direct link to Default export file name" title="Direct link to Default export file name"></a></h3><p>Sets the default export file name for file transcriptions. For
|
||
example, a value of <code>{{ input_file_name }} ({{ task }}d on {{ date_time }})</code> will save TXT exports
|
||
as <code>Input Filename (transcribed on 19-Sep-2023 20-39-25).txt</code> by default.</p><p>Available variables:</p><table><thead><tr><th>Key</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>input_file_name</code></td><td>File name of the imported file</td><td><code>audio</code> (e.g. if the imported file path was <code>/path/to/audio.wav</code></td></tr><tr><td><code>task</code></td><td>Transcription task</td><td><code>transcribe</code>, <code>translate</code></td></tr><tr><td><code>language</code></td><td>Language code</td><td><code>en</code>, <code>fr</code>, <code>yo</code>, etc.</td></tr><tr><td><code>model_type</code></td><td>Model type</td><td><code>Whisper</code>, <code>Whisper.cpp</code>, <code>Faster Whisper</code>, etc.</td></tr><tr><td><code>model_size</code></td><td>Model size</td><td><code>tiny</code>, <code>base</code>, <code>small</code>, <code>medium</code>, <code>large</code>, etc.</td></tr><tr><td><code>date_time</code></td><td>Export time (format: <code>%d-%b-%Y %H-%M-%S</code>)</td><td><code>19-Sep-2023 20-39-25</code></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="live-transcript-exports">Live transcript exports<a href="#live-transcript-exports" class="hash-link" aria-label="Direct link to Live transcript exports" title="Direct link to Live transcript exports"></a></h3><p>Live transcription export can be used to integrate Buzz with other applications like OBS Studio.
|
||
When enabled, live text transcripts will be exported to a text file as they get generated and translated.</p><p>If AI translation is enabled for live recordings, the translated text will also be exported to the text file.
|
||
Filename for the translated text will end with <code>.translated.txt</code>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="live-transcription-mode">Live transcription mode<a href="#live-transcription-mode" class="hash-link" aria-label="Direct link to Live transcription mode" title="Direct link to Live transcription mode"></a></h3><p>Three transcription modes are available:</p><p><strong>Append below</strong> - New sentences will be added below existing with an empty space between them.
|
||
Last sentence will be at the bottom.</p><p><strong>Append above</strong> - New sentences will be added above existing with an empty space between them.
|
||
Last sentence will be at the top.</p><p><strong>Append and correct</strong> - New sentences will be added at the end of existing transcript without extra spaces between.
|
||
This mode will also try to correct errors at the end of previously transcribed sentences. This mode requires more
|
||
processing power and more powerful hardware to work.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="model-preferences">Model Preferences<a href="#model-preferences" class="hash-link" aria-label="Direct link to Model Preferences" title="Direct link to Model Preferences"></a></h2><p>This section lets you download new models for transcription and delete unused ones.</p><p>For Whisper.cpp you can also download custom models. Select <code>Custom</code> in the model size list and paste the download url
|
||
to the model <code>.bin</code> file. Use the link from "download" button from the Huggingface. </p><p>To improve transcription speed and memory usage you can select a quantized version of some
|
||
larger model. For example <code>q_5</code> version. Whisper.cpp base models in different quantizations are <a href="https://huggingface.co/ggerganov/whisper.cpp/tree/main" target="_blank" rel="noopener noreferrer">available here</a>. See also <a href="https://github.com/chidiwilliams/buzz/discussions/866" target="_blank" rel="noopener noreferrer">custom models</a> discussion page for custom models in different languages.</p><p><a href="https://www.loom.com/share/cf263b099ac3481082bb56d19b7c87fe" target="_blank" rel="noopener noreferrer" title="Model preferences"><img loading="lazy" src="https://raw.githubusercontent.com/chidiwilliams/buzz/main/share/screenshots/buzz-3.2-model-preferences.png" alt="Model preferences" class="img_ev3q"></a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="advanced-preferences">Advanced Preferences<a href="#advanced-preferences" class="hash-link" aria-label="Direct link to Advanced Preferences" title="Direct link to Advanced Preferences"></a></h2><p>To keep preferences section simple for new users, some more advanced preferences are settable via OS environment variables. Set the necessary environment variables in your OS before starting Buzz or create a script to set them.</p><p>On MacOS and Linux crete <code>run_buzz.sh</code> with the following content:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token shebang important">#!/bin/bash</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token builtin class-name">export</span><span class="token plain"> </span><span class="token assign-left variable" style="color:#36acaa">VARIABLE</span><span class="token operator" style="color:#393A34">=</span><span class="token plain">value</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token builtin class-name">export</span><span class="token plain"> </span><span class="token assign-left variable" style="color:#36acaa">SOME_OTHER_VARIABLE</span><span class="token operator" style="color:#393A34">=</span><span class="token plain">some_other_value</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">buzz</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>On Windows crete <code>run_buzz.bat</code> with the following content:</p><div class="language-bat codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bat codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">@echo off</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">set VARIABLE=value</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">set SOME_OTHER_VARIABLE=some_other_value</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">"C:\Program Files (x86)\Buzz\Buzz.exe"</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Alternatively you can set environment variables in your OS settings. See <a href="https://phoenixnap.com/kb/windows-set-environment-variable#ftoc-heading-4" target="_blank" rel="noopener noreferrer">this guide</a> or <a href="https://www.youtube.com/watch?v=bEroNNzqlF4" target="_blank" rel="noopener noreferrer">this video</a> more information.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="available-variables">Available variables<a href="#available-variables" class="hash-link" aria-label="Direct link to Available variables" title="Direct link to Available variables"></a></h3><p><strong>BUZZ_WHISPERCPP_N_THREADS</strong> - Number of threads to use for Whisper.cpp model. Default is half of available CPU cores.</p><p>On a laptop with 16 threads setting <code>BUZZ_WHISPERCPP_N_THREADS=8</code> leads to some 15% speedup in transcription time.
|
||
Increasing number of threads even more will lead in slower transcription time as results from parallel threads has to be
|
||
combined to produce the final answer.</p><p><strong>BUZZ_TRANSLATION_API_BASE_URL</strong> - Base URL of OpenAI compatible API to use for translation.</p><p><strong>BUZZ_TRANSLATION_API_KEY</strong> - Api key of OpenAI compatible API to use for translation.</p><p><strong>BUZZ_MODEL_ROOT</strong> - Root directory to store model files. You may also want to set <code>HF_HOME</code> to the same folder as some libraries used in Buzz download their models independently.
|
||
Defaults to <a href="https://pypi.org/project/platformdirs/" target="_blank" rel="noopener noreferrer">user_cache_dir</a>.</p><p><strong>BUZZ_FAVORITE_LANGUAGES</strong> - Coma separated list of supported language codes to show on top of language list.</p><p><strong>BUZZ_DOWNLOAD_COOKIEFILE</strong> - Location of a <a href="https://github.com/yt-dlp/yt-dlp/wiki/FAQ#how-do-i-pass-cookies-to-yt-dlp" target="_blank" rel="noopener noreferrer">cookiefile</a> to use for downloading private videos or as workaround for anti-bot protection.</p><p><strong>BUZZ_FORCE_CPU</strong> - Will force Buzz to use CPU and not GPU, useful for setups with older GPU if that is slower than GPU or GPU has issues. Example usage <code>BUZZ_FORCE_CPU=true</code>. Available since <code>1.2.1</code></p><p><strong>BUZZ_MERGE_REGROUP_RULE</strong> - Custom regroup merge rule to use when combining transcripts with word-level timings. More information on available options <a href="https://github.com/jianfch/stable-ts?tab=readme-ov-file#regrouping-methods" target="_blank" rel="noopener noreferrer">in stable-ts repo</a>. Available since <code>1.3.0</code></p><p><strong>BUZZ_DISABLE_TELEMETRY</strong> - Buzz collects basic OS name and architecture usage statistics to better focus development efforts. This variable lets disable collection of these statistics. Example usage <code>BUZZ_DISABLE_TELEMETRY=true</code>. Available since <code>1.3.0</code></p><p><strong>BUZZ_UPLOAD_URL</strong> - Live recording transcripts and translations can be uploaded to a server for display on the web. Set this variable to the desired upload url. You can use <a href="https://github.com/raivisdejus/buzz-transcription-server" target="_blank" rel="noopener noreferrer">buzz-transcription-server</a> as a server. Buzz will upload the following <code>json</code> via <code>POST</code> requests - <code>{"kind": "transcript", "text": "Sample transcript"}</code> or <code>{"kind": "translation", "text": "Sample translation"}</code>. Example usage <code>BUZZ_UPLOAD_URL=http://localhost:5000/upload</code>. Available since <code>1.3.0</code></p><p>Example of data collected by telemetry:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Buzz: 1.3.0, locale: ('lv_LV', 'UTF-8'), system: Linux, release: 6.14.0-27-generic, machine: x86_64, version: #27~24.04.1-Ubuntu SMP PREEMPT_DYNAMIC Tue Jul 22 17:38:49 UTC 2,</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p><strong>BUZZ_PARAGRAPH_SPLIT_TIME</strong> - Time in milliseconds of silence to split paragraphs in transcript and add two newlines when exporting the transcripts as text. Default is <code>2000</code> or 2 seconds. Available since <code>1.3.0</code></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/buzz/docs/usage/transcription_viewer"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Transcription Viewer</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/buzz/docs/cli"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">CLI</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#general-preferences" class="table-of-contents__link toc-highlight">General Preferences</a><ul><li><a href="#openai-api-preferences" class="table-of-contents__link toc-highlight">OpenAI API preferences</a></li><li><a href="#default-export-file-name" class="table-of-contents__link toc-highlight">Default export file name</a></li><li><a href="#live-transcript-exports" class="table-of-contents__link toc-highlight">Live transcript exports</a></li><li><a href="#live-transcription-mode" class="table-of-contents__link toc-highlight">Live transcription mode</a></li></ul></li><li><a href="#model-preferences" class="table-of-contents__link toc-highlight">Model Preferences</a></li><li><a href="#advanced-preferences" class="table-of-contents__link toc-highlight">Advanced Preferences</a><ul><li><a href="#available-variables" class="table-of-contents__link toc-highlight">Available variables</a></li></ul></li></ul></div></div></div></div></main></div></div></div>
|
||
<script src="/buzz/assets/js/runtime~main.9d96f918.js"></script>
|
||
<script src="/buzz/assets/js/main.87e50cc1.js"></script>
|
||
</body>
|
||
</html> |