prompt/prompt-executor/prompt-executor-clients/ai.koog.prompt.executor.clients.retry/-retry-config/-companion/index.html (217 lines of code) (raw):

<!doctype html> <html class="no-js" lang="en"> <head> <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8"> <title>Companion</title> <link href="../../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../../../../";</script> <script>document.documentElement.classList.replace("no-js", "js");</script> <script>const storage = localStorage.getItem("dokka-dark-mode") if (storage == null) { const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches if (osDarkSchemePreferred === true) { document.getElementsByTagName("html")[0].classList.add("theme-dark") } } else { const savedDarkMode = JSON.parse(storage) if (savedDarkMode === true) { document.getElementsByTagName("html")[0].classList.add("theme-dark") } } </script> <script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script> <script type="text/javascript" src="../../../../../../scripts/sourceset_dependencies.js" async></script> <link href="../../../../../../styles/style.css" rel="Stylesheet"> <link href="../../../../../../styles/main.css" rel="Stylesheet"> <link href="../../../../../../styles/prism.css" rel="Stylesheet"> <link href="../../../../../../styles/logo-styles.css" rel="Stylesheet"> <link href="../../../../../../ui-kit/ui-kit.min.css" rel="Stylesheet"> <script type="text/javascript" src="../../../../../../scripts/safe-local-storage_blocking.js"></script> <script type="text/javascript" src="../../../../../../scripts/navigation-loader.js" async></script> <script type="text/javascript" src="../../../../../../scripts/platform-content-handler.js" async></script> <script type="text/javascript" src="../../../../../../scripts/main.js" defer></script> <script type="text/javascript" src="../../../../../../scripts/prism.js" async></script> <script type="text/javascript" src="../../../../../../ui-kit/ui-kit.min.js" defer></script></head> <body> <div class="root"> <header class="navigation theme-dark" id="navigation-wrapper" role="banner"> <a class="library-name--link" href="../../../../../../index.html" tabindex="1"> koog </a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents </button> <div class="navigation-controls--break ui-kit_mobile-only"></div> <div class="library-version" id="library-version">0.6.0-SNAPSHOT </div> <div class="navigation-controls"> <ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter"> <button class="platform-tag platform-selector common-like" data-active="" aria-pressed="true" data-filter=":prompt:prompt-executor:prompt-executor-clients/commonMain">common</button> <div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown"> <button class="button button_dropdown filter-section--dropdown-toggle" role="combobox" data-role="dropdown-toggle" aria-controls="platform-tags-listbox" aria-haspopup="listbox" aria-expanded="false" aria-label="Toggle source sets"></button> <ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox" aria-label="Target filter"> <div class="dropdown--header"><span>Target filter</span> <button class="button" data-role="dropdown-toggle" aria-label="Close target filter"> <i class="ui-kit-icon ui-kit-icon_cross"></i> </button> </div> <li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0"> <label class="checkbox"> <input type="checkbox" class="checkbox--input" id=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filter=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <span class="checkbox--icon"></span> common </label> </li> </ul> <div class="dropdown--overlay"></div> </div> </ul> <button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button" type="button">Switch theme </button> <div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in API </div> </div> </header> <div id="container"> <nav id="leftColumn" class="sidebar" data-item-type="SECTION" data-item-config="{&quot;defaultSize&quot;: 280, &quot;minSize&quot;: 200, &quot;maxSize&quot;: 400}"> <a class="toc--skip-link" href="#main">Skip to content</a> <div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown"> <ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list" data-role="dropdown-listbox" aria-label="Table of contents"> <div class="dropdown--header"> <span> koog </span> <button class="button" data-role="dropdown-toggle" aria-label="Close table of contents"> <i class="ui-kit-icon ui-kit-icon_cross"></i> </button> </div> <div class="sidebar--inner" id="sideMenu"></div> </ul> <div class="dropdown--overlay"></div> </div> </nav> <div id="resizer" class="resizer" data-item-type="BAR"></div> <div id="main" data-item-type="SECTION" role="main"> <div class="main-content" data-page-type="classlike" id="content" pageids="prompt-executor-clients::ai.koog.prompt.executor.clients.retry/RetryConfig.Companion///PointingToDeclaration//1536944878"> <div class="breadcrumbs"><a href="../../../index.html">prompt-executor-clients</a><span class="delimiter">/</span><a href="../../index.html">ai.koog.prompt.executor.clients.retry</a><span class="delimiter">/</span><a href="../index.html">RetryConfig</a><span class="delimiter">/</span><span class="current">Companion</span></div> <div class="cover "> <h1 class="cover"><span><span>Companion</span></span></h1> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/JetBrains/koog/tree/main/prompt/prompt-executor/prompt-executor-clients/src/commonMain/kotlin/ai/koog/prompt/executor/clients/retry/RetryConfig.kt#L36">source</a>)</span></span></div><p class="paragraph">Companion object for providing predefined retry configurations and patterns. Contains default retry logic settings that can be used across different use cases, along with scoped configurations for conservative, aggressive, and production environments.</p></div></div> </div> <div class="tabbedcontent"> <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div> <div class="tabs-section-body"> <div data-togglable="PROPERTY"> <h2 class="tableheader">Properties</h2> <div class="table"><a data-name="-632502648%2FProperties%2F1536944878" anchor-label="AGGRESSIVE" id="-632502648%2FProperties%2F1536944878" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"></a> <div class="table-row table-row_content" data-filterable-current=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-a-g-g-r-e-s-s-i-v-e.html"><span><span>AGGRESSIVE</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-632502648%2FProperties%2F1536944878"></span> <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div> </span></span></div> <div> <div class="title"> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-a-g-g-r-e-s-s-i-v-e.html">AGGRESSIVE</a><span class="token operator">: </span><a href="../index.html">RetryConfig</a></div><div class="brief "><p class="paragraph">Aggressive configuration - more retries, shorter delays.</p></div></div></div> </div> </div> </div> </div> <a data-name="1249756351%2FProperties%2F1536944878" anchor-label="CONSERVATIVE" id="1249756351%2FProperties%2F1536944878" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"></a> <div class="table-row table-row_content" data-filterable-current=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-c-o-n-s-e-r-v-a-t-i-v-e.html"><span><span>CONSERVATIVE</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1249756351%2FProperties%2F1536944878"></span> <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div> </span></span></div> <div> <div class="title"> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-c-o-n-s-e-r-v-a-t-i-v-e.html">CONSERVATIVE</a><span class="token operator">: </span><a href="../index.html">RetryConfig</a></div><div class="brief "><p class="paragraph">Conservative configuration - fewer retries, longer delays.</p></div></div></div> </div> </div> </div> </div> <a data-name="-71838515%2FProperties%2F1536944878" anchor-label="DEFAULT" id="-71838515%2FProperties%2F1536944878" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"></a> <div class="table-row table-row_content" data-filterable-current=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-d-e-f-a-u-l-t.html"><span><span>DEFAULT</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-71838515%2FProperties%2F1536944878"></span> <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div> </span></span></div> <div> <div class="title"> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-d-e-f-a-u-l-t.html">DEFAULT</a><span class="token operator">: </span><a href="../index.html">RetryConfig</a></div><div class="brief "><p class="paragraph">The default retry configuration used by clients implementing retry logic.</p></div></div></div> </div> </div> </div> </div> <a data-name="945449643%2FProperties%2F1536944878" anchor-label="DEFAULT_PATTERNS" id="945449643%2FProperties%2F1536944878" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"></a> <div class="table-row table-row_content" data-filterable-current=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-d-e-f-a-u-l-t_-p-a-t-t-e-r-n-s.html"><span>DEFAULT_</span><wbr><span>PATTERNS</span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="945449643%2FProperties%2F1536944878"></span> <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div> </span></span></div> <div> <div class="title"> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-d-e-f-a-u-l-t_-p-a-t-t-e-r-n-s.html">DEFAULT_PATTERNS</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="../../-retryable-pattern/index.html">RetryablePattern</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Default retry patterns that work across all providers.</p></div></div></div> </div> </div> </div> </div> <a data-name="1167909584%2FProperties%2F1536944878" anchor-label="DISABLED" id="1167909584%2FProperties%2F1536944878" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"></a> <div class="table-row table-row_content" data-filterable-current=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-d-i-s-a-b-l-e-d.html"><span><span>DISABLED</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1167909584%2FProperties%2F1536944878"></span> <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div> </span></span></div> <div> <div class="title"> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-d-i-s-a-b-l-e-d.html">DISABLED</a><span class="token operator">: </span><a href="../index.html">RetryConfig</a></div><div class="brief "><p class="paragraph">No retry - effectively disables retry logic.</p></div></div></div> </div> </div> </div> </div> <a data-name="-369756301%2FProperties%2F1536944878" anchor-label="PRODUCTION" id="-369756301%2FProperties%2F1536944878" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"></a> <div class="table-row table-row_content" data-filterable-current=":prompt:prompt-executor:prompt-executor-clients/commonMain" data-filterable-set=":prompt:prompt-executor:prompt-executor-clients/commonMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-p-r-o-d-u-c-t-i-o-n.html"><span><span>PRODUCTION</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-369756301%2FProperties%2F1536944878"></span> <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div> </span></span></div> <div> <div class="title"> <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":prompt:prompt-executor:prompt-executor-clients/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-p-r-o-d-u-c-t-i-o-n.html">PRODUCTION</a><span class="token operator">: </span><a href="../index.html">RetryConfig</a></div><div class="brief "><p class="paragraph">Production configuration - balanced for production use.</p></div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="footer"> <div class="footer--container"> <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a> <div class="footer--content"> <div> <span>Generated by </span> <a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka"> Dokka </a> <div>Copyright © 2000-2025 JetBrains s.r.o.</div> </div> </div> </div> </div> </div> </div> </div> </body> </html>