PyPI - mindroot - Versions diffs - 9.11.0__py3-none-any.whl → 9.13.0__py3-none-any.whl - Mend - Supply Chain Defender

mindroot 9.11.0py3-none-any.whl → 9.13.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of mindroot might be problematic. Click here for more details.

Files changed (417) hide show

mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/mod.html ADDED Viewed

@@ -0,0 +1,355 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>mindroot.coreplugins.credits.mod &mdash; MindRoot 9.10.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
+      <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../../../_static/documentation_options.js?v=3c16008f"></script>
+      <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../../search.html" />
+</head>
+<body class="wy-body-for-nav">
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search"  style="background: #343131" >
+          <a href="../../../../index.html" class="icon icon-home">
+            MindRoot
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started.html">Getting Started</a></li>
+</ul>
+        </div>
+      </div>
+    </nav>
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: #343131" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../../index.html">MindRoot</a>
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">mindroot.coreplugins.credits.mod</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+  <h1>Source code for mindroot.coreplugins.credits.mod</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">date</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Dict</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">lib.providers.services</span><span class="w"> </span><span class="kn">import</span> <span class="n">service</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">lib.providers.commands</span><span class="w"> </span><span class="kn">import</span> <span class="n">command</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">lib.providers.hooks</span><span class="w"> </span><span class="kn">import</span> <span class="n">hook</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">lib.utils.debug</span><span class="w"> </span><span class="kn">import</span> <span class="n">debug_box</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditTransaction</span><span class="p">,</span> <span class="n">CreditRatioConfig</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.storage</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditStorage</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.ledger</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditLedger</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.conversion</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditUsageHandler</span><span class="p">,</span> <span class="n">CreditPolicy</span>
+<span class="c1"># Global handler for usage tracking</span>
+<span class="n">_usage_handler</span> <span class="o">=</span> <span class="kc">None</span>
+<div class="viewcode-block" id="CreditsPlugin">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.CreditsPlugin">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">CreditsPlugin</span><span class="p">:</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">base_path</span> <span class="o">=</span> <span class="n">base_path</span>
+<div class="viewcode-block" id="CreditsPlugin.create_components">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.CreditsPlugin.create_components">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">create_components</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Create fresh instances of all credit system components&quot;&quot;&quot;</span>
+        <span class="n">storage</span> <span class="o">=</span> <span class="n">CreditStorage</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_path</span><span class="p">)</span>
+        <span class="n">ratio_config</span> <span class="o">=</span> <span class="n">CreditRatioConfig</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_path</span><span class="p">)</span>
+        <span class="n">ledger</span> <span class="o">=</span> <span class="n">CreditLedger</span><span class="p">(</span><span class="n">storage</span><span class="p">)</span>
+        <span class="n">credit_policy</span> <span class="o">=</span> <span class="n">CreditPolicy</span><span class="p">(</span><span class="n">ledger</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_path</span><span class="p">)</span>
+        <span class="n">usage_handler</span> <span class="o">=</span> <span class="n">CreditUsageHandler</span><span class="p">(</span><span class="n">ledger</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_path</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">storage</span><span class="p">,</span> <span class="n">ledger</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">,</span> <span class="n">credit_policy</span><span class="p">,</span> <span class="n">usage_handler</span></div>
+</div>
+<div class="viewcode-block" id="get_base_path">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.get_base_path">[docs]</a>
+<span class="k">def</span><span class="w"> </span><span class="nf">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get the base path for credit data storage&quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">()</span> <span class="o">/</span> <span class="s1">&#39;data&#39;</span> <span class="o">/</span> <span class="s1">&#39;credits&#39;</span><span class="p">)</span></div>
+<div class="viewcode-block" id="startup">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.startup">[docs]</a>
+<span class="nd">@hook</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">startup</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Startup tasks&quot;&quot;&quot;</span>
+    <span class="c1"># Initialize components</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">usage_handler</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="c1"># Store usage handler globally for the handle_usage service</span>
+    <span class="k">global</span> <span class="n">_usage_handler</span>
+    <span class="n">_usage_handler</span> <span class="o">=</span> <span class="n">usage_handler</span></div>
+<div class="viewcode-block" id="handle_usage">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.handle_usage">[docs]</a>
+<span class="nd">@hook</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">handle_usage</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">quantity</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                    <span class="n">metadata</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">model_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Handle usage tracking for credits system.</span>
+<span class="sd">    This service is called by the usage plugin after tracking usage.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">global</span> <span class="n">_usage_handler</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">_usage_handler</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Credits plugin not properly initialized&quot;</span><span class="p">)</span>
+    <span class="nb">print</span><span class="p">(</span><span class="n">cost_type_id</span><span class="p">)</span>
+    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;quantity:&quot;</span><span class="p">,</span> <span class="n">quantity</span><span class="p">)</span>
+    <span class="n">debug_box</span><span class="p">(</span><span class="s2">&quot;Recording credit usage: </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">quantity</span><span class="p">))</span>
+    <span class="k">await</span> <span class="n">_usage_handler</span><span class="o">.</span><span class="n">handle_usage</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">quantity</span><span class="p">,</span>
+                                    <span class="n">metadata</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">model_id</span><span class="p">)</span></div>
+<div class="viewcode-block" id="allocate_credits">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.allocate_credits">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">allocate_credits</span><span class="p">(</span><span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">amount</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                          <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">reference_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                          <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                          <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Allocate credits to a user.</span>
+<span class="sd">    </span>
+<span class="sd">    Args:</span>
+<span class="sd">        username: User to allocate credits to</span>
+<span class="sd">        amount: Amount of credits to allocate</span>
+<span class="sd">        source: Source of allocation (e.g., &#39;purchase&#39;, &#39;admin_grant&#39;)</span>
+<span class="sd">        reference_id: External reference (e.g., payment ID)</span>
+<span class="sd">        metadata: Additional information about allocation</span>
+<span class="sd">        context: Request context</span>
+<span class="sd">    </span>
+<span class="sd">    Returns:</span>
+<span class="sd">        float: New credit balance</span>
+<span class="sd">    </span>
+<span class="sd">    Example:</span>
+<span class="sd">        new_balance = await allocate_credits(</span>
+<span class="sd">            &#39;user123&#39;,</span>
+<span class="sd">            1000.0,</span>
+<span class="sd">            &#39;purchase&#39;,</span>
+<span class="sd">            &#39;payment_123&#39;,</span>
+<span class="sd">            {&#39;payment_method&#39;: &#39;stripe&#39;}</span>
+<span class="sd">        )</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">ledger</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="k">return</span> <span class="k">await</span> <span class="n">ledger</span><span class="o">.</span><span class="n">record_allocation</span><span class="p">(</span>
+        <span class="n">username</span><span class="p">,</span> <span class="n">amount</span><span class="p">,</span> <span class="n">source</span><span class="p">,</span> <span class="n">reference_id</span><span class="p">,</span> <span class="n">metadata</span>
+    <span class="p">)</span></div>
+<div class="viewcode-block" id="get_credit_balance">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.get_credit_balance">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_credit_balance</span><span class="p">(</span><span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get current credit balance for a user.</span>
+<span class="sd">    </span>
+<span class="sd">    Example:</span>
+<span class="sd">        balance = await get_credit_balance(&#39;user123&#39;)</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">ledger</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="k">return</span> <span class="k">await</span> <span class="n">ledger</span><span class="o">.</span><span class="n">get_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span></div>
+<div class="viewcode-block" id="check_credits_available">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.check_credits_available">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">check_credits_available</span><span class="p">(</span><span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">required_amount</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                                <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Check if user has sufficient credits.</span>
+<span class="sd">    </span>
+<span class="sd">    Returns:</span>
+<span class="sd">        Dict with &#39;has_sufficient&#39; and &#39;current_balance&#39; keys</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">ledger</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="n">has_sufficient</span><span class="p">,</span> <span class="n">balance</span> <span class="o">=</span> <span class="k">await</span> <span class="n">ledger</span><span class="o">.</span><span class="n">check_credits_available</span><span class="p">(</span>
+        <span class="n">username</span><span class="p">,</span> <span class="n">required_amount</span>
+    <span class="p">)</span>
+    <span class="k">return</span> <span class="p">{</span>
+        <span class="s1">&#39;has_sufficient&#39;</span><span class="p">:</span> <span class="n">has_sufficient</span><span class="p">,</span>
+        <span class="s1">&#39;current_balance&#39;</span><span class="p">:</span> <span class="n">balance</span>
+    <span class="p">}</span></div>
+<div class="viewcode-block" id="set_credit_ratio">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.set_credit_ratio">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">set_credit_ratio</span><span class="p">(</span><span class="n">ratio</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">plugin_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                          <span class="n">cost_type_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                          <span class="n">model_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                          <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Set credit ratio for cost conversion.</span>
+<span class="sd">    </span>
+<span class="sd">    Args:</span>
+<span class="sd">        ratio: Credits per unit cost</span>
+<span class="sd">        plugin_id: Optional plugin identifier</span>
+<span class="sd">        cost_type_id: Optional cost type identifier</span>
+<span class="sd">        model_id: Optional model identifier</span>
+<span class="sd">    </span>
+<span class="sd">    Example:</span>
+<span class="sd">        # Set global default ratio</span>
+<span class="sd">        await set_credit_ratio(100.0)</span>
+<span class="sd">        </span>
+<span class="sd">        # Set model-specific ratio</span>
+<span class="sd">        await set_credit_ratio(</span>
+<span class="sd">            90.0,</span>
+<span class="sd">            plugin_id=&#39;gpt4&#39;,</span>
+<span class="sd">            cost_type_id=&#39;gpt4.input_tokens&#39;,</span>
+<span class="sd">            model_id=&#39;gpt-4-1106-preview&#39;</span>
+<span class="sd">        )</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="k">await</span> <span class="n">ratio_config</span><span class="o">.</span><span class="n">set_ratio</span><span class="p">(</span><span class="n">ratio</span><span class="p">,</span> <span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">model_id</span><span class="p">)</span></div>
+<div class="viewcode-block" id="get_credit_ratios">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.get_credit_ratios">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_credit_ratios</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get current credit ratio configuration.&quot;&quot;&quot;</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">ratio_config</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="k">return</span> <span class="k">await</span> <span class="n">ratio_config</span><span class="o">.</span><span class="n">get_config</span><span class="p">()</span></div>
+<div class="viewcode-block" id="get_credit_report">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.get_credit_report">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_credit_report</span><span class="p">(</span><span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                           <span class="n">start_date</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                           <span class="n">end_date</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                           <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get detailed credit report for a user.</span>
+<span class="sd">    </span>
+<span class="sd">    Args:</span>
+<span class="sd">        username: User to get report for</span>
+<span class="sd">        start_date: Optional start date (YYYY-MM-DD)</span>
+<span class="sd">        end_date: Optional end date (YYYY-MM-DD)</span>
+<span class="sd">    </span>
+<span class="sd">    Returns:</span>
+<span class="sd">        Dict containing:</span>
+<span class="sd">        - Current balance</span>
+<span class="sd">        - Transaction history</span>
+<span class="sd">        - Usage summary</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">start</span> <span class="o">=</span> <span class="n">date</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">start_date</span><span class="p">)</span> <span class="k">if</span> <span class="n">start_date</span> <span class="k">else</span> <span class="kc">None</span>
+    <span class="n">end</span> <span class="o">=</span> <span class="n">date</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">end_date</span><span class="p">)</span> <span class="k">if</span> <span class="n">end_date</span> <span class="k">else</span> <span class="kc">None</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">ledger</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="n">transactions</span> <span class="o">=</span> <span class="k">await</span> <span class="n">ledger</span><span class="o">.</span><span class="n">get_transactions</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">)</span>
+    <span class="n">summary</span> <span class="o">=</span> <span class="k">await</span> <span class="n">ledger</span><span class="o">.</span><span class="n">get_usage_summary</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">)</span>
+    <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="n">ledger</span><span class="o">.</span><span class="n">get_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
+    <span class="k">return</span> <span class="p">{</span>
+        <span class="s1">&#39;username&#39;</span><span class="p">:</span> <span class="n">username</span><span class="p">,</span>
+        <span class="s1">&#39;current_balance&#39;</span><span class="p">:</span> <span class="n">current_balance</span><span class="p">,</span>
+        <span class="s1">&#39;summary&#39;</span><span class="p">:</span> <span class="n">summary</span><span class="p">,</span>
+        <span class="s1">&#39;transactions&#39;</span><span class="p">:</span> <span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">transactions</span><span class="p">]</span>
+    <span class="p">}</span></div>
+<div class="viewcode-block" id="estimate_credits">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.mod.estimate_credits">[docs]</a>
+<span class="nd">@service</span><span class="p">()</span>
+<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">estimate_credits</span><span class="p">(</span><span class="n">plugin_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                         <span class="n">estimated_cost</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                         <span class="n">model_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                         <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Estimate credits needed for an operation.</span>
+<span class="sd">    </span>
+<span class="sd">    Example:</span>
+<span class="sd">        estimate = await estimate_credits(</span>
+<span class="sd">            &#39;gpt4&#39;,</span>
+<span class="sd">            &#39;gpt4.input_tokens&#39;,</span>
+<span class="sd">            0.01,  # $0.01</span>
+<span class="sd">            &#39;gpt-4-1106-preview&#39;</span>
+<span class="sd">        )</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">plugin</span> <span class="o">=</span> <span class="n">CreditsPlugin</span><span class="p">(</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">context</span><span class="p">))</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">credit_policy</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">create_components</span><span class="p">()</span>
+    <span class="n">credits</span> <span class="o">=</span> <span class="k">await</span> <span class="n">credit_policy</span><span class="o">.</span><span class="n">estimate_credits_needed</span><span class="p">(</span>
+        <span class="n">plugin_id</span><span class="p">,</span> <span class="n">cost_type_id</span><span class="p">,</span> <span class="n">estimated_cost</span><span class="p">,</span> <span class="n">model_id</span>
+    <span class="p">)</span>
+    <span class="k">return</span> <span class="p">{</span>
+        <span class="s1">&#39;estimated_cost&#39;</span><span class="p">:</span> <span class="n">estimated_cost</span><span class="p">,</span>
+        <span class="s1">&#39;credits_required&#39;</span><span class="p">:</span> <span class="n">credits</span><span class="p">,</span>
+        <span class="s1">&#39;ratio_used&#39;</span><span class="p">:</span> <span class="n">credits</span> <span class="o">/</span> <span class="n">estimated_cost</span>
+    <span class="p">}</span></div>
+</pre></div>
+           </div>
+          </div>
+          <footer>
+  <hr/>
+  <div role="contentinfo">
+    <p>&#169; Copyright 2025, Jason Livesay.</p>
+  </div>
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+</body>
+</html>