koog-ktor/ai.koog.ktor/-bedrock-client-config/index.html (201 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>BedrockClientConfig</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 jvm-like" data-active="" aria-pressed="true" data-filter=":koog-ktor/jvmMain">jvm</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 jvm-like" tabindex="0"> <label class="checkbox"> <input type="checkbox" class="checkbox--input" id=":koog-ktor/jvmMain" data-filter=":koog-ktor/jvmMain"> <span class="checkbox--icon"></span> jvm </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="koog-ktor::ai.koog.ktor/BedrockClientConfig///PointingToDeclaration//-1258927232"> <div class="breadcrumbs"><a href="../../index.html">koog-ktor</a><span class="delimiter">/</span><a href="../index.html">ai.koog.ktor</a><span class="delimiter">/</span><span class="current">BedrockClientConfig</span></div> <div class="cover "> <h1 class="cover"><span>Bedrock</span><wbr><span>Client</span><wbr><span><span>Config</span></span></h1> <div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain" data-active="" data-toggle=":koog-ktor/jvmMain">jvm</button></div> <div class="content sourceset-dependent-content" data-active="" data-togglable=":koog-ktor/jvmMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">BedrockClientConfig</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/JetBrains/koog/tree/main/koog-ktor/src/jvmMain/kotlin/ai/koog/ktor/BedrockConfig.kt#L14">source</a>)</span></span></div><p class="paragraph">Configuration to create a new Bedrock LLM client configured with the specified identity provider and settings.</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="CONSTRUCTOR"> <h2 class="tableheader">Constructors</h2> <div class="table"><a data-name="-1487225603%2FConstructors%2F-1258927232" anchor-label="BedrockClientConfig" id="-1487225603%2FConstructors%2F-1258927232" data-filterable-set=":koog-ktor/jvmMain"></a> <div class="table-row table-row_content" data-togglable="CONSTRUCTOR" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="-bedrock-client-config.html"><span>Bedrock</span><wbr><span>Client</span><wbr><span><span>Config</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1487225603%2FConstructors%2F-1258927232"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain" data-active="" data-toggle=":koog-ktor/jvmMain">jvm</button></div> <div class="content sourceset-dependent-content" data-active="" data-togglable=":koog-ktor/jvmMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div> </div> </div> </div> </div> </div> </div> </div> <div data-togglable="PROPERTY"> <h2 class="tableheader">Properties</h2> <div class="table"><a data-name="239649762%2FProperties%2F-1258927232" anchor-label="clock" id="239649762%2FProperties%2F-1258927232" data-filterable-set=":koog-ktor/jvmMain"></a> <div class="table-row table-row_content" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="clock.html"><span><span>clock</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="239649762%2FProperties%2F-1258927232"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain" data-active="" data-toggle=":koog-ktor/jvmMain">jvm</button></div> <div class="content sourceset-dependent-content" data-active="" data-togglable=":koog-ktor/jvmMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="clock.html">clock</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.datetime/Clock///PointingToDeclaration/">Clock</span></div><div class="brief "><p class="paragraph">Override the clock used for time-based operations.</p></div></div> </div> </div> </div> </div> </div> <a data-name="1358868106%2FProperties%2F-1258927232" anchor-label="configure" id="1358868106%2FProperties%2F-1258927232" data-filterable-set=":koog-ktor/jvmMain"></a> <div class="table-row table-row_content" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="configure.html"><span><span>configure</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1358868106%2FProperties%2F-1258927232"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain" data-active="" data-toggle=":koog-ktor/jvmMain">jvm</button></div> <div class="content sourceset-dependent-content" data-active="" data-togglable=":koog-ktor/jvmMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="configure.html">configure</a><span class="token operator">: </span><span data-unresolved-link="aws.sdk.kotlin.services.bedrockruntime/BedrockRuntimeClient.Config.Builder///PointingToDeclaration/">BedrockRuntimeClient.Config.Builder</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></div><div class="brief "><p class="paragraph">Configure the underlying BedrockRuntimeClient from the AWS SDK.</p></div></div> </div> </div> </div> </div> </div> <a data-name="1780106725%2FProperties%2F-1258927232" anchor-label="moderationGuardrailsSettings" id="1780106725%2FProperties%2F-1258927232" data-filterable-set=":koog-ktor/jvmMain"></a> <div class="table-row table-row_content" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain"> <div class="main-subrow keyValue "> <div class=""><span class="inline-flex"> <div><a href="moderation-guardrails-settings.html"><span>moderation</span><wbr><span>Guardrails</span><wbr><span><span>Settings</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1780106725%2FProperties%2F-1258927232"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":koog-ktor/jvmMain" data-filterable-set=":koog-ktor/jvmMain" data-active="" data-toggle=":koog-ktor/jvmMain">jvm</button></div> <div class="content sourceset-dependent-content" data-active="" data-togglable=":koog-ktor/jvmMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="moderation-guardrails-settings.html">moderationGuardrailsSettings</a><span class="token operator">: </span><a href="../../../prompt/prompt-executor/prompt-executor-clients/prompt-executor-bedrock-client/ai.koog.prompt.executor.clients.bedrock/-bedrock-guardrails-settings/index.html">BedrockGuardrailsSettings</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">Set moderation guardrails settings for Bedrock.</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>