mirror of
https://github.com/katanemo/plano.git
synced 2026-05-03 12:52:56 +02:00
735 lines
56 KiB
HTML
735 lines
56 KiB
HTML
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<html lang="en" data-content_root="../../" >
|
|||
|
|
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|||
|
|
|
|||
|
|
<title>Retrieval-Augmented (RAG) — Arch 0.1-beta documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script data-cfasync="false">
|
|||
|
|
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
|
|||
|
|
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<!-- Loaded before other Sphinx assets -->
|
|||
|
|
<link href="../../_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
|
|||
|
|
<link href="../../_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
|
|||
|
|
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link href="../../_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
|
|||
|
|
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
|
|||
|
|
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
|
|||
|
|
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css?v=a3416100" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
|
|||
|
|
|
|||
|
|
<!-- Pre-loaded scripts that we'll load fully later -->
|
|||
|
|
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
|
|||
|
|
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
|
|||
|
|
<script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
|
|||
|
|
|
|||
|
|
<script src="../../_static/documentation_options.js?v=2742c0eb"></script>
|
|||
|
|
<script src="../../_static/doctools.js?v=9a2dae69"></script>
|
|||
|
|
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|||
|
|
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
|
|||
|
|
<script src="../../_static/copybutton.js?v=f281be69"></script>
|
|||
|
|
<script src="../../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
|
|||
|
|
<script>DOCUMENTATION_OPTIONS.pagename = 'getting_started/use_cases/rag';</script>
|
|||
|
|
<link rel="icon" href="../../_static/favicon.ico"/>
|
|||
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|||
|
|
<link rel="next" title="Agentic (Text-to-Action) Apps" href="function_calling.html" />
|
|||
|
|
<link rel="prev" title="<no title>" href="../use_cases.html" />
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|||
|
|
<meta name="docsearch:language" content="en"/>
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
|
|||
|
|
|
|||
|
|
<div id="pst-scroll-pixel-helper"></div>
|
|||
|
|
|
|||
|
|
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
|
|||
|
|
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<input type="checkbox"
|
|||
|
|
class="sidebar-toggle"
|
|||
|
|
id="pst-primary-sidebar-checkbox"/>
|
|||
|
|
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
|
|||
|
|
|
|||
|
|
<input type="checkbox"
|
|||
|
|
class="sidebar-toggle"
|
|||
|
|
id="pst-secondary-sidebar-checkbox"/>
|
|||
|
|
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
|
|||
|
|
|
|||
|
|
<div class="search-button__wrapper">
|
|||
|
|
<div class="search-button__overlay"></div>
|
|||
|
|
<div class="search-button__search-container">
|
|||
|
|
<form class="bd-search d-flex align-items-center"
|
|||
|
|
action="../../search.html"
|
|||
|
|
method="get">
|
|||
|
|
<i class="fa-solid fa-magnifying-glass"></i>
|
|||
|
|
<input type="search"
|
|||
|
|
class="form-control"
|
|||
|
|
name="q"
|
|||
|
|
id="search-input"
|
|||
|
|
placeholder="Search..."
|
|||
|
|
aria-label="Search..."
|
|||
|
|
autocomplete="off"
|
|||
|
|
autocorrect="off"
|
|||
|
|
autocapitalize="off"
|
|||
|
|
spellcheck="false"/>
|
|||
|
|
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
|
|||
|
|
</form></div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="pst-async-banner-revealer d-none">
|
|||
|
|
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
|
|||
|
|
</header>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="bd-container">
|
|||
|
|
<div class="bd-container__inner bd-page-width">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="bd-sidebar-primary bd-sidebar">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="sidebar-header-items sidebar-primary__section">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="sidebar-primary-items__start sidebar-primary__section">
|
|||
|
|
<div class="sidebar-primary-item">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a class="navbar-brand logo" href="../../root.html">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<img src="../../_static/arch-nav-logo.png" class="logo__image only-light" alt="Arch 0.1-beta documentation - Home"/>
|
|||
|
|
<script>document.write(`<img src="../../_static/arch-nav-logo.png" class="logo__image only-dark" alt="Arch 0.1-beta documentation - Home"/>`);</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a></div>
|
|||
|
|
<div class="sidebar-primary-item">
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
document.write(`
|
|||
|
|
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|||
|
|
<i class="fa-solid fa-magnifying-glass"></i>
|
|||
|
|
<span class="search-button__default-text">Search</span>
|
|||
|
|
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
|
|||
|
|
</button>
|
|||
|
|
`);
|
|||
|
|
</script></div>
|
|||
|
|
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
|
|||
|
|
<div class="bd-toc-item navbar-nav active">
|
|||
|
|
<ul class="current nav bd-sidenav">
|
|||
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../../intro/intro.html">Introduction</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../intro/what_is_arch.html">What is Arch</a></li>
|
|||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="../../intro/architecture/architecture.html">Technical Architecture</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="../../intro/architecture/intro/terminology.html">Terminology</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="../../intro/architecture/intro/threading_model.html">Threading model</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="../../intro/architecture/listeners/listeners.html">Listener</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="../../intro/architecture/prompt_processing/prompt_processing.html">Prompts</a></li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="../../intro/architecture/listeners/llm_provider.html">LLM Provider</a></li>
|
|||
|
|
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="../../intro/architecture/model_serving/model_serving.html">Model Serving</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</details></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../intro/life_of_a_request.html">Life of a Request</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../intro/getting_help.html">Getting help</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</details></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
|
|||
|
|
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Retrieval-Augmented (RAG)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="function_calling.html">Agentic (Text-to-Action) Apps</a></li>
|
|||
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../../observability/observability.html">Observability</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../observability/tracing.html">Tracing</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../observability/stats.html">Monitoring</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../observability/access_logs.html">Access Logging</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</details></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../llms/llms.html">LLMs</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../configuration_reference.html">Configuration Reference</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav></div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="sidebar-primary-items__end sidebar-primary__section">
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div id="rtd-footer-container"></div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<main id="main-content" class="bd-main" role="main">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="sbt-scroll-pixel-helper"></div>
|
|||
|
|
|
|||
|
|
<div class="bd-content">
|
|||
|
|
<div class="bd-article-container">
|
|||
|
|
|
|||
|
|
<div class="bd-header-article d-print-none">
|
|||
|
|
<div class="header-article-items header-article__inner">
|
|||
|
|
|
|||
|
|
<div class="header-article-items__start">
|
|||
|
|
|
|||
|
|
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|||
|
|
<span class="fa-solid fa-bars"></span>
|
|||
|
|
</button></div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="header-article-items__end">
|
|||
|
|
|
|||
|
|
<div class="header-article-item">
|
|||
|
|
|
|||
|
|
<div class="article-header-buttons">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="dropdown dropdown-download-buttons">
|
|||
|
|
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
|
|||
|
|
<i class="fas fa-download"></i>
|
|||
|
|
</button>
|
|||
|
|
<ul class="dropdown-menu">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li><a href="../../_sources/getting_started/use_cases/rag.rst" target="_blank"
|
|||
|
|
class="btn btn-sm btn-download-source-button dropdown-item"
|
|||
|
|
title="Download source file"
|
|||
|
|
data-bs-placement="left" data-bs-toggle="tooltip"
|
|||
|
|
>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<span class="btn__icon-container">
|
|||
|
|
<i class="fas fa-file"></i>
|
|||
|
|
</span>
|
|||
|
|
<span class="btn__text-container">.rst</span>
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li>
|
|||
|
|
<button onclick="window.print()"
|
|||
|
|
class="btn btn-sm btn-download-pdf-button dropdown-item"
|
|||
|
|
title="Print to PDF"
|
|||
|
|
data-bs-placement="left" data-bs-toggle="tooltip"
|
|||
|
|
>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<span class="btn__icon-container">
|
|||
|
|
<i class="fas fa-file-pdf"></i>
|
|||
|
|
</span>
|
|||
|
|
<span class="btn__text-container">.pdf</span>
|
|||
|
|
</button>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<button onclick="toggleFullScreen()"
|
|||
|
|
class="btn btn-sm btn-fullscreen-button"
|
|||
|
|
title="Fullscreen mode"
|
|||
|
|
data-bs-placement="bottom" data-bs-toggle="tooltip"
|
|||
|
|
>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<span class="btn__icon-container">
|
|||
|
|
<i class="fas fa-expand"></i>
|
|||
|
|
</span>
|
|||
|
|
|
|||
|
|
</button>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
document.write(`
|
|||
|
|
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|||
|
|
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
|
|||
|
|
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
|
|||
|
|
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
|
|||
|
|
</button>
|
|||
|
|
`);
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
document.write(`
|
|||
|
|
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|||
|
|
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
|
|||
|
|
</button>
|
|||
|
|
`);
|
|||
|
|
</script>
|
|||
|
|
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|||
|
|
<span class="fa-solid fa-list"></span>
|
|||
|
|
</button>
|
|||
|
|
</div></div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div id="jb-print-docs-body" class="onlyprint">
|
|||
|
|
<h1>Retrieval-Augmented (RAG)</h1>
|
|||
|
|
<!-- Table of contents -->
|
|||
|
|
<div id="print-main-content">
|
|||
|
|
<div id="jb-print-toc">
|
|||
|
|
|
|||
|
|
<div>
|
|||
|
|
<h2> Contents </h2>
|
|||
|
|
</div>
|
|||
|
|
<nav aria-label="Page">
|
|||
|
|
<ul class="visible nav section-nav flex-column">
|
|||
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#intent-drift-detection">Intent-drift Detection</a><ul class="nav section-nav flex-column">
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-define-conversationbuffermemory">Step 1: define ConversationBufferMemory</a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-update-conversationbuffermemory-w-intent">Step 2: update ConversationBufferMemory w/ intent</a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-get-messages-based-on-latest-drift">Step 3: get Messages based on latest drift</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#parameter-extraction-for-rag">Parameter Extraction for RAG</a><ul class="nav section-nav flex-column">
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-define-prompt-targets-with-parameter-definitions">Step 1: Define prompt targets with parameter definitions</a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-process-request-parameters-in-flask">Step 2: Process request parameters in Flask</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div id="searchbox"></div>
|
|||
|
|
<article class="bd-article">
|
|||
|
|
|
|||
|
|
<section id="retrieval-augmented-rag">
|
|||
|
|
<span id="arch-rag-guide"></span><h1>Retrieval-Augmented (RAG)<a class="headerlink" href="#retrieval-augmented-rag" title="Link to this heading">#</a></h1>
|
|||
|
|
<p>The following section describes how Arch can help you build faster, smarter and more accurate
|
|||
|
|
Retrieval-Augmented Generation (RAG) applications.</p>
|
|||
|
|
<section id="intent-drift-detection">
|
|||
|
|
<h2>Intent-drift Detection<a class="headerlink" href="#intent-drift-detection" title="Link to this heading">#</a></h2>
|
|||
|
|
<p>Developers struggle to handle <a class="reference external" href="https://www.reddit.com/r/ChatGPTPromptGenius/comments/17dzmpy/how_to_use_rag_with_conversation_history_for/?">follow-up</a>
|
|||
|
|
or <a class="reference external" href="https://www.reddit.com/r/LocalLLaMA/comments/18mqwg6/best_practice_for_rag_with_followup_chat/">clarifying</a>
|
|||
|
|
questions. Specifically, when users ask for changes or additions to previous responses their AI applications often
|
|||
|
|
generate entirely new responses instead of adjusting previous ones. Arch offers <em>intent-drift</em> tracking as a feature so
|
|||
|
|
that developers can know when the user has shifted away from a previous intent so that they can dramatically improve
|
|||
|
|
retrieval accuracy, lower overall token cost and improve the speed of their responses back to users.</p>
|
|||
|
|
<p>Arch uses its built-in lightweight NLI and embedding models to know if the user has steered away from an active intent.
|
|||
|
|
Arch’s intent-drift detection mechanism is based on its’ <em>prompt_targets</em> primtive. Arch tries to match an incoming
|
|||
|
|
prompt to one of the <em>prompt_targets</em> configured in the gateway. Once it detects that the user has moved away from an active
|
|||
|
|
active intent, Arch adds the <code class="docutils literal notranslate"><span class="pre">x-arch-intent-drift</span></code> headers to the request before sending it your application servers.</p>
|
|||
|
|
<div class="literal-block-wrapper docutils container" id="id1">
|
|||
|
|
<div class="code-block-caption"><span class="caption-text"><a class="reference download internal" download="" href="../../_downloads/76c29fa020a722e6be4b991f849978ce/intent_detection.py"><code class="xref download docutils literal notranslate"><span class="pre">Intent</span> <span class="pre">drift</span> <span class="pre">detection</span> <span class="pre">in</span> <span class="pre">python</span></code></a></span><a class="headerlink" href="#id1" title="Link to this code">#</a></div>
|
|||
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s1">'/process_rag'</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s1">'POST'</span><span class="p">])</span>
|
|||
|
|
<span class="linenos"> 2</span><span class="k">def</span> <span class="nf">process_rag</span><span class="p">():</span>
|
|||
|
|
<span class="linenos"> 3</span> <span class="c1"># Extract JSON data from the request</span>
|
|||
|
|
<span class="linenos"> 4</span> <span class="n">data</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">get_json</span><span class="p">()</span>
|
|||
|
|
<span class="linenos"> 5</span>
|
|||
|
|
<span class="linenos"> 6</span> <span class="n">user_id</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'user_id'</span><span class="p">)</span>
|
|||
|
|
<span class="linenos"> 7</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">user_id</span><span class="p">:</span>
|
|||
|
|
<span class="linenos"> 8</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s1">'error'</span><span class="p">:</span> <span class="s1">'User ID is required'</span><span class="p">}),</span> <span class="mi">400</span>
|
|||
|
|
<span class="linenos"> 9</span>
|
|||
|
|
<span class="linenos">10</span> <span class="n">client_messages</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'messages'</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">11</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">client_messages</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">client_messages</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
|
|||
|
|
<span class="linenos">12</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s1">'error'</span><span class="p">:</span> <span class="s1">'Messages array is required'</span><span class="p">}),</span> <span class="mi">400</span>
|
|||
|
|
<span class="linenos">13</span>
|
|||
|
|
<span class="hll"><span class="linenos">14</span> <span class="c1"># Extract the intent change marker from Arch's headers if present for the current prompt</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">15</span> <span class="n">intent_changed_header</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'x-arch-intent-marker'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">16</span> <span class="k">if</span> <span class="n">intent_changed_header</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">''</span><span class="p">,</span> <span class="s1">'false'</span><span class="p">]:</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">17</span> <span class="n">intent_changed</span> <span class="o">=</span> <span class="kc">False</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">18</span> <span class="k">elif</span> <span class="n">intent_changed_header</span> <span class="o">==</span> <span class="s1">'true'</span><span class="p">:</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">19</span> <span class="n">intent_changed</span> <span class="o">=</span> <span class="kc">True</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">20</span> <span class="k">else</span><span class="p">:</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">21</span> <span class="c1"># Invalid value provided</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">22</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s1">'error'</span><span class="p">:</span> <span class="s1">'Invalid value for x-arch-prompt-intent-change header'</span><span class="p">}),</span> <span class="mi">400</span>
|
|||
|
|
</span><span class="linenos">23</span>
|
|||
|
|
<span class="linenos">24</span> <span class="c1"># Update user conversation based on intent change</span>
|
|||
|
|
<span class="linenos">25</span> <span class="n">memory</span> <span class="o">=</span> <span class="n">update_user_conversation</span><span class="p">(</span><span class="n">user_id</span><span class="p">,</span> <span class="n">client_messages</span><span class="p">,</span> <span class="n">intent_changed</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">26</span>
|
|||
|
|
<span class="linenos">27</span> <span class="c1"># Retrieve messages since last intent change for LLM</span>
|
|||
|
|
<span class="linenos">28</span> <span class="n">messages_for_llm</span> <span class="o">=</span> <span class="n">get_messages_since_last_intent</span><span class="p">(</span><span class="n">memory</span><span class="o">.</span><span class="n">chat_memory</span><span class="o">.</span><span class="n">messages</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">29</span>
|
|||
|
|
<span class="linenos">30</span> <span class="c1"># Forward messages to upstream LLM</span>
|
|||
|
|
<span class="linenos">31</span> <span class="n">llm_response</span> <span class="o">=</span> <span class="n">forward_to_llm</span><span class="p">(</span><span class="n">messages_for_llm</span><span class="p">)</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<hr class="docutils" />
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Arch is (mostly) stateless so that it can scale in an embarrassingly parrallel fashion. So, while Arch offers
|
|||
|
|
intent-drift detetction, you still have to maintain converational state with intent drift as meta-data. The
|
|||
|
|
following code snippets show how easily you can build and enrich conversational history with Langchain (in python),
|
|||
|
|
so that you can use the most relevant prompts for your retrieval and for prompting upstream LLMs.</p>
|
|||
|
|
</div>
|
|||
|
|
<section id="step-1-define-conversationbuffermemory">
|
|||
|
|
<h3>Step 1: define ConversationBufferMemory<a class="headerlink" href="#step-1-define-conversationbuffermemory" title="Link to this heading">#</a></h3>
|
|||
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">Flask</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">jsonify</span>
|
|||
|
|
<span class="linenos"> 2</span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
|
|||
|
|
<span class="linenos"> 3</span><span class="kn">import</span> <span class="nn">uuid</span>
|
|||
|
|
<span class="linenos"> 4</span><span class="kn">from</span> <span class="nn">langchain.memory</span> <span class="kn">import</span> <span class="n">ConversationBufferMemory</span>
|
|||
|
|
<span class="linenos"> 5</span><span class="kn">from</span> <span class="nn">langchain.schema</span> <span class="kn">import</span> <span class="n">AIMessage</span><span class="p">,</span> <span class="n">HumanMessage</span>
|
|||
|
|
<span class="linenos"> 6</span><span class="kn">from</span> <span class="nn">langchain</span> <span class="kn">import</span> <span class="n">OpenAI</span>
|
|||
|
|
<span class="linenos"> 7</span>
|
|||
|
|
<span class="linenos"> 8</span><span class="n">app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
|||
|
|
<span class="linenos"> 9</span>
|
|||
|
|
<span class="linenos">10</span><span class="c1"># Global dictionary to keep track of user memories</span>
|
|||
|
|
<span class="linenos">11</span><span class="n">user_memories</span> <span class="o">=</span> <span class="p">{}</span>
|
|||
|
|
<span class="linenos">12</span>
|
|||
|
|
<span class="linenos">13</span><span class="k">def</span> <span class="nf">get_user_conversation</span><span class="p">(</span><span class="n">user_id</span><span class="p">):</span>
|
|||
|
|
<span class="linenos">14</span><span class="w"> </span><span class="sd">"""</span>
|
|||
|
|
<span class="linenos">15</span><span class="sd"> Retrieve the user's conversation memory using LangChain.</span>
|
|||
|
|
<span class="linenos">16</span><span class="sd"> If the user does not exist, initialize their conversation memory.</span>
|
|||
|
|
<span class="linenos">17</span><span class="sd"> """</span>
|
|||
|
|
<span class="linenos">18</span> <span class="k">if</span> <span class="n">user_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">user_memories</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">19</span> <span class="n">user_memories</span><span class="p">[</span><span class="n">user_id</span><span class="p">]</span> <span class="o">=</span> <span class="n">ConversationBufferMemory</span><span class="p">(</span><span class="n">return_messages</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">20</span> <span class="k">return</span> <span class="n">user_memories</span><span class="p">[</span><span class="n">user_id</span><span class="p">]</span>
|
|||
|
|
<span class="linenos">21</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="step-2-update-conversationbuffermemory-w-intent">
|
|||
|
|
<h3>Step 2: update ConversationBufferMemory w/ intent<a class="headerlink" href="#step-2-update-conversationbuffermemory-w-intent" title="Link to this heading">#</a></h3>
|
|||
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="k">def</span> <span class="nf">update_user_conversation</span><span class="p">(</span><span class="n">user_id</span><span class="p">,</span> <span class="n">client_messages</span><span class="p">,</span> <span class="n">intent_changed</span><span class="p">):</span>
|
|||
|
|
<span class="linenos"> 2</span><span class="w"> </span><span class="sd">"""</span>
|
|||
|
|
<span class="linenos"> 3</span><span class="sd"> Update the user's conversation memory with new messages using LangChain.</span>
|
|||
|
|
<span class="linenos"> 4</span><span class="sd"> Each message is augmented with a UUID, timestamp, and intent change marker.</span>
|
|||
|
|
<span class="linenos"> 5</span><span class="sd"> Only new messages are added to avoid duplication.</span>
|
|||
|
|
<span class="linenos"> 6</span><span class="sd"> """</span>
|
|||
|
|
<span class="linenos"> 7</span> <span class="n">memory</span> <span class="o">=</span> <span class="n">get_user_conversation</span><span class="p">(</span><span class="n">user_id</span><span class="p">)</span>
|
|||
|
|
<span class="linenos"> 8</span> <span class="n">stored_messages</span> <span class="o">=</span> <span class="n">memory</span><span class="o">.</span><span class="n">chat_memory</span><span class="o">.</span><span class="n">messages</span>
|
|||
|
|
<span class="linenos"> 9</span>
|
|||
|
|
<span class="linenos">10</span> <span class="c1"># Determine the number of stored messages</span>
|
|||
|
|
<span class="linenos">11</span> <span class="n">num_stored_messages</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">stored_messages</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">12</span> <span class="n">new_messages</span> <span class="o">=</span> <span class="n">client_messages</span><span class="p">[</span><span class="n">num_stored_messages</span><span class="p">:]</span>
|
|||
|
|
<span class="linenos">13</span>
|
|||
|
|
<span class="linenos">14</span> <span class="c1"># Process each new message</span>
|
|||
|
|
<span class="linenos">15</span> <span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">message</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">new_messages</span><span class="p">):</span>
|
|||
|
|
<span class="linenos">16</span> <span class="n">role</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'role'</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">17</span> <span class="n">content</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'content'</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">18</span> <span class="n">metadata</span> <span class="o">=</span> <span class="p">{</span>
|
|||
|
|
<span class="linenos">19</span> <span class="s1">'uuid'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()),</span>
|
|||
|
|
<span class="linenos">20</span> <span class="s1">'timestamp'</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">(),</span>
|
|||
|
|
<span class="linenos">21</span> <span class="s1">'intent_changed'</span><span class="p">:</span> <span class="kc">False</span> <span class="c1"># Default value</span>
|
|||
|
|
<span class="linenos">22</span> <span class="p">}</span>
|
|||
|
|
<span class="linenos">23</span>
|
|||
|
|
<span class="linenos">24</span> <span class="c1"># Mark the intent change on the last message if detected</span>
|
|||
|
|
<span class="linenos">25</span> <span class="k">if</span> <span class="n">intent_changed</span> <span class="ow">and</span> <span class="n">index</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">new_messages</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">26</span> <span class="n">metadata</span><span class="p">[</span><span class="s1">'intent_changed'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
|
|||
|
|
<span class="linenos">27</span>
|
|||
|
|
<span class="linenos">28</span> <span class="c1"># Create a new message with metadata</span>
|
|||
|
|
<span class="linenos">29</span> <span class="k">if</span> <span class="n">role</span> <span class="o">==</span> <span class="s1">'user'</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">30</span> <span class="n">memory</span><span class="o">.</span><span class="n">chat_memory</span><span class="o">.</span><span class="n">add_message</span><span class="p">(</span>
|
|||
|
|
<span class="linenos">31</span> <span class="n">HumanMessage</span><span class="p">(</span><span class="n">content</span><span class="o">=</span><span class="n">content</span><span class="p">,</span> <span class="n">additional_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s1">'metadata'</span><span class="p">:</span> <span class="n">metadata</span><span class="p">})</span>
|
|||
|
|
<span class="linenos">32</span> <span class="p">)</span>
|
|||
|
|
<span class="linenos">33</span> <span class="k">elif</span> <span class="n">role</span> <span class="o">==</span> <span class="s1">'assistant'</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">34</span> <span class="n">memory</span><span class="o">.</span><span class="n">chat_memory</span><span class="o">.</span><span class="n">add_message</span><span class="p">(</span>
|
|||
|
|
<span class="linenos">35</span> <span class="n">AIMessage</span><span class="p">(</span><span class="n">content</span><span class="o">=</span><span class="n">content</span><span class="p">,</span> <span class="n">additional_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s1">'metadata'</span><span class="p">:</span> <span class="n">metadata</span><span class="p">})</span>
|
|||
|
|
<span class="linenos">36</span> <span class="p">)</span>
|
|||
|
|
<span class="linenos">37</span> <span class="k">else</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">38</span> <span class="c1"># Handle other roles if necessary</span>
|
|||
|
|
<span class="linenos">39</span> <span class="k">pass</span>
|
|||
|
|
<span class="linenos">40</span>
|
|||
|
|
<span class="linenos">41</span> <span class="k">return</span> <span class="n">memory</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="step-3-get-messages-based-on-latest-drift">
|
|||
|
|
<h3>Step 3: get Messages based on latest drift<a class="headerlink" href="#step-3-get-messages-based-on-latest-drift" title="Link to this heading">#</a></h3>
|
|||
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="k">def</span> <span class="nf">get_messages_since_last_intent</span><span class="p">(</span><span class="n">messages</span><span class="p">):</span>
|
|||
|
|
<span class="linenos"> 2</span><span class="w"> </span><span class="sd">"""</span>
|
|||
|
|
<span class="linenos"> 3</span><span class="sd"> Retrieve messages from the last intent change onwards using LangChain.</span>
|
|||
|
|
<span class="linenos"> 4</span><span class="sd"> """</span>
|
|||
|
|
<span class="linenos"> 5</span> <span class="n">messages_since_intent</span> <span class="o">=</span> <span class="p">[]</span>
|
|||
|
|
<span class="linenos"> 6</span> <span class="k">for</span> <span class="n">message</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="n">messages</span><span class="p">):</span>
|
|||
|
|
<span class="linenos"> 7</span> <span class="c1"># Insert message at the beginning to maintain correct order</span>
|
|||
|
|
<span class="linenos"> 8</span> <span class="n">messages_since_intent</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
|
|||
|
|
<span class="linenos"> 9</span> <span class="n">metadata</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">additional_kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'metadata'</span><span class="p">,</span> <span class="p">{})</span>
|
|||
|
|
<span class="linenos">10</span> <span class="c1"># Break if intent_changed is True</span>
|
|||
|
|
<span class="linenos">11</span> <span class="k">if</span> <span class="n">metadata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'intent_changed'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> <span class="o">==</span> <span class="kc">True</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">12</span> <span class="k">break</span>
|
|||
|
|
<span class="linenos">13</span> <span class="k">return</span> <span class="n">messages_since_intent</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>You can used the last set of messages that match to an intent to prompt an LLM, use it with an vector-DB for
|
|||
|
|
improved retrieval, etc. With Arch and a few lines of code, you can improve the retrieval accuracy, lower overall
|
|||
|
|
token cost and dramatically improve the speed of their responses back to users.</p>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
<section id="parameter-extraction-for-rag">
|
|||
|
|
<h2>Parameter Extraction for RAG<a class="headerlink" href="#parameter-extraction-for-rag" title="Link to this heading">#</a></h2>
|
|||
|
|
<p>To build RAG (Retrieval-Augmented Generation) applications, you can configure prompt targets with parameters,
|
|||
|
|
enabling Arch to retrieve critical information in a structured way for processing. This approach improves the
|
|||
|
|
retrieval quality and speed of your application. By extracting parameters from the conversation, you can pull
|
|||
|
|
the appropriate chunks from a vector database or SQL-like data store to enhance accuracy. With Arch, you can
|
|||
|
|
streamline data retrieval and processing to build more efficient and precise RAG applications.</p>
|
|||
|
|
<section id="step-1-define-prompt-targets-with-parameter-definitions">
|
|||
|
|
<h3>Step 1: Define prompt targets with parameter definitions<a class="headerlink" href="#step-1-define-prompt-targets-with-parameter-definitions" title="Link to this heading">#</a></h3>
|
|||
|
|
<div class="literal-block-wrapper docutils container" id="id2">
|
|||
|
|
<div class="code-block-caption"><span class="caption-text">prompt-config.yaml for parameter extraction for RAG scenarios</span><a class="headerlink" href="#id2" title="Link to this code">#</a></div>
|
|||
|
|
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">"0.1-beta"</span>
|
|||
|
|
<span class="linenos"> 2</span><span class="nt">listener</span><span class="p">:</span>
|
|||
|
|
<span class="linenos"> 3</span><span class="w"> </span><span class="nt">address</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">127.0.0.1 | 0.0.0.0</span>
|
|||
|
|
<span class="linenos"> 4</span><span class="w"> </span><span class="nt">port_value</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8080</span><span class="w"> </span><span class="c1">#If you configure port 443, you'll need to update the listener with tls_certificates</span>
|
|||
|
|
<span class="linenos"> 5</span>
|
|||
|
|
<span class="linenos"> 6</span><span class="nt">system_prompts</span><span class="p">:</span>
|
|||
|
|
<span class="linenos"> 7</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">network_assistant</span>
|
|||
|
|
<span class="linenos"> 8</span><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">You are a network assistant that just offers facts about the operational health of the network</span>
|
|||
|
|
<span class="linenos"> 9</span>
|
|||
|
|
<span class="linenos">10</span><span class="nt">llm_providers</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">11</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"OpenAI"</span>
|
|||
|
|
<span class="linenos">12</span><span class="w"> </span><span class="nt">access_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">$OPEN_AI_KEY</span>
|
|||
|
|
<span class="linenos">13</span><span class="w"> </span><span class="nt">model</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gpt-4o</span>
|
|||
|
|
<span class="linenos">14</span><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
|||
|
|
<span class="linenos">15</span>
|
|||
|
|
<span class="hll"><span class="linenos">16</span><span class="nt">prompt_targets</span><span class="p">:</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">17</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get_device_statistics</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">18</span><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">></span>
|
|||
|
|
</span><span class="hll"><span class="linenos">19</span><span class="w"> </span><span class="no">This prompt target ensures that when users request device-related statistics, the system accurately retrieves and presents the relevant data</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">20</span><span class="w"> </span><span class="no">based on the specified devices and time range. Examples of user prompts, include:</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">21</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">22</span><span class="w"> </span><span class="no">- "Show me the performance stats for device 12345 over the past week."</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">23</span><span class="w"> </span><span class="no">- "What are the error rates for my devices in the last 24 hours?"</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">24</span><span class="w"> </span><span class="no">- "I need statistics on device 789 over the last 10 days."</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">25</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">26</span><span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/device_summary</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">27</span><span class="w"> </span><span class="nt">parameters</span><span class="p">:</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">28</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"device_ids"</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">29</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span><span class="w"> </span><span class="c1"># Options: integer | float | list | dictionary | set</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">30</span><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="s">"A</span><span class="nv"> </span><span class="s">list</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">device</span><span class="nv"> </span><span class="s">identifiers</span><span class="nv"> </span><span class="s">(IDs)</span><span class="nv"> </span><span class="s">for</span><span class="nv"> </span><span class="s">which</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">statistics</span><span class="nv"> </span><span class="s">are</span><span class="nv"> </span><span class="s">requested."</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">31</span><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">32</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"time_range"</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">33</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">integer</span><span class="w"> </span><span class="c1"># Options: integer | float | list | dictionary | set</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">34</span><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="s">"The</span><span class="nv"> </span><span class="s">number</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">days</span><span class="nv"> </span><span class="s">in</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">past</span><span class="nv"> </span><span class="s">over</span><span class="nv"> </span><span class="s">which</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">retrieve</span><span class="nv"> </span><span class="s">device</span><span class="nv"> </span><span class="s">statistics.</span><span class="nv"> </span><span class="s">Defaults</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">7</span><span class="nv"> </span><span class="s">days</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">not</span><span class="nv"> </span><span class="s">specified."</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">35</span><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
|||
|
|
</span><span class="hll"><span class="linenos">36</span><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7</span>
|
|||
|
|
</span><span class="linenos">37</span>
|
|||
|
|
<span class="linenos">38</span><span class="nt">prompt_endpoints</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">39</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"http://127.0.0.2"</span>
|
|||
|
|
<span class="linenos">40</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"http://127.0.0.1"</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="step-2-process-request-parameters-in-flask">
|
|||
|
|
<h3>Step 2: Process request parameters in Flask<a class="headerlink" href="#step-2-process-request-parameters-in-flask" title="Link to this heading">#</a></h3>
|
|||
|
|
<p>Once the prompt targets are configured as above, handling those parameters is</p>
|
|||
|
|
<div class="literal-block-wrapper docutils container" id="id3">
|
|||
|
|
<div class="code-block-caption"><span class="caption-text">Flask API example for parameter extraction via HTTP request parameters</span><a class="headerlink" href="#id3" title="Link to this code">#</a></div>
|
|||
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">Flask</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">jsonify</span>
|
|||
|
|
<span class="linenos"> 2</span>
|
|||
|
|
<span class="linenos"> 3</span><span class="n">app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
|||
|
|
<span class="linenos"> 4</span>
|
|||
|
|
<span class="linenos"> 5</span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s1">'/agent/device_summary'</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s1">'POST'</span><span class="p">])</span>
|
|||
|
|
<span class="linenos"> 6</span><span class="k">def</span> <span class="nf">get_device_summary</span><span class="p">():</span>
|
|||
|
|
<span class="linenos"> 7</span><span class="w"> </span><span class="sd">"""</span>
|
|||
|
|
<span class="linenos"> 8</span><span class="sd"> Endpoint to retrieve device statistics based on device IDs and an optional time range.</span>
|
|||
|
|
<span class="linenos"> 9</span><span class="sd"> """</span>
|
|||
|
|
<span class="linenos">10</span> <span class="n">data</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">get_json</span><span class="p">()</span>
|
|||
|
|
<span class="linenos">11</span>
|
|||
|
|
<span class="linenos">12</span> <span class="c1"># Validate 'device_ids' parameter</span>
|
|||
|
|
<span class="linenos">13</span> <span class="n">device_ids</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'device_ids'</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">14</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">device_ids</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">device_ids</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
|
|||
|
|
<span class="linenos">15</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s1">'error'</span><span class="p">:</span> <span class="s2">"'device_ids' parameter is required and must be a list"</span><span class="p">}),</span> <span class="mi">400</span>
|
|||
|
|
<span class="linenos">16</span>
|
|||
|
|
<span class="linenos">17</span> <span class="c1"># Validate 'time_range' parameter (optional, defaults to 7)</span>
|
|||
|
|
<span class="linenos">18</span> <span class="n">time_range</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'time_range'</span><span class="p">,</span> <span class="mi">7</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">19</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">time_range</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
|
|||
|
|
<span class="linenos">20</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s1">'error'</span><span class="p">:</span> <span class="s2">"'time_range' must be an integer"</span><span class="p">}),</span> <span class="mi">400</span>
|
|||
|
|
<span class="linenos">21</span>
|
|||
|
|
<span class="linenos">22</span> <span class="c1"># Simulate retrieving statistics for the given device IDs and time range</span>
|
|||
|
|
<span class="linenos">23</span> <span class="c1"># In a real application, you would query your database or external service here</span>
|
|||
|
|
<span class="linenos">24</span> <span class="n">statistics</span> <span class="o">=</span> <span class="p">[]</span>
|
|||
|
|
<span class="linenos">25</span> <span class="k">for</span> <span class="n">device_id</span> <span class="ow">in</span> <span class="n">device_ids</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">26</span> <span class="c1"># Placeholder for actual data retrieval</span>
|
|||
|
|
<span class="linenos">27</span> <span class="n">stats</span> <span class="o">=</span> <span class="p">{</span>
|
|||
|
|
<span class="linenos">28</span> <span class="s1">'device_id'</span><span class="p">:</span> <span class="n">device_id</span><span class="p">,</span>
|
|||
|
|
<span class="linenos">29</span> <span class="s1">'time_range'</span><span class="p">:</span> <span class="sa">f</span><span class="s1">'Last </span><span class="si">{</span><span class="n">time_range</span><span class="si">}</span><span class="s1"> days'</span><span class="p">,</span>
|
|||
|
|
<span class="linenos">30</span> <span class="s1">'data'</span><span class="p">:</span> <span class="sa">f</span><span class="s1">'Statistics data for device </span><span class="si">{</span><span class="n">device_id</span><span class="si">}</span><span class="s1"> over the last </span><span class="si">{</span><span class="n">time_range</span><span class="si">}</span><span class="s1"> days.'</span>
|
|||
|
|
<span class="linenos">31</span> <span class="p">}</span>
|
|||
|
|
<span class="linenos">32</span> <span class="n">statistics</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">stats</span><span class="p">)</span>
|
|||
|
|
<span class="linenos">33</span>
|
|||
|
|
<span class="linenos">34</span> <span class="n">response</span> <span class="o">=</span> <span class="p">{</span>
|
|||
|
|
<span class="linenos">35</span> <span class="s1">'statistics'</span><span class="p">:</span> <span class="n">statistics</span>
|
|||
|
|
<span class="linenos">36</span> <span class="p">}</span>
|
|||
|
|
<span class="linenos">37</span>
|
|||
|
|
<span class="linenos">38</span> <span class="k">return</span> <span class="n">jsonify</span><span class="p">(</span><span class="n">response</span><span class="p">),</span> <span class="mi">200</span>
|
|||
|
|
<span class="linenos">39</span>
|
|||
|
|
<span class="linenos">40</span><span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
|
|||
|
|
<span class="linenos">41</span> <span class="n">app</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">debug</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</article>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<footer class="prev-next-footer d-print-none">
|
|||
|
|
|
|||
|
|
<div class="prev-next-area">
|
|||
|
|
<a class="left-prev"
|
|||
|
|
href="../use_cases.html"
|
|||
|
|
title="previous page">
|
|||
|
|
<i class="fa-solid fa-angle-left"></i>
|
|||
|
|
<div class="prev-next-info">
|
|||
|
|
<p class="prev-next-subtitle">previous</p>
|
|||
|
|
<p class="prev-next-title"><no title></p>
|
|||
|
|
</div>
|
|||
|
|
</a>
|
|||
|
|
<a class="right-next"
|
|||
|
|
href="function_calling.html"
|
|||
|
|
title="next page">
|
|||
|
|
<div class="prev-next-info">
|
|||
|
|
<p class="prev-next-subtitle">next</p>
|
|||
|
|
<p class="prev-next-title">Agentic (Text-to-Action) Apps</p>
|
|||
|
|
</div>
|
|||
|
|
<i class="fa-solid fa-angle-right"></i>
|
|||
|
|
</a>
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="sidebar-secondary-item">
|
|||
|
|
<div class="page-toc tocsection onthispage">
|
|||
|
|
<i class="fa-solid fa-list"></i> Contents
|
|||
|
|
</div>
|
|||
|
|
<nav class="bd-toc-nav page-toc">
|
|||
|
|
<ul class="visible nav section-nav flex-column">
|
|||
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#intent-drift-detection">Intent-drift Detection</a><ul class="nav section-nav flex-column">
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-define-conversationbuffermemory">Step 1: define ConversationBufferMemory</a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-update-conversationbuffermemory-w-intent">Step 2: update ConversationBufferMemory w/ intent</a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-get-messages-based-on-latest-drift">Step 3: get Messages based on latest drift</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#parameter-extraction-for-rag">Parameter Extraction for RAG</a><ul class="nav section-nav flex-column">
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-define-prompt-targets-with-parameter-definitions">Step 1: Define prompt targets with parameter definitions</a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-process-request-parameters-in-flask">Step 2: Process request parameters in Flask</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</nav></div>
|
|||
|
|
|
|||
|
|
</div></div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer class="bd-footer-content">
|
|||
|
|
|
|||
|
|
<div class="bd-footer-content__inner container">
|
|||
|
|
|
|||
|
|
<div class="footer-item">
|
|||
|
|
|
|||
|
|
<p class="component-author">
|
|||
|
|
By Katanemo Labs, Inc
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="footer-item">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="copyright">
|
|||
|
|
|
|||
|
|
© Copyright 2024, Katanemo Labs, Inc.
|
|||
|
|
<br/>
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="footer-item">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="footer-item">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</main>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<!-- Scripts loaded after <body> so the DOM is not blocked -->
|
|||
|
|
<script src="../../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
|
|||
|
|
<script src="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
|
|||
|
|
|
|||
|
|
<footer class="bd-footer">
|
|||
|
|
</footer>
|
|||
|
|
</body>
|
|||
|
|
</html>
|