Confluence - LlamaIndex

<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link rel="canonical" href="https://docs.llamaindex.ai/en/stable/api_reference/readers/confluence/"> <link rel="prev" href="../chroma/"> <link rel="next" href="../couchbase/"> <link rel="icon" href="../../../_static/assets/LlamaLogoBrowserTab.png"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.4"> <title>Confluence - LlamaIndex</title> <link rel="stylesheet" href="../../../assets/stylesheets/main.8608ea7d.min.css"> <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css"> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> <link rel="stylesheet" href="../../../assets/_mkdocstrings.css"> <link rel="stylesheet" href="../../../css/style.css"> <link rel="stylesheet" href="../../../css/algolia.css"> <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-BYVB1ZVE6J"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-BYVB1ZVE6J",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-BYVB1ZVE6J",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script> <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="llamaindex-llamaindex" /><meta name="readthedocs-version-slug" content="stable" /><meta name="readthedocs-resolver-filename" content="/api_reference/readers/confluence/" /><meta name="readthedocs-http-status" content="200" /></head> <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#llama_index.readers.confluence.ConfluenceReader" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <header class="md-header" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href="../../.." title="LlamaIndex" class="md-header__button md-logo" aria-label="LlamaIndex" data-md-component="logo"> <img src="../../../_static/assets/LlamaSquareBlack.svg" alt="logo"> </a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> LlamaIndex </div> <div class="md-header__topic" data-md-component="header-topic"> Confluence </div> </div> </div> <form class="md-header__option" data-md-component="palette"> <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0"> <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg> </label> <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1"> <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="purple" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2"> <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label>  <div id="docsearch"></div> </nav> </header> <div class="md-container" data-md-component="container"> <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a href="../../.." class="md-tabs__link"> Home </a> </li> <li class="md-tabs__item"> <a href="../../../understanding/" class="md-tabs__link"> Learn </a> </li> <li class="md-tabs__item"> <a href="../../../use_cases/" class="md-tabs__link"> Use Cases </a> </li> <li class="md-tabs__item"> <a href="../../../examples/" class="md-tabs__link"> Examples </a> </li> <li class="md-tabs__item"> <a href="../../../module_guides/" class="md-tabs__link"> Component Guides </a> </li> <li class="md-tabs__item"> <a href="../../../optimizing/production_rag/" class="md-tabs__link"> Advanced Topics </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href="../../" class="md-tabs__link"> API Reference </a> </li> <li class="md-tabs__item"> <a href="../../../community/integrations/" class="md-tabs__link"> Open-Source Community </a> </li> <li class="md-tabs__item"> <a href="../../../llama_cloud/" class="md-tabs__link"> LlamaCloud </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href="../../.." title="LlamaIndex" class="md-nav__button md-logo" aria-label="LlamaIndex" data-md-component="logo"> <img src="../../../_static/assets/LlamaSquareBlack.svg" alt="logo"> </a> LlamaIndex </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" > <div class="md-nav__link md-nav__container"> <a href="../../.." class="md-nav__link "> Home </a> <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_1"> Home </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../getting_started/concepts/" class="md-nav__link"> High-Level Concepts </a> </li> <li class="md-nav__item"> <a href="../../../getting_started/installation/" class="md-nav__link"> Installation and Setup </a> </li> <li class="md-nav__item"> <a href="../../../getting_started/reading/" class="md-nav__link"> How to read these docs </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_5" > <label class="md-nav__link" for="__nav_1_5" id="__nav_1_5_label" tabindex="0"> Starter Examples </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_1_5"> Starter Examples </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../getting_started/starter_example/" class="md-nav__link"> Starter Tutorial </a> </li> <li class="md-nav__item"> <a href="../../../getting_started/starter_example_local/" class="md-nav__link"> Starter Tutorial </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../getting_started/discover_llamaindex/" class="md-nav__link"> Discover LlamaIndex Video Series </a> </li> <li class="md-nav__item"> <a href="../../../getting_started/customization/" class="md-nav__link"> Frequently Asked Questions (FAQ) </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_8" > <div class="md-nav__link md-nav__container"> <a href="../../../getting_started/starter_tools/" class="md-nav__link "> Starter Tools </a> <label class="md-nav__link " for="__nav_1_8" id="__nav_1_8_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_1_8"> Starter Tools </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../getting_started/starter_tools/rag_cli/" class="md-nav__link"> RAG CLI </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/" class="md-nav__link "> Learn </a> <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2"> Learn </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/using_llms/using_llms/" class="md-nav__link"> Using LLMs </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/rag/" class="md-nav__link "> Building a RAG pipeline </a> <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_3"> Building a RAG pipeline </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_2" > <label class="md-nav__link" for="__nav_2_3_2" id="__nav_2_3_2_label" tabindex="0"> Loading & Ingestion </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_3_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_3_2"> Loading & Ingestion </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/loading/loading/" class="md-nav__link"> Loading Data (Ingestion) </a> </li> <li class="md-nav__item"> <a href="../../../understanding/loading/llamahub/" class="md-nav__link"> LlamaHub </a> </li> <li class="md-nav__item"> <a href="../../../understanding/loading/llamacloud/" class="md-nav__link"> Loading from LlamaCloud </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../understanding/indexing/indexing/" class="md-nav__link"> Indexing & Embedding </a> </li> <li class="md-nav__item"> <a href="../../../understanding/storing/storing/" class="md-nav__link"> Storing </a> </li> <li class="md-nav__item"> <a href="../../../understanding/querying/querying/" class="md-nav__link"> Querying </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/agent/" class="md-nav__link "> Building an agent </a> <label class="md-nav__link " for="__nav_2_4" id="__nav_2_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_4"> Building an agent </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/agent/local_models/" class="md-nav__link"> Agents with local models </a> </li> <li class="md-nav__item"> <a href="../../../understanding/agent/rag_agent/" class="md-nav__link"> Adding RAG to an agent </a> </li> <li class="md-nav__item"> <a href="../../../understanding/agent/llamaparse/" class="md-nav__link"> Enhancing with LlamaParse </a> </li> <li class="md-nav__item"> <a href="../../../understanding/agent/memory/" class="md-nav__link"> Memory </a> </li> <li class="md-nav__item"> <a href="../../../understanding/agent/tools/" class="md-nav__link"> Adding other tools </a> </li> <li class="md-nav__item"> <a href="../../../understanding/agent/multi_agents/" class="md-nav__link"> Multi-agent workflows </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/workflows/" class="md-nav__link "> Building Workflows </a> <label class="md-nav__link " for="__nav_2_5" id="__nav_2_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_5"> Building Workflows </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/workflows/basic_flow/" class="md-nav__link"> A basic workflow </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/branches_and_loops/" class="md-nav__link"> Branches and loops </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/state/" class="md-nav__link"> Maintaining state </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/stream/" class="md-nav__link"> Streaming events </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/concurrent_execution/" class="md-nav__link"> Concurrent execution </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/subclass/" class="md-nav__link"> Subclassing workflows </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/nested/" class="md-nav__link"> Nested workflows </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/observability/" class="md-nav__link"> Observability </a> </li> <li class="md-nav__item"> <a href="../../../understanding/workflows/unbound_functions/" class="md-nav__link"> Unbound syntax </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/extraction/" class="md-nav__link "> Structured Data Extraction </a> <label class="md-nav__link " for="__nav_2_6" id="__nav_2_6_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_6"> Structured Data Extraction </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/extraction/structured_llms/" class="md-nav__link"> Using Structured LLMs </a> </li> <li class="md-nav__item"> <a href="../../../understanding/extraction/structured_prediction/" class="md-nav__link"> Structured Prediction </a> </li> <li class="md-nav__item"> <a href="../../../understanding/extraction/lower_level/" class="md-nav__link"> Lower-level extraction </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../understanding/tracing_and_debugging/tracing_and_debugging/" class="md-nav__link"> Tracing and Debugging </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_8" > <label class="md-nav__link" for="__nav_2_8" id="__nav_2_8_label" tabindex="0"> Evaluating </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_8"> Evaluating </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/evaluating/evaluating/" class="md-nav__link"> Evaluating </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_8_2" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/evaluating/cost_analysis/" class="md-nav__link "> Cost Analysis </a> <label class="md-nav__link " for="__nav_2_8_2" id="__nav_2_8_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_8_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_8_2"> Cost Analysis </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/evaluating/cost_analysis/usage_pattern/" class="md-nav__link"> Usage Pattern </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_9" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/putting_it_all_together/" class="md-nav__link "> Putting it all Together </a> <label class="md-nav__link " for="__nav_2_9" id="__nav_2_9_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_9"> Putting it all Together </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_9_2" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/putting_it_all_together/apps/" class="md-nav__link "> Full-stack web application </a> <label class="md-nav__link " for="__nav_2_9_2" id="__nav_2_9_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_9_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_9_2"> Full-stack web application </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/putting_it_all_together/apps/fullstack_app_guide/" class="md-nav__link"> A Guide to Building a Full-Stack Web App with LLamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../understanding/putting_it_all_together/apps/fullstack_with_delphic/" class="md-nav__link"> A Guide to Building a Full-Stack LlamaIndex Web App with Delphic </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_9_3" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/putting_it_all_together/q_and_a/" class="md-nav__link "> Q&A Patterns </a> <label class="md-nav__link " for="__nav_2_9_3" id="__nav_2_9_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_9_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_9_3"> Q&A Patterns </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/putting_it_all_together/q_and_a/terms_definitions_tutorial/" class="md-nav__link"> A Guide to Extracting Terms and Definitions </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_9_4" > <label class="md-nav__link" for="__nav_2_9_4" id="__nav_2_9_4_label" tabindex="0"> Chatbots </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_9_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_9_4"> Chatbots </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../understanding/putting_it_all_together/chatbots/building_a_chatbot/" class="md-nav__link"> How to Build a Chatbot </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_9_5" > <div class="md-nav__link md-nav__container"> <a href="../../../understanding/putting_it_all_together/structured_data/" class="md-nav__link "> Structured data </a> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_9_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_9_5"> Structured data </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../understanding/putting_it_all_together/agents/" class="md-nav__link"> Agents </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" > <div class="md-nav__link md-nav__container"> <a href="../../../use_cases/" class="md-nav__link "> Use Cases </a> <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_3"> Use Cases </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../use_cases/prompting/" class="md-nav__link"> Prompting </a> </li> <li class="md-nav__item"> <a href="../../../use_cases/q_and_a/" class="md-nav__link"> Question-Answering (RAG) </a> </li> <li class="md-nav__item"> <a href="../../../use_cases/chatbots/" class="md-nav__link"> Chatbots </a> </li> <li class="md-nav__item"> <a href="../../../use_cases/extraction/" class="md-nav__link"> Structured Data Extraction </a> </li> <li class="md-nav__item"> <a href="../../../use_cases/agents/" class="md-nav__link"> Agents </a> </li> <li class="md-nav__item"> <a href="../../../use_cases/multimodal/" class="md-nav__link"> Multi-Modal Applications </a> </li> <li class="md-nav__item"> <a href="../../../use_cases/fine_tuning/" class="md-nav__link"> Fine-Tuning </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" > <div class="md-nav__link md-nav__container"> <a href="../../../examples/" class="md-nav__link "> Examples </a> <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4"> Examples </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" > <label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0"> Agents </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_2"> Agents </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/agent/Chatbot_SEC/" class="md-nav__link"> 💬🤖 How to Build a Chatbot </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_builder/" class="md-nav__link"> GPT Builder Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_runner/agent_around_query_pipeline_with_HyDE_for_PDFs/" class="md-nav__link"> Building a Multi-PDF Agent using Query Pipelines and HyDE </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_runner/agent_runner/" class="md-nav__link"> Step-wise, Controllable Agents </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_runner/agent_runner_rag_controllable/" class="md-nav__link"> Controllable Agents for RAG </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_runner/query_pipeline_agent/" class="md-nav__link"> Building an Agent around a Query Pipeline </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_workflow_basic/" class="md-nav__link"> AgentWorkflow Basic Introduction </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agent_workflow_multi/" class="md-nav__link"> Multi-Agent Research Workflow with AgentWorkflow </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agentic_rag_using_vertex_ai/" class="md-nav__link"> Agentic rag using vertex ai </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/agentic_rag_with_llamaindex_and_vertexai_managed_index/" class="md-nav__link"> Agentic rag with llamaindex and vertexai managed index </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/anthropic_agent/" class="md-nav__link"> Function Calling Anthropic Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/bedrock_converse_agent/" class="md-nav__link"> Function Calling AWS Bedrock Converse Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/coa_agent/" class="md-nav__link"> Chain-of-Abstraction LlamaPack </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/custom_agent/" class="md-nav__link"> Building a Custom Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/dashscope_agent/" class="md-nav__link"> DashScope Agent Tutorial </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/introspective_agent_toxicity_reduction/" class="md-nav__link"> Introspective Agents: Performing Tasks With Reflection </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/lats_agent/" class="md-nav__link"> Language Agent Tree Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/llm_compiler/" class="md-nav__link"> LLM Compiler Agent Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/memory/composable_memory/" class="md-nav__link"> Simple Composable Memory </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/memory/vector_memory/" class="md-nav__link"> Vector Memory </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/mistral_agent/" class="md-nav__link"> Function Calling Mistral Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/multi_document_agents-v1/" class="md-nav__link"> Multi-Document Agents (V1) </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/multi_document_agents/" class="md-nav__link"> Multi-Document Agents </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/nvidia_agent/" class="md-nav__link"> Function Calling NVIDIA Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/nvidia_document_research_assistant_for_blog_creation/" class="md-nav__link"> Document Research Assistant for Blog Creation </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/nvidia_sub_question_query_engine/" class="md-nav__link"> Sub Question Query Engine powered by NVIDIA NIMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent/" class="md-nav__link"> Build your own OpenAI Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_context_retrieval/" class="md-nav__link"> Context-Augmented OpenAI Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_lengthy_tools/" class="md-nav__link"> OpenAI Agent Workarounds for Lengthy Tool Descriptions </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_parallel_function_calling/" class="md-nav__link"> Single-Turn Multi-Function Calling OpenAI Agents </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_query_cookbook/" class="md-nav__link"> OpenAI Agent + Query Engine Experimental Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_query_plan/" class="md-nav__link"> OpenAI Agent Query Planning </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_retrieval/" class="md-nav__link"> Retrieval-Augmented OpenAI Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_tool_call_parser/" class="md-nav__link"> OpenAI Agent with Tool Call Parser </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_agent_with_query_engine/" class="md-nav__link"> OpenAI Agent with Query Engine Tools </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_assistant_agent/" class="md-nav__link"> OpenAI Assistant Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_assistant_query_cookbook/" class="md-nav__link"> OpenAI Assistant Advanced Retrieval Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_forced_function_call/" class="md-nav__link"> OpenAI agent: specifying a forced function call </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/openai_retrieval_benchmark/" class="md-nav__link"> Benchmarking OpenAI Retrieval API (through Assistant Agent) </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/react_agent/" class="md-nav__link"> ReAct Agent - A Simple Intro with Calculator Tools </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/react_agent_with_query_engine/" class="md-nav__link"> ReAct Agent with Query Engine (RAG) Tools </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/return_direct_agent/" class="md-nav__link"> Controlling Agent Reasoning Loop with Return Direct Tools </a> </li> <li class="md-nav__item"> <a href="../../../examples/agent/structured_planner/" class="md-nav__link"> Structured Planning Agent </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" > <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0"> Chat Engines </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_3"> Chat Engines </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_best/" class="md-nav__link"> Chat Engine - Best Mode </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_condense_plus_context/" class="md-nav__link"> Chat Engine - Condense Plus Context Mode </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_condense_question/" class="md-nav__link"> Chat Engine - Condense Question Mode </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_context/" class="md-nav__link"> Chat Engine - Context Mode </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_openai/" class="md-nav__link"> Chat Engine - OpenAI Agent Mode </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_personality/" class="md-nav__link"> Chat Engine with a Personality ✨ </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_react/" class="md-nav__link"> Chat Engine - ReAct Agent Mode </a> </li> <li class="md-nav__item"> <a href="../../../examples/chat_engine/chat_engine_repl/" class="md-nav__link"> Chat Engine - Simple Mode REPL </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" > <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0"> Cookbooks </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_4"> Cookbooks </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/cookbooks/GraphRAG_v1/" class="md-nav__link"> GraphRAG Implementation with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/GraphRAG_v2/" class="md-nav__link"> GraphRAG Implementation with LlamaIndex - V2 </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/airtrain/" class="md-nav__link"> AirtrainAI Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/anthropic_haiku/" class="md-nav__link"> Anthropic Haiku Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/cleanlab_tlm_rag/" class="md-nav__link"> Trustworthy RAG with the Trustworthy Language Model </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/codestral/" class="md-nav__link"> Codestral from MistralAI Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/cohere_retriever_eval/" class="md-nav__link"> Cohere init8 and binary Embeddings Retrieval Evaluation </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/contextual_retrieval/" class="md-nav__link"> Contextual Retrieval </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/crewai_llamaindex/" class="md-nav__link"> CrewAI + LlamaIndex Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/llama3_cookbook/" class="md-nav__link"> Llama3 Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/llama3_cookbook_gaudi/" class="md-nav__link"> LLM Cookbook with Intel Gaudi </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/llama3_cookbook_groq/" class="md-nav__link"> Llama3 Cookbook with Groq </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/llama3_cookbook_ollama_replicate/" class="md-nav__link"> Llama3 Cookbook with Ollama and Replicate </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/mistralai/" class="md-nav__link"> MistralAI Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/mixedbread_reranker/" class="md-nav__link"> mixedbread Rerank Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/mongodb_retrieval_strategies/" class="md-nav__link"> Optimizing for relevance using MongoDB and LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oracleai_demo/" class="md-nav__link"> Oracle AI Vector Search with Document Processing </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-2/Components_Of_LlamaIndex/" class="md-nav__link"> Components Of LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-3/Evaluating_RAG_Systems/" class="md-nav__link"> Evaluating RAG Systems </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-4/Ingestion_Pipeline/" class="md-nav__link"> Ingestion Pipeline </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-4/Metadata_Extraction/" class="md-nav__link"> Metadata Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-5/Observability/" class="md-nav__link"> Observability </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-6/Agents/" class="md-nav__link"> Agents </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-6/Router_And_SubQuestion_QueryEngine/" class="md-nav__link"> Router QueryEngine and SubQuestion QueryEngine </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-7/Multi_Modal_RAG_System/" class="md-nav__link"> Multi-Modal RAG System </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/oreilly_course_cookbooks/Module-8/Advanced_RAG_with_LlamaParse/" class="md-nav__link"> Advanced RAG with LlamaParse </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/prometheus2_cookbook/" class="md-nav__link"> Prometheus-2 Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/cookbooks/toolhouse_llamaindex/" class="md-nav__link"> Sales Prospecting Workflow with Toolhouse </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" > <label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0"> Customization </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_5"> Customization </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/customization/llms/AzureOpenAI/" class="md-nav__link"> Azure OpenAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/llms/SimpleIndexDemo-ChatGPT/" class="md-nav__link"> ChatGPT </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/llms/SimpleIndexDemo-Huggingface_camel/" class="md-nav__link"> HuggingFace LLM - Camel-5b </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/llms/SimpleIndexDemo-Huggingface_stablelm/" class="md-nav__link"> HuggingFace LLM - StableLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/prompts/chat_prompts/" class="md-nav__link"> Chat Prompts Customization </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/prompts/completion_prompts/" class="md-nav__link"> Completion Prompts Customization </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/streaming/SimpleIndexDemo-streaming/" class="md-nav__link"> Streaming </a> </li> <li class="md-nav__item"> <a href="../../../examples/customization/streaming/chat_engine_condense_question_stream_response/" class="md-nav__link"> Streaming for Chat Engine - Condense Question Mode </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_6" > <label class="md-nav__link" for="__nav_4_6" id="__nav_4_6_label" tabindex="0"> Data Connectors </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_6"> Data Connectors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/data_connectors/ChromaDemo/" class="md-nav__link"> Chroma Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/DashvectorReaderDemo/" class="md-nav__link"> DashVector Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/DatabaseReaderDemo/" class="md-nav__link"> Database Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/DeepLakeReader/" class="md-nav__link"> DeepLake Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/DiscordDemo/" class="md-nav__link"> Discord Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/DoclingReaderDemo/" class="md-nav__link"> Docling Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/FaissDemo/" class="md-nav__link"> Faiss Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/GithubRepositoryReaderDemo/" class="md-nav__link"> Github Repo Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/GoogleChatDemo/" class="md-nav__link"> Google Chat Reader Test </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/GoogleDocsDemo/" class="md-nav__link"> Google Docs Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/GoogleDriveDemo/" class="md-nav__link"> Google Drive Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/GoogleMapsTextSearchReaderDemo/" class="md-nav__link"> Google Maps Text Search Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/GoogleSheetsDemo/" class="md-nav__link"> Google Sheets Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/MakeDemo/" class="md-nav__link"> Make Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/MboxReaderDemo/" class="md-nav__link"> Mbox Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/MilvusReaderDemo/" class="md-nav__link"> MilvusReader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/MongoDemo/" class="md-nav__link"> MongoDB Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/MyScaleReaderDemo/" class="md-nav__link"> MyScale Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/NotionDemo/" class="md-nav__link"> Notion Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/ObsidianReaderDemo/" class="md-nav__link"> Obsidian Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/PathwayReaderDemo/" class="md-nav__link"> Pathway Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/PreprocessReaderDemo/" class="md-nav__link"> Preprocess </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/PsychicDemo/" class="md-nav__link"> Psychic Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/QdrantDemo/" class="md-nav__link"> Qdrant Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/SlackDemo/" class="md-nav__link"> Slack Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/TwitterDemo/" class="md-nav__link"> Twitter Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/WeaviateDemo/" class="md-nav__link"> Weaviate Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/WebPageDemo/" class="md-nav__link"> Web Page Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/ZyteSerpDemo/" class="md-nav__link"> Zyte Serp Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/deplot/DeplotReader/" class="md-nav__link"> Deplot Reader Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/html_tag_reader/" class="md-nav__link"> HTML Tag Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/oracleai/" class="md-nav__link"> Oracle AI Vector Search: Document Processing </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/simple_directory_reader/" class="md-nav__link"> Simple Directory Reader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/simple_directory_reader_parallel/" class="md-nav__link"> Parallel Processing SimpleDirectoryReader </a> </li> <li class="md-nav__item"> <a href="../../../examples/data_connectors/simple_directory_reader_remote_fs/" class="md-nav__link"> Simple Directory Reader over a Remote FileSystem </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_7" > <label class="md-nav__link" for="__nav_4_7" id="__nav_4_7_label" tabindex="0"> Discover LlamaIndex </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_7"> Discover LlamaIndex </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/discover_llamaindex/document_management/Discord_Thread_Management/" class="md-nav__link"> Discord Thread Management </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_8" > <label class="md-nav__link" for="__nav_4_8" id="__nav_4_8_label" tabindex="0"> Docstores </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_8"> Docstores </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/docstore/AzureDocstoreDemo/" class="md-nav__link"> Demo: Azure Table Storage as a Docstore </a> </li> <li class="md-nav__item"> <a href="../../../examples/docstore/DocstoreDemo/" class="md-nav__link"> Docstore Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/docstore/DynamoDBDocstoreDemo/" class="md-nav__link"> Dynamo DB Docstore Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/docstore/FirestoreDemo/" class="md-nav__link"> Firestore Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/docstore/MongoDocstoreDemo/" class="md-nav__link"> MongoDB Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/docstore/RedisDocstoreIndexStoreDemo/" class="md-nav__link"> Redis Docstore+Index Store Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/docstore/TablestoreDocstoreDemo/" class="md-nav__link"> Tablestore Demo </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_9" > <label class="md-nav__link" for="__nav_4_9" id="__nav_4_9_label" tabindex="0"> Embeddings </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_9"> Embeddings </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/embeddings/Anyscale/" class="md-nav__link"> Anyscale Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/Langchain/" class="md-nav__link"> LangChain Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/OpenAI/" class="md-nav__link"> OpenAI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/alephalpha/" class="md-nav__link"> Aleph Alpha Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/bedrock/" class="md-nav__link"> Bedrock Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/clarifai/" class="md-nav__link"> Embeddings with Clarifai </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/cloudflare_workersai/" class="md-nav__link"> Cloudflare Workers AI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/cohereai/" class="md-nav__link"> CohereAI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/custom_embeddings/" class="md-nav__link"> Custom Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/dashscope_embeddings/" class="md-nav__link"> Dashscope embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/databricks/" class="md-nav__link"> Databricks Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/deepinfra/" class="md-nav__link"> Deepinfra </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/elasticsearch/" class="md-nav__link"> Elasticsearch Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/fastembed/" class="md-nav__link"> Qdrant FastEmbed Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/fireworks/" class="md-nav__link"> Fireworks Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/gemini/" class="md-nav__link"> Google Gemini Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/gigachat/" class="md-nav__link"> Gigachat </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/google_palm/" class="md-nav__link"> Google PaLM Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/huggingface/" class="md-nav__link"> Local Embeddings with HuggingFace </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/ibm_watsonx/" class="md-nav__link"> IBM watsonx.ai </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/ipex_llm/" class="md-nav__link"> Local Embeddings with IPEX-LLM on Intel CPU </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/ipex_llm_gpu/" class="md-nav__link"> Local Embeddings with IPEX-LLM on Intel GPU </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/jina_embeddings/" class="md-nav__link"> Jina 8K Context Window Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/jinaai_embeddings/" class="md-nav__link"> Jina Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/llamafile/" class="md-nav__link"> Llamafile Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/llm_rails/" class="md-nav__link"> LLMRails Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/mistralai/" class="md-nav__link"> MistralAI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/mixedbreadai/" class="md-nav__link"> Mixedbread AI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/modelscope/" class="md-nav__link"> ModelScope Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/nebius/" class="md-nav__link"> Nebius Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/nomic/" class="md-nav__link"> Nomic Embedding </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/nvidia/" class="md-nav__link"> NVIDIA NIMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/oci_data_science/" class="md-nav__link"> Oracle Cloud Infrastructure (OCI) Data Science Service </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/oci_genai/" class="md-nav__link"> Oracle Cloud Infrastructure Generative AI </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/ollama_embedding/" class="md-nav__link"> Ollama Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/openvino/" class="md-nav__link"> Local Embeddings with OpenVINO </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/optimum_intel/" class="md-nav__link"> Optimized Embedding Model using Optimum-Intel </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/oracleai/" class="md-nav__link"> Oracle AI Vector Search: Generate Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/premai/" class="md-nav__link"> PremAI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/sagemaker_embedding_endpoint/" class="md-nav__link"> Interacting with Embeddings deployed in Amazon SageMaker Endpoint with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/text_embedding_inference/" class="md-nav__link"> Text Embedding Inference </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/textembed/" class="md-nav__link"> TextEmbed - Embedding Inference Server </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/together/" class="md-nav__link"> Together AI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/upstage/" class="md-nav__link"> Upstage Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/vertex_embedding_endpoint/" class="md-nav__link"> Interacting with Embeddings deployed in Vertex AI Endpoint with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/voyageai/" class="md-nav__link"> VoyageAI Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/embeddings/yandexgpt/" class="md-nav__link"> Yandexgpt </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_10" > <label class="md-nav__link" for="__nav_4_10" id="__nav_4_10_label" tabindex="0"> Evaluation </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_10"> Evaluation </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/evaluation/BeirEvaluation/" class="md-nav__link"> BEIR Out of Domain Benchmark </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/Deepeval/" class="md-nav__link"> 🚀 RAG/LLM Evaluators - DeepEval </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/HotpotQADistractor/" class="md-nav__link"> HotpotQADistractor Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/QuestionGeneration/" class="md-nav__link"> QuestionGeneration </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/RAGChecker/" class="md-nav__link"> RAGChecker: A Fine-grained Evaluation Framework For Diagnosing RAG </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/RetryQuery/" class="md-nav__link"> Self Correcting Query Engines - Evaluation & Retry </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/TonicValidateEvaluators/" class="md-nav__link"> Tonic Validate Evaluators </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/UpTrain/" class="md-nav__link"> How to use UpTrain with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/answer_and_context_relevancy/" class="md-nav__link"> Answer Relevancy and Context Relevancy Evaluations </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/batch_eval/" class="md-nav__link"> BatchEvalRunner - Running Multiple Evaluations </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/correctness_eval/" class="md-nav__link"> Correctness Evaluator </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/faithfulness_eval/" class="md-nav__link"> Faithfulness Evaluator </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/guideline_eval/" class="md-nav__link"> Guideline Evaluator </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/mt_bench_human_judgement/" class="md-nav__link"> Benchmarking LLM Evaluators On The MT-Bench Human Judgement </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/mt_bench_single_grading/" class="md-nav__link"> Benchmarking LLM Evaluators On A Mini MT-Bench (Single Grading) </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/multi_modal/multi_modal_rag_evaluation/" class="md-nav__link"> Evaluating Multi-Modal RAG </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/pairwise_eval/" class="md-nav__link"> Pairwise Evaluator </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/prometheus_evaluation/" class="md-nav__link"> Evaluation using Prometheus model </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/relevancy_eval/" class="md-nav__link"> Relevancy Evaluator </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/retrieval/retriever_eval/" class="md-nav__link"> Retrieval Evaluation </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/semantic_similarity_eval/" class="md-nav__link"> Embedding Similarity Evaluator </a> </li> <li class="md-nav__item"> <a href="../../../examples/evaluation/step_back_argilla/" class="md-nav__link"> 🏔️ Step-back prompting with workflows for RAG with Argilla </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_11" > <label class="md-nav__link" for="__nav_4_11" id="__nav_4_11_label" tabindex="0"> Finetuning </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_11"> Finetuning </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/finetuning/cross_encoder_finetuning/cross_encoder_finetuning/" class="md-nav__link"> How to Finetune a cross-encoder using LLamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/embeddings/finetune_corpus_embedding/" class="md-nav__link"> Finetuning corpus embeddings using NUDGE </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/embeddings/finetune_embedding/" class="md-nav__link"> Finetune Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/embeddings/finetune_embedding_adapter/" class="md-nav__link"> Finetuning an Adapter on Top of any Black-Box Embedding Model </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/llm_judge/correctness/finetune_llm_judge_single_grading_correctness/" class="md-nav__link"> Knowledge Distillation For Fine-Tuning A GPT-3.5 Judge (Correctness) </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/llm_judge/pairwise/finetune_llm_judge/" class="md-nav__link"> Knowledge Distillation For Fine-Tuning A GPT-3.5 Judge (Pairwise) </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/mistralai_fine_tuning/" class="md-nav__link"> Fine Tuning MistralAI models using Finetuning API </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/openai_fine_tuning/" class="md-nav__link"> Fine Tuning GPT-3.5-Turbo </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/openai_fine_tuning_functions/" class="md-nav__link"> Fine Tuning with Function Calling </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/react_agent/react_agent_finetune/" class="md-nav__link"> Fine-tuning a gpt-3.5 ReAct Agent on Better Chain of Thought </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/rerankers/cohere_custom_reranker/" class="md-nav__link"> Custom Cohere Reranker </a> </li> <li class="md-nav__item"> <a href="../../../examples/finetuning/router/router_finetune/" class="md-nav__link"> Router Fine-tuning </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_12" > <label class="md-nav__link" for="__nav_4_12" id="__nav_4_12_label" tabindex="0"> Ingestion </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_12_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_12"> Ingestion </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/ingestion/advanced_ingestion_pipeline/" class="md-nav__link"> Advanced Ingestion Pipeline </a> </li> <li class="md-nav__item"> <a href="../../../examples/ingestion/async_ingestion_pipeline/" class="md-nav__link"> Async Ingestion Pipeline + Metadata Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/ingestion/document_management_pipeline/" class="md-nav__link"> Ingestion Pipeline + Document Management </a> </li> <li class="md-nav__item"> <a href="../../../examples/ingestion/ingestion_gdrive/" class="md-nav__link"> Building a Live RAG Pipeline over Google Drive Files </a> </li> <li class="md-nav__item"> <a href="../../../examples/ingestion/parallel_execution_ingestion_pipeline/" class="md-nav__link"> Parallelizing Ingestion Pipeline </a> </li> <li class="md-nav__item"> <a href="../../../examples/ingestion/redis_ingestion_pipeline/" class="md-nav__link"> Redis Ingestion Pipeline </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_13" > <label class="md-nav__link" for="__nav_4_13" id="__nav_4_13_label" tabindex="0"> LLMs </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_13_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_13"> LLMs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/llm/ai21/" class="md-nav__link"> AI21 </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/alephalpha/" class="md-nav__link"> Aleph Alpha </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/anthropic/" class="md-nav__link"> Anthropic </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/anthropic_prompt_caching/" class="md-nav__link"> Anthropic Prompt Caching </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/anyscale/" class="md-nav__link"> Anyscale </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/azure_inference/" class="md-nav__link"> Azure AI model inference </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/azure_openai/" class="md-nav__link"> Azure OpenAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/bedrock/" class="md-nav__link"> Bedrock </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/bedrock_converse/" class="md-nav__link"> Bedrock Converse </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/cerebras/" class="md-nav__link"> Cerebras </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/clarifai/" class="md-nav__link"> Clarifai LLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/cleanlab/" class="md-nav__link"> Cleanlab Trustworthy Language Model </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/cohere/" class="md-nav__link"> Cohere </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/dashscope/" class="md-nav__link"> DashScope LLMS </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/databricks/" class="md-nav__link"> DataBricks </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/deepinfra/" class="md-nav__link"> DeepInfra </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/deepseek/" class="md-nav__link"> DeepSeek </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/everlyai/" class="md-nav__link"> EverlyAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/fireworks/" class="md-nav__link"> Fireworks </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/fireworks_cookbook/" class="md-nav__link"> Fireworks Function Calling Cookbook </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/friendli/" class="md-nav__link"> Friendli </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/gemini/" class="md-nav__link"> Gemini </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/groq/" class="md-nav__link"> Groq </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/huggingface/" class="md-nav__link"> Hugging Face LLMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/ibm_watsonx/" class="md-nav__link"> IBM watsonx.ai </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/ipex_llm/" class="md-nav__link"> IPEX-LLM on Intel CPU </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/ipex_llm_gpu/" class="md-nav__link"> IPEX-LLM on Intel GPU </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/konko/" class="md-nav__link"> Konko </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/langchain/" class="md-nav__link"> Langchain </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/litellm/" class="md-nav__link"> LiteLLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/llama_2/" class="md-nav__link"> Replicate - Llama 2 13B </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/llama_2_rap_battle/" class="md-nav__link"> 🦙 x 🦙 Rap Battle </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/llama_api/" class="md-nav__link"> Llama API </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/llama_cpp/" class="md-nav__link"> LlamaCPP </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/llamafile/" class="md-nav__link"> llamafile </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/llm_predictor/" class="md-nav__link"> LLM Predictor </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/lmstudio/" class="md-nav__link"> LM Studio </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/localai/" class="md-nav__link"> LocalAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/maritalk/" class="md-nav__link"> Maritalk </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/mistral_rs/" class="md-nav__link"> MistralRS LLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/mistralai/" class="md-nav__link"> MistralAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/modelscope/" class="md-nav__link"> ModelScope LLMS </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/monsterapi/" class="md-nav__link"> Monster API <> LLamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/mymagic/" class="md-nav__link"> MyMagic AI LLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/nebius/" class="md-nav__link"> Nebius LLMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/neutrino/" class="md-nav__link"> Neutrino AI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/nvidia/" class="md-nav__link"> NVIDIA NIMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/nvidia_nim/" class="md-nav__link"> NVIDIA NIMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/nvidia_tensorrt/" class="md-nav__link"> Nvidia TensorRT-LLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/nvidia_text_completion/" class="md-nav__link"> NVIDIA's LLM Text Completion API </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/nvidia_triton/" class="md-nav__link"> Nvidia Triton </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/oci_data_science/" class="md-nav__link"> Oracle Cloud Infrastructure Data Science </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/oci_genai/" class="md-nav__link"> Oracle Cloud Infrastructure Generative AI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/octoai/" class="md-nav__link"> OctoAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/ollama/" class="md-nav__link"> Ollama - Llama 3.1 </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/ollama_gemma/" class="md-nav__link"> Ollama - Gemma </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/openai/" class="md-nav__link"> OpenAI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/openai_json_vs_function_calling/" class="md-nav__link"> OpenAI JSON Mode vs. Function Calling for Data Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/openllm/" class="md-nav__link"> OpenLLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/openrouter/" class="md-nav__link"> OpenRouter </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/openvino-genai/" class="md-nav__link"> OpenVINO GenAI LLMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/openvino/" class="md-nav__link"> OpenVINO LLMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/optimum_intel/" class="md-nav__link"> Optimum Intel LLMs optimized with IPEX backend </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/paieas/" class="md-nav__link"> AlibabaCloud-PaiEas </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/palm/" class="md-nav__link"> PaLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/perplexity/" class="md-nav__link"> Perplexity </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/pipeshift/" class="md-nav__link"> Pipeshift </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/portkey/" class="md-nav__link"> Portkey </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/predibase/" class="md-nav__link"> Predibase </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/premai/" class="md-nav__link"> PremAI LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/qianfan/" class="md-nav__link"> Client of Baidu Intelligent Cloud's Qianfan LLM Platform </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/rungpt/" class="md-nav__link"> RunGPT </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/sagemaker_endpoint_llm/" class="md-nav__link"> Interacting with LLM deployed in Amazon SageMaker Endpoint with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/sambanovasystems/" class="md-nav__link"> SambaNova Systems </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/together/" class="md-nav__link"> Together AI LLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/upstage/" class="md-nav__link"> Upstage </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/vertex/" class="md-nav__link"> Vertex AI </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/vicuna/" class="md-nav__link"> Replicate - Vicuna 13B </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/vllm/" class="md-nav__link"> vLLM </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/xinference_local_deployment/" class="md-nav__link"> Xorbits Inference </a> </li> <li class="md-nav__item"> <a href="../../../examples/llm/yi/" class="md-nav__link"> Yi </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_14" > <label class="md-nav__link" for="__nav_4_14" id="__nav_4_14_label" tabindex="0"> Llama Datasets </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_14_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_14"> Llama Datasets </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/llama_dataset/downloading_llama_datasets/" class="md-nav__link"> Downloading a LlamaDataset from LlamaHub </a> </li> <li class="md-nav__item"> <a href="../../../examples/llama_dataset/labelled-rag-datasets/" class="md-nav__link"> Benchmarking RAG Pipelines With A </a> </li> <li class="md-nav__item"> <a href="../../../examples/llama_dataset/ragdataset_submission_template/" class="md-nav__link"> Submission Template Notebook </a> </li> <li class="md-nav__item"> <a href="../../../examples/llama_dataset/uploading_llama_dataset/" class="md-nav__link"> Contributing a LlamaDataset To LlamaHub </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_15" > <label class="md-nav__link" for="__nav_4_15" id="__nav_4_15_label" tabindex="0"> Llama Hub </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_15_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_15"> Llama Hub </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/llama_hub/llama_hub/" class="md-nav__link"> LlamaHub Demostration </a> </li> <li class="md-nav__item"> <a href="../../../examples/llama_hub/llama_pack_ollama/" class="md-nav__link"> Ollama Llama Pack Example </a> </li> <li class="md-nav__item"> <a href="../../../examples/llama_hub/llama_pack_resume/" class="md-nav__link"> Llama Pack - Resume Screener 📄 </a> </li> <li class="md-nav__item"> <a href="../../../examples/llama_hub/llama_packs_example/" class="md-nav__link"> Llama Packs Example </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_16" > <label class="md-nav__link" for="__nav_4_16" id="__nav_4_16_label" tabindex="0"> Low Level </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_16_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_16"> Low Level </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/low_level/evaluation/" class="md-nav__link"> Building Evaluation from Scratch </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/fusion_retriever/" class="md-nav__link"> Building an Advanced Fusion Retriever from Scratch </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/ingestion/" class="md-nav__link"> Building Data Ingestion from Scratch </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/oss_ingestion_retrieval/" class="md-nav__link"> Building RAG from Scratch (Open-source only!) </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/response_synthesis/" class="md-nav__link"> Building Response Synthesis from Scratch </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/retrieval/" class="md-nav__link"> Building Retrieval from Scratch </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/router/" class="md-nav__link"> Building a Router from Scratch </a> </li> <li class="md-nav__item"> <a href="../../../examples/low_level/vector_store/" class="md-nav__link"> Building a (Very Simple) Vector Store from Scratch </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_17" > <label class="md-nav__link" for="__nav_4_17" id="__nav_4_17_label" tabindex="0"> Managed Indexes </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_17_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_17"> Managed Indexes </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/managed/BGEM3Demo/" class="md-nav__link"> BGEM3Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/managed/GoogleDemo/" class="md-nav__link"> Google Generative Language Semantic Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/managed/PostgresMLDemo/" class="md-nav__link"> PostgresML Managed Index </a> </li> <li class="md-nav__item"> <a href="../../../examples/managed/VertexAIDemo/" class="md-nav__link"> Google Cloud LlamaIndex on Vertex AI for RAG </a> </li> <li class="md-nav__item"> <a href="../../../examples/managed/manage_retrieval_benchmark/" class="md-nav__link"> Semantic Retriever Benchmark </a> </li> <li class="md-nav__item"> <a href="../../../examples/managed/vectaraDemo/" class="md-nav__link"> Vectara Managed Index </a> </li> <li class="md-nav__item"> <a href="../../../examples/managed/zcpDemo/" class="md-nav__link"> Managed Index with Zilliz Cloud Pipelines </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_18" > <label class="md-nav__link" for="__nav_4_18" id="__nav_4_18_label" tabindex="0"> Memory </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_18_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_18"> Memory </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/memory/Mem0Memory/" class="md-nav__link"> Mem0 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_19" > <label class="md-nav__link" for="__nav_4_19" id="__nav_4_19_label" tabindex="0"> Metadata Extractors </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_19_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_19"> Metadata Extractors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/metadata_extraction/DocumentContextExtractor/" class="md-nav__link"> Contextual Retrieval With Llama Index </a> </li> <li class="md-nav__item"> <a href="../../../examples/metadata_extraction/EntityExtractionClimate/" class="md-nav__link"> Entity Metadata Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/metadata_extraction/MarvinMetadataExtractorDemo/" class="md-nav__link"> Metadata Extraction and Augmentation w/ Marvin </a> </li> <li class="md-nav__item"> <a href="../../../examples/metadata_extraction/MetadataExtractionSEC/" class="md-nav__link"> Extracting Metadata for Better Document Indexing and Understanding </a> </li> <li class="md-nav__item"> <a href="../../../examples/metadata_extraction/MetadataExtraction_LLMSurvey/" class="md-nav__link"> Automated Metadata Extraction for Better Retrieval + Synthesis </a> </li> <li class="md-nav__item"> <a href="../../../examples/metadata_extraction/PydanticExtractor/" class="md-nav__link"> Pydantic Extractor </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_20" > <label class="md-nav__link" for="__nav_4_20" id="__nav_4_20_label" tabindex="0"> Multi-Modal </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_20_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_20"> Multi-Modal </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/multi_modal/ChromaMultiModalDemo/" class="md-nav__link"> Chroma Multi-Modal Demo with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/anthropic_multi_modal/" class="md-nav__link"> Multi-Modal LLM using Anthropic model for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/azure_openai_multi_modal/" class="md-nav__link"> Multi-Modal LLM using Azure OpenAI GPT-4o mini for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/cohere_multi_modal/" class="md-nav__link"> Multi-Modal Retrieval using Cohere Multi-Modal Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/dashscope_multi_modal/" class="md-nav__link"> Multi-Modal LLM using DashScope qwen-vl model for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/gemini/" class="md-nav__link"> Multi-Modal LLM using Google's Gemini model for image understanding and build Retrieval Augmented Generation with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/gpt4o_mm_structured_outputs/" class="md-nav__link"> Multimodal Structured Outputs: GPT-4o vs. Other GPT-4 Variants </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/gpt4v_experiments_cot/" class="md-nav__link"> GPT4-V Experiments with General, Specific questions and Chain Of Thought (COT) Prompting Technique. </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/gpt4v_multi_modal_retrieval/" class="md-nav__link"> Advanced Multi-Modal Retrieval using GPT4V and Multi-Modal Index/Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/image_to_image_retrieval/" class="md-nav__link"> Image to Image Retrieval using CLIP embedding and image correlation reasoning using GPT4V </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/llava_demo/" class="md-nav__link"> LlaVa Demo with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/llava_multi_modal_tesla_10q/" class="md-nav__link"> Retrieval-Augmented Image Captioning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/mistral_multi_modal/" class="md-nav__link"> Multi-Modal LLM using Mistral for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/mm_agent/" class="md-nav__link"> [Beta] Multi-modal ReAct Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/multi_modal_pydantic/" class="md-nav__link"> Multi-Modal GPT4V Pydantic Program </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/multi_modal_rag_nomic/" class="md-nav__link"> Multi-Modal RAG using Nomic Embed and Anthropic. </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/multi_modal_retrieval/" class="md-nav__link"> Multi-Modal Retrieval using GPT text embedding and CLIP image embedding for Wikipedia Articles </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/multi_modal_video_RAG/" class="md-nav__link"> Multimodal RAG for processing videos using OpenAI GPT4V and LanceDB vectorstore </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/multi_modal_videorag_videodb/" class="md-nav__link"> Multimodal RAG with VideoDB </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/multimodal_rag_guardrail_gemini_llmguard_llmguard/" class="md-nav__link"> Multimodal rag guardrail gemini llmguard llmguard </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/nebius_multi_modal/" class="md-nav__link"> Multimodal models with Nebius </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/nvidia_multi_modal/" class="md-nav__link"> Multi-Modal LLM using NVIDIA endpoints for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/openai_multi_modal/" class="md-nav__link"> Using OpenAI GPT-4V model for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/openvino_multimodal/" class="md-nav__link"> Local Multimodal pipeline with OpenVINO </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/replicate_multi_modal/" class="md-nav__link"> Multi-Modal LLM using Replicate LlaVa, Fuyu 8B, MiniGPT4 models for image reasoning </a> </li> <li class="md-nav__item"> <a href="../../../examples/multi_modal/structured_image_retrieval/" class="md-nav__link"> Semi-structured Image Retrieval </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_21" > <label class="md-nav__link" for="__nav_4_21" id="__nav_4_21_label" tabindex="0"> Multi-Tenancy </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_21_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_21"> Multi-Tenancy </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/multi_tenancy/multi_tenancy_rag/" class="md-nav__link"> Multi-Tenancy RAG with LlamaIndex </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_22" > <label class="md-nav__link" for="__nav_4_22" id="__nav_4_22_label" tabindex="0"> Node Parsers & Text Splitters </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_22_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_22"> Node Parsers & Text Splitters </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/node_parsers/semantic_chunking/" class="md-nav__link"> Semantic Chunker </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_parsers/semantic_double_merging_chunking/" class="md-nav__link"> Semantic double merging chunking </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_parsers/topic_parser/" class="md-nav__link"> TopicNodeParser </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_23" > <label class="md-nav__link" for="__nav_4_23" id="__nav_4_23_label" tabindex="0"> Node Postprocessors </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_23_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_23"> Node Postprocessors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/CohereRerank/" class="md-nav__link"> Cohere Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/ColPaliRerank/" class="md-nav__link"> Reranking using ColPali, Cohere Reranker and Multi-Modal Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/ColbertRerank/" class="md-nav__link"> Colbert Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/FileNodeProcessors/" class="md-nav__link"> File Based Node Parsers </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/FlagEmbeddingReranker/" class="md-nav__link"> FlagEmbeddingReranker </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/JinaRerank/" class="md-nav__link"> Jina Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/LLMReranker-Gatsby/" class="md-nav__link"> LLM Reranker Demonstration (Great Gatsby) </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/LLMReranker-Lyft-10k/" class="md-nav__link"> LLM Reranker Demonstration (2021 Lyft 10-k) </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/LongContextReorder/" class="md-nav__link"> LongContextReorder </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/MetadataReplacementDemo/" class="md-nav__link"> Metadata Replacement + Node Sentence Window </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/MixedbreadAIRerank/" class="md-nav__link"> Mixedbread AI Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/NVIDIARerank/" class="md-nav__link"> NVIDIA NIMs </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/OptimizerDemo/" class="md-nav__link"> Sentence Embedding Optimizer </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/PII/" class="md-nav__link"> PII Masking </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/PrevNextPostprocessorDemo/" class="md-nav__link"> Forward/Backward Augmentation </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/RecencyPostprocessorDemo/" class="md-nav__link"> Recency Filtering </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/SentenceTransformerRerank/" class="md-nav__link"> SentenceTransformerRerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/TimeWeightedPostprocessorDemo/" class="md-nav__link"> Time-Weighted Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/VoyageAIRerank/" class="md-nav__link"> VoyageAI Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/openvino_rerank/" class="md-nav__link"> OpenVINO Rerank </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/rankGPT/" class="md-nav__link"> RankGPT Reranker Demonstration (Van Gogh Wiki) </a> </li> <li class="md-nav__item"> <a href="../../../examples/node_postprocessor/rankLLM/" class="md-nav__link"> RankLLM Reranker Demonstration (Van Gogh Wiki) </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_24" > <label class="md-nav__link" for="__nav_4_24" id="__nav_4_24_label" tabindex="0"> Object Stores </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_24_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_24"> Object Stores </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/objects/object_index/" class="md-nav__link"> The Class </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_25" > <label class="md-nav__link" for="__nav_4_25" id="__nav_4_25_label" tabindex="0"> Observability </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_25_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_25"> Observability </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/observability/AimCallback/" class="md-nav__link"> Aim Callback </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/HoneyHiveLlamaIndexTracer/" class="md-nav__link"> HoneyHive LlamaIndex Tracer </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/LangfuseCallbackHandler/" class="md-nav__link"> Langfuse Callback Handler </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/LangfuseMistralPostHog/" class="md-nav__link"> Analyze and Debug LlamaIndex Applications with PostHog and Langfuse </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/LlamaDebugHandler/" class="md-nav__link"> Llama Debug Handler </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/MLflow/" class="md-nav__link"> MLflow Tracing and E2E Integration with LlamaIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/OpenInferenceCallback/" class="md-nav__link"> OpenInference Callback Handler + Arize Phoenix </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/OpenLLMetry/" class="md-nav__link"> Observability with OpenLLMetry </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/OpikCallback/" class="md-nav__link"> Logging traces with Opik </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/PromptLayerHandler/" class="md-nav__link"> PromptLayer Handler </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/TokenCountingHandler/" class="md-nav__link"> Token Counting Handler </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/UpTrainCallback/" class="md-nav__link"> UpTrain Callback Handler </a> </li> <li class="md-nav__item"> <a href="../../../examples/observability/WandbCallbackHandler/" class="md-nav__link"> Wandb Callback Handler </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_26" > <label class="md-nav__link" for="__nav_4_26" id="__nav_4_26_label" tabindex="0"> Output Parsers </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_26_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_26"> Output Parsers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/output_parsing/GuardrailsDemo/" class="md-nav__link"> Guardrails Output Parsing </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/LangchainOutputParserDemo/" class="md-nav__link"> Langchain Output Parsing </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/df_program/" class="md-nav__link"> DataFrame Structured Data Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/evaporate_program/" class="md-nav__link"> Evaporate Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/function_program/" class="md-nav__link"> Function Calling Program for Structured Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/guidance_pydantic_program/" class="md-nav__link"> Guidance Pydantic Program </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/guidance_sub_question/" class="md-nav__link"> Guidance for Sub-Question Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/llm_program/" class="md-nav__link"> LLM Pydantic Program </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/lmformatenforcer_pydantic_program/" class="md-nav__link"> LM Format Enforcer Pydantic Program </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/lmformatenforcer_regular_expressions/" class="md-nav__link"> LM Format Enforcer Regular Expression Generation </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/nvidia_output_parsing/" class="md-nav__link"> LLM Pydantic Program - NVIDIA </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/openai_pydantic_program/" class="md-nav__link"> OpenAI Pydantic Program </a> </li> <li class="md-nav__item"> <a href="../../../examples/output_parsing/openai_sub_question/" class="md-nav__link"> OpenAI function calling for Sub-Question Query Engine </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_27" > <label class="md-nav__link" for="__nav_4_27" id="__nav_4_27_label" tabindex="0"> Param Optimizer </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_27_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_27"> Param Optimizer </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/param_optimizer/param_optimizer/" class="md-nav__link"> [WIP] Hyperparameter Optimization for RAG </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_28" > <label class="md-nav__link" for="__nav_4_28" id="__nav_4_28_label" tabindex="0"> Prompts </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_28_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_28"> Prompts </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/prompts/advanced_prompts/" class="md-nav__link"> Advanced Prompt Techniques (Variable Mappings, Functions) </a> </li> <li class="md-nav__item"> <a href="../../../examples/prompts/emotion_prompt/" class="md-nav__link"> EmotionPrompt in RAG </a> </li> <li class="md-nav__item"> <a href="../../../examples/prompts/prompt_mixin/" class="md-nav__link"> Accessing/Customizing Prompts within Higher-Level Modules </a> </li> <li class="md-nav__item"> <a href="../../../examples/prompts/prompt_optimization/" class="md-nav__link"> "Optimization by Prompting" for RAG </a> </li> <li class="md-nav__item"> <a href="../../../examples/prompts/prompts_rag/" class="md-nav__link"> Prompt Engineering for RAG </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_29" > <label class="md-nav__link" for="__nav_4_29" id="__nav_4_29_label" tabindex="0"> Property Graph </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_29_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_29"> Property Graph </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/property_graph/graph_store/" class="md-nav__link"> Using a Property Graph Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/property_graph/property_graph_advanced/" class="md-nav__link"> Property Graph Construction with Predefined Schemas </a> </li> <li class="md-nav__item"> <a href="../../../examples/property_graph/property_graph_basic/" class="md-nav__link"> Property Graph Index </a> </li> <li class="md-nav__item"> <a href="../../../examples/property_graph/property_graph_custom_retriever/" class="md-nav__link"> Defining a Custom Property Graph Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/property_graph/property_graph_memgraph/" class="md-nav__link"> Memgraph Property Graph Index </a> </li> <li class="md-nav__item"> <a href="../../../examples/property_graph/property_graph_neo4j/" class="md-nav__link"> Neo4j Property Graph Index </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_30" > <label class="md-nav__link" for="__nav_4_30" id="__nav_4_30_label" tabindex="0"> Query Engines </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_30_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_30"> Query Engines </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/query_engine/CustomRetrievers/" class="md-nav__link"> Retriever Query Engine with Custom Retrievers - Simple Hybrid Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/JSONalyze_query_engine/" class="md-nav__link"> JSONalyze Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/JointQASummary/" class="md-nav__link"> Joint QA Summary Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/RetrieverRouterQueryEngine/" class="md-nav__link"> Retriever Router Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/RouterQueryEngine/" class="md-nav__link"> Router Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/SQLAutoVectorQueryEngine/" class="md-nav__link"> SQL Auto Vector Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/SQLJoinQueryEngine/" class="md-nav__link"> SQL Join Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/SQLRouterQueryEngine/" class="md-nav__link"> SQL Router Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/citation_query_engine/" class="md-nav__link"> CitationQueryEngine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/cogniswitch_query_engine/" class="md-nav__link"> Cogniswitch query engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/custom_query_engine/" class="md-nav__link"> Defining a Custom Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/ensemble_query_engine/" class="md-nav__link"> Ensemble Query Engine Guide </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/flare_query_engine/" class="md-nav__link"> FLARE Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/json_query_engine/" class="md-nav__link"> JSON Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/knowledge_graph_query_engine/" class="md-nav__link"> Knowledge Graph Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/knowledge_graph_rag_query_engine/" class="md-nav__link"> Knowledge Graph RAG Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/multi_doc_auto_retrieval/multi_doc_auto_retrieval/" class="md-nav__link"> Structured Hierarchical Retrieval </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/pandas_query_engine/" class="md-nav__link"> Pandas Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/pdf_tables/recursive_retriever/" class="md-nav__link"> Recursive Retriever + Query Engine Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/pgvector_sql_query_engine/" class="md-nav__link"> [Beta] Text-to-SQL with PGVector </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/pydantic_query_engine/" class="md-nav__link"> Query Engine with Pydantic Outputs </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/recursive_retriever_agents/" class="md-nav__link"> Recursive Retriever + Document Agents </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/sec_tables/tesla_10q_table/" class="md-nav__link"> Joint Tabular/Semantic QA over Tesla 10K </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_engine/sub_question_query_engine/" class="md-nav__link"> Sub Question Query Engine </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_31" > <label class="md-nav__link" for="__nav_4_31" id="__nav_4_31_label" tabindex="0"> Query Pipeline </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_31_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_31"> Query Pipeline </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/pipeline/query_pipeline/" class="md-nav__link"> An Introduction to LlamaIndex Query Pipelines </a> </li> <li class="md-nav__item"> <a href="../../../examples/pipeline/query_pipeline_async/" class="md-nav__link"> Query Pipeline with Async/Parallel Execution </a> </li> <li class="md-nav__item"> <a href="../../../examples/pipeline/query_pipeline_memory/" class="md-nav__link"> Query Pipeline Chat Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/pipeline/query_pipeline_pandas/" class="md-nav__link"> Query Pipeline over Pandas DataFrames </a> </li> <li class="md-nav__item"> <a href="../../../examples/pipeline/query_pipeline_routing/" class="md-nav__link"> Query Pipeline with Routing </a> </li> <li class="md-nav__item"> <a href="../../../examples/pipeline/query_pipeline_sql/" class="md-nav__link"> Query Pipeline for Advanced Text-to-SQL </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_32" > <label class="md-nav__link" for="__nav_4_32" id="__nav_4_32_label" tabindex="0"> Query Transformations </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_32_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_32"> Query Transformations </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/query_transformations/HyDEQueryTransformDemo/" class="md-nav__link"> HyDE Query Transform </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_transformations/SimpleIndexDemo-multistep/" class="md-nav__link"> Multi-Step Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/query_transformations/query_transform_cookbook/" class="md-nav__link"> Query Transform Cookbook </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_33" > <label class="md-nav__link" for="__nav_4_33" id="__nav_4_33_label" tabindex="0"> Response Synthesizers </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_33_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_33"> Response Synthesizers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/response_synthesizers/custom_prompt_synthesizer/" class="md-nav__link"> Pydantic Tree Summarize </a> </li> <li class="md-nav__item"> <a href="../../../examples/response_synthesizers/long_context_test/" class="md-nav__link"> Stress-Testing Long Context LLMs with a Recall Task </a> </li> <li class="md-nav__item"> <a href="../../../examples/response_synthesizers/pydantic_tree_summarize/" class="md-nav__link"> Pydantic Tree Summarize </a> </li> <li class="md-nav__item"> <a href="../../../examples/response_synthesizers/refine/" class="md-nav__link"> Refine </a> </li> <li class="md-nav__item"> <a href="../../../examples/response_synthesizers/structured_refine/" class="md-nav__link"> Refine with Structured Answer Filtering </a> </li> <li class="md-nav__item"> <a href="../../../examples/response_synthesizers/tree_summarize/" class="md-nav__link"> Tree Summarize </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_34" > <label class="md-nav__link" for="__nav_4_34" id="__nav_4_34_label" tabindex="0"> Retrievers </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_34_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_34"> Retrievers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/retrievers/auto_merging_retriever/" class="md-nav__link"> Auto Merging Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/auto_vs_recursive_retriever/" class="md-nav__link"> Comparing Methods for Structured Retrieval (Auto-Retrieval vs. Recursive Retrieval) </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/bedrock_retriever/" class="md-nav__link"> Bedrock (Knowledge Bases) </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/bm25_retriever/" class="md-nav__link"> BM25 Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/composable_retrievers/" class="md-nav__link"> Composable Objects </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/deep_memory/" class="md-nav__link"> Activeloop Deep Memory </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/ensemble_retrieval/" class="md-nav__link"> Ensemble Retrieval Guide </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/multi_doc_together_hybrid/" class="md-nav__link"> Chunk + Document Hybrid Retrieval with Long-Context Embeddings (Together.ai) </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/pathway_retriever/" class="md-nav__link"> Pathway Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/reciprocal_rerank_fusion/" class="md-nav__link"> Reciprocal Rerank Fusion Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/recurisve_retriever_nodes_braintrust/" class="md-nav__link"> Recursive Retriever + Node References + Braintrust </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/recursive_retriever_nodes/" class="md-nav__link"> Recursive Retriever + Node References </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/relative_score_dist_fusion/" class="md-nav__link"> Relative Score Fusion and Distribution-Based Score Fusion </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/router_retriever/" class="md-nav__link"> Router Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/simple_fusion/" class="md-nav__link"> Simple Fusion Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/vectara_auto_retriever/" class="md-nav__link"> Auto-Retrieval from a Vectara Index </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/vertex_ai_search_retriever/" class="md-nav__link"> Vertex AI Search Retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/videodb_retriever/" class="md-nav__link"> Videodb retriever </a> </li> <li class="md-nav__item"> <a href="../../../examples/retrievers/you_retriever/" class="md-nav__link"> You.com Retriever </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_35" > <label class="md-nav__link" for="__nav_4_35" id="__nav_4_35_label" tabindex="0"> Tools </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_35_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_35"> Tools </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/tools/OnDemandLoaderTool/" class="md-nav__link"> OnDemandLoaderTool Tutorial </a> </li> <li class="md-nav__item"> <a href="../../../examples/tools/azure_code_interpreter/" class="md-nav__link"> Azure Code Interpreter Tool Spec </a> </li> <li class="md-nav__item"> <a href="../../../examples/tools/cassandra/" class="md-nav__link"> Cassandra Database Tools </a> </li> <li class="md-nav__item"> <a href="../../../examples/tools/eval_query_engine_tool/" class="md-nav__link"> Evaluation Query Engine Tool </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_36" > <label class="md-nav__link" for="__nav_4_36" id="__nav_4_36_label" tabindex="0"> Transforms </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_36_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_36"> Transforms </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/transforms/TransformsEval/" class="md-nav__link"> Transforms Evaluation </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_37" > <label class="md-nav__link" for="__nav_4_37" id="__nav_4_37_label" tabindex="0"> Use Cases </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_37_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_37"> Use Cases </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/usecases/10k_sub_question/" class="md-nav__link"> 10K Analysis </a> </li> <li class="md-nav__item"> <a href="../../../examples/usecases/10q_sub_question/" class="md-nav__link"> 10Q Analysis </a> </li> <li class="md-nav__item"> <a href="../../../examples/usecases/email_data_extraction/" class="md-nav__link"> Email Data Extraction </a> </li> <li class="md-nav__item"> <a href="../../../examples/usecases/github_issue_analysis/" class="md-nav__link"> Github Issue Analysis </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_38" > <label class="md-nav__link" for="__nav_4_38" id="__nav_4_38_label" tabindex="0"> Vector Stores </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_38_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_38"> Vector Stores </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AWSDocDBDemo/" class="md-nav__link"> AWSDocDBDemo </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AlibabaCloudOpenSearchIndexDemo/" class="md-nav__link"> Alibaba Cloud OpenSearch Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AmazonNeptuneVectorDemo/" class="md-nav__link"> Amazon Neptune - Neptune Analytics vector store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AnalyticDBDemo/" class="md-nav__link"> AnalyticDB </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AstraDBIndexDemo/" class="md-nav__link"> Astra DB </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AsyncIndexCreationDemo/" class="md-nav__link"> Simple Vector Store - Async Index Creation </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AwadbDemo/" class="md-nav__link"> Awadb Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AzureAISearchIndexDemo/" class="md-nav__link"> Azure AI Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AzureCosmosDBMongoDBvCoreDemo/" class="md-nav__link"> Azure CosmosDB MongoDB Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/AzureCosmosDBNoSqlDemo/" class="md-nav__link"> Azure Cosmos DB No SQL Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/BagelAutoRetriever/" class="md-nav__link"> Bagel Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/BagelIndexDemo/" class="md-nav__link"> Bagel Network </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/BaiduVectorDBIndexDemo/" class="md-nav__link"> Baidu VectorDB </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/CassandraIndexDemo/" class="md-nav__link"> Cassandra Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/ChromaFireworksNomic/" class="md-nav__link"> Chroma + Fireworks + Nomic with Matryoshka embedding </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/ChromaIndexDemo/" class="md-nav__link"> Chroma </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/ClickHouseIndexDemo/" class="md-nav__link"> ClickHouse Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/CouchbaseVectorStoreDemo/" class="md-nav__link"> CouchbaseVectorStoreDemo </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/DashvectorIndexDemo/" class="md-nav__link"> DashVector Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/DatabricksVectorSearchDemo/" class="md-nav__link"> Databricks Vector Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/DeepLakeIndexDemo/" class="md-nav__link"> Deep Lake Vector Store Quickstart </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/DocArrayHnswIndexDemo/" class="md-nav__link"> DocArray Hnsw Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/DocArrayInMemoryIndexDemo/" class="md-nav__link"> DocArray InMemory Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/DuckDBDemo/" class="md-nav__link"> DuckDB </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/ElasticsearchIndexDemo/" class="md-nav__link"> Elasticsearch Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/Elasticsearch_demo/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/EpsillaIndexDemo/" class="md-nav__link"> Epsilla Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/FaissIndexDemo/" class="md-nav__link"> Faiss Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/FirestoreVectorStore/" class="md-nav__link"> Firestore Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/HnswlibIndexDemo/" class="md-nav__link"> Hnswlib </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/HologresDemo/" class="md-nav__link"> Hologres </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/JaguarIndexDemo/" class="md-nav__link"> Jaguar Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/KDBAI_Advanced_RAG_Demo/" class="md-nav__link"> Advanced RAG with temporal filters using LlamaIndex and KDB.AI vector store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/LanceDBIndexDemo/" class="md-nav__link"> LanceDB Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/LanternAutoRetriever/" class="md-nav__link"> Lantern Vector Store (auto-retriever) </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/LanternIndexDemo/" class="md-nav__link"> Lantern Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/LindormDemo/" class="md-nav__link"> Lindorm </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MilvusHybridIndexDemo/" class="md-nav__link"> Milvus Vector Store With Hybrid Retrieval </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MilvusIndexDemo/" class="md-nav__link"> Milvus Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MilvusOperatorFunctionDemo/" class="md-nav__link"> MilvusOperatorFunctionDemo </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MongoDBAtlasVectorSearch/" class="md-nav__link"> MongoDB Atlas Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MongoDBAtlasVectorSearchRAGFireworks/" class="md-nav__link"> MongoDB Atlas + Fireworks AI RAG Example </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MongoDBAtlasVectorSearchRAGOpenAI/" class="md-nav__link"> MongoDB Atlas + OpenAI RAG Example </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/MyScaleIndexDemo/" class="md-nav__link"> MyScale Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/Neo4jVectorDemo/" class="md-nav__link"> Neo4j vector store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/NileVectorStore/" class="md-nav__link"> Nile Vector Store (Multi-tenant PostgreSQL) </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/ObjectBoxIndexDemo/" class="md-nav__link"> ObjectBox VectorStore Demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/OceanBaseVectorStore/" class="md-nav__link"> OceanBase Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/OpensearchDemo/" class="md-nav__link"> Opensearch Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/PGVectoRsDemo/" class="md-nav__link"> pgvecto.rs </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/PineconeIndexDemo-Hybrid/" class="md-nav__link"> Pinecone Vector Store - Hybrid Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/PineconeIndexDemo/" class="md-nav__link"> Pinecone Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/QdrantIndexDemo/" class="md-nav__link"> Qdrant Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/Qdrant_metadata_filter/" class="md-nav__link"> Qdrant Vector Store - Metadata Filter </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/Qdrant_using_qdrant_filters/" class="md-nav__link"> Qdrant Vector Store - Default Qdrant Filters </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/RedisIndexDemo/" class="md-nav__link"> Redis Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/RelytDemo/" class="md-nav__link"> Relyt </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/RocksetIndexDemo/" class="md-nav__link"> Rockset Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/SimpleIndexDemo/" class="md-nav__link"> Simple Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/SimpleIndexDemoLlama-Local/" class="md-nav__link"> Local Llama2 + VectorStoreIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/SimpleIndexDemoLlama2/" class="md-nav__link"> Llama2 + VectorStoreIndex </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/SimpleIndexDemoMMR/" class="md-nav__link"> Simple Vector Stores - Maximum Marginal Relevance Retrieval </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/SimpleIndexOnS3/" class="md-nav__link"> S3/R2 Storage </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/SupabaseVectorIndexDemo/" class="md-nav__link"> Supabase Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/TablestoreDemo/" class="md-nav__link"> TablestoreVectorStore </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/TairIndexDemo/" class="md-nav__link"> Tair Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/TencentVectorDBIndexDemo/" class="md-nav__link"> Tencent Cloud VectorDB </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/TiDBVector/" class="md-nav__link"> TiDB Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/Timescalevector/" class="md-nav__link"> Timescale Vector Store (PostgreSQL) </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/TxtaiIndexDemo/" class="md-nav__link"> txtai Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/TypesenseDemo/" class="md-nav__link"> Typesense Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/UpstashVectorDemo/" class="md-nav__link"> Upstash Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/VearchDemo/" class="md-nav__link"> VearchDemo </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/VertexAIVectorSearchDemo/" class="md-nav__link"> Google Vertex AI Vector Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/VespaIndexDemo/" class="md-nav__link"> Vespa Vector Store demo </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/WeaviateIndexDemo-Hybrid/" class="md-nav__link"> Weaviate Vector Store - Hybrid Search </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/WeaviateIndexDemo/" class="md-nav__link"> Weaviate Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/WeaviateIndex_auto_retriever/" class="md-nav__link"> Auto-Retrieval from a Weaviate Vector Database </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/WeaviateIndex_metadata_filter/" class="md-nav__link"> Weaviate Vector Store Metadata Filter </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/WordLiftDemo/" class="md-nav__link"> WordLift Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/ZepIndexDemo/" class="md-nav__link"> Zep Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/chroma_auto_retriever/" class="md-nav__link"> Auto-Retrieval from a Vector Database </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/chroma_metadata_filter/" class="md-nav__link"> Chroma Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/elasticsearch_auto_retriever/" class="md-nav__link"> Auto-Retrieval from a Vector Database </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/existing_data/pinecone_existing_data/" class="md-nav__link"> Guide: Using Vector Store Index with Existing Pinecone Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/existing_data/weaviate_existing_data/" class="md-nav__link"> Guide: Using Vector Store Index with Existing Weaviate Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/neo4j_metadata_filter/" class="md-nav__link"> Neo4j Vector Store - Metadata Filter </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/orallamavs/" class="md-nav__link"> Oracle AI Vector Search: Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/pinecone_auto_retriever/" class="md-nav__link"> A Simple to Advanced Guide with Auto-Retrieval (with Pinecone + Arize Phoenix) </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/pinecone_metadata_filter/" class="md-nav__link"> Pinecone Vector Store - Metadata Filter </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/postgres/" class="md-nav__link"> Postgres Vector Store </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/qdrant_bm42/" class="md-nav__link"> Hybrid Search with Qdrant BM42 </a> </li> <li class="md-nav__item"> <a href="../../../examples/vector_stores/qdrant_hybrid/" class="md-nav__link"> Qdrant Hybrid Search </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_39" > <label class="md-nav__link" for="__nav_4_39" id="__nav_4_39_label" tabindex="0"> Workflow </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_39_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_39"> Workflow </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../examples/workflow/JSONalyze_query_engine/" class="md-nav__link"> JSONalyze Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/advanced_text_to_sql/" class="md-nav__link"> Workflows for Advanced Text-to-SQL </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/auto_retrieval.ipynb" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/checkpointing_workflows/" class="md-nav__link"> Checkpointing Workflow Runs </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/citation_query_engine/" class="md-nav__link"> Build RAG with in-line citations </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/corrective_rag_pack/" class="md-nav__link"> Corrective RAG Workflow </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/function_calling_agent/" class="md-nav__link"> Workflow for a Function Calling Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/human_in_the_loop_story_crafting/" class="md-nav__link"> Choose Your Own Adventure Workflow (Human In The Loop) </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/long_rag_pack/" class="md-nav__link"> LongRAG Workflow </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/multi_step_query_engine/" class="md-nav__link"> MultiStep Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/multi_strategy_workflow/" class="md-nav__link"> Multi-strategy workflow with reflection </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/parallel_execution/" class="md-nav__link"> Parallel Execution of Same Event Example </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/planning_workflow/" class="md-nav__link"> Query Planning Workflow </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/rag/" class="md-nav__link"> RAG Workflow with Reranking </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/react_agent/" class="md-nav__link"> Workflow for a ReAct Agent </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/reflection/" class="md-nav__link"> Reflection Workflow for Structured Outputs </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/router_query_engine/" class="md-nav__link"> Router Query Engine </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/self_discover_workflow/" class="md-nav__link"> Self-Discover Workflow </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/sub_question_query_engine/" class="md-nav__link"> Sub Question Query Engine as a workflow </a> </li> <li class="md-nav__item"> <a href="../../../examples/workflow/workflows_cookbook/" class="md-nav__link"> Workflows cookbook: walking through all features of Workflows </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/" class="md-nav__link "> Component Guides </a> <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5"> Component Guides </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/models/" class="md-nav__link "> Models </a> <label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_2"> Models </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2_2" > <label class="md-nav__link" for="__nav_5_2_2" id="__nav_5_2_2_label" tabindex="0"> LLMs </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_2_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_2_2"> LLMs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/models/llms/" class="md-nav__link"> Using LLMs </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/models/llms/usage_standalone/" class="md-nav__link"> Standalone Usage </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/models/llms/usage_custom/" class="md-nav__link"> Customizing LLMs </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/models/llms/modules/" class="md-nav__link"> Available LLM Integrations </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../module_guides/models/embeddings/" class="md-nav__link"> Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/models/multi_modal/" class="md-nav__link"> Multi Modal </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/models/prompts/" class="md-nav__link "> Prompts </a> <label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_3"> Prompts </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/models/prompts/usage_pattern/" class="md-nav__link"> Usage pattern </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/loading/" class="md-nav__link "> Loading </a> <label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4"> Loading </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4_2" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/loading/documents_and_nodes/" class="md-nav__link "> Documents and Nodes </a> <label class="md-nav__link " for="__nav_5_4_2" id="__nav_5_4_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_4_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4_2"> Documents and Nodes </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/loading/documents_and_nodes/usage_documents/" class="md-nav__link"> Using Documents </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/loading/documents_and_nodes/usage_nodes/" class="md-nav__link"> Using Nodes </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/loading/documents_and_nodes/usage_metadata_extractor/" class="md-nav__link"> Metadata Extraction </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../module_guides/loading/simpledirectoryreader/" class="md-nav__link"> SimpleDirectoryReader </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4_4" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/loading/connector/" class="md-nav__link "> Data Connectors </a> <label class="md-nav__link " for="__nav_5_4_4" id="__nav_5_4_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_4_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4_4"> Data Connectors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/loading/connector/usage_pattern/" class="md-nav__link"> Usage Pattern </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/loading/connector/llama_parse/" class="md-nav__link"> LlamaParse </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/loading/connector/modules/" class="md-nav__link"> Module Guides </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4_5" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/loading/node_parsers/" class="md-nav__link "> Node Parsers / Text Splitters </a> <label class="md-nav__link " for="__nav_5_4_5" id="__nav_5_4_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_4_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4_5"> Node Parsers / Text Splitters </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/loading/node_parsers/modules/" class="md-nav__link"> Node Parser Modules </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4_6" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/loading/ingestion_pipeline/" class="md-nav__link "> Ingestion Pipeline </a> <label class="md-nav__link " for="__nav_5_4_6" id="__nav_5_4_6_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_4_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4_6"> Ingestion Pipeline </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/loading/ingestion_pipeline/transformations/" class="md-nav__link"> Transformations </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/indexing/" class="md-nav__link "> Indexing </a> <label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_5"> Indexing </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/indexing/index_guide/" class="md-nav__link"> Index Guide </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/indexing/vector_store_index/" class="md-nav__link"> Vector Store Index </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/indexing/lpg_index_guide/" class="md-nav__link"> Property Graph Index </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/indexing/document_management/" class="md-nav__link"> Document Management </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/indexing/llama_cloud_index/" class="md-nav__link"> LlamaCloud </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/indexing/metadata_extraction/" class="md-nav__link"> Metadata Extraction </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/indexing/modules/" class="md-nav__link"> Modules </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_6" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/storing/" class="md-nav__link "> Storing </a> <label class="md-nav__link " for="__nav_5_6" id="__nav_5_6_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_6"> Storing </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/storing/vector_stores/" class="md-nav__link"> Vector Stores </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/storing/docstores/" class="md-nav__link"> Document Stores </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/storing/index_stores/" class="md-nav__link"> Index Stores </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/storing/chat_stores/" class="md-nav__link"> Chat Stores </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/storing/kv_stores/" class="md-nav__link"> Key-Value Stores </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/storing/save_load/" class="md-nav__link"> Persisting & Loading Data </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/storing/customization/" class="md-nav__link"> Customizing Storage </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/querying/" class="md-nav__link "> Querying </a> <label class="md-nav__link " for="__nav_5_7" id="__nav_5_7_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7"> Querying </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_2" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/deploying/query_engine/" class="md-nav__link "> Query Engines </a> <label class="md-nav__link " for="__nav_5_7_2" id="__nav_5_7_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_2"> Query Engines </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/deploying/query_engine/usage_pattern/" class="md-nav__link"> Usage Pattern </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/query_engine/response_modes/" class="md-nav__link"> Response Modes </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/query_engine/streaming/" class="md-nav__link"> Streaming </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/query_engine/modules/" class="md-nav__link"> Module Guides </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/query_engine/supporting_modules/" class="md-nav__link"> Supporting Modules </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_3" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/deploying/chat_engines/" class="md-nav__link "> Chat Engines </a> <label class="md-nav__link " for="__nav_5_7_3" id="__nav_5_7_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_3"> Chat Engines </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/deploying/chat_engines/usage_pattern/" class="md-nav__link"> Usage Pattern </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/chat_engines/modules/" class="md-nav__link"> Module Guides </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_4" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/querying/retriever/" class="md-nav__link "> Retrieval </a> <label class="md-nav__link " for="__nav_5_7_4" id="__nav_5_7_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_4"> Retrieval </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/querying/retriever/retrievers/" class="md-nav__link"> Retriever Modules </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/querying/retriever/retriever_modes/" class="md-nav__link"> Retriever Modes </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_5" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/querying/node_postprocessors/" class="md-nav__link "> Node Postprocessors </a> <label class="md-nav__link " for="__nav_5_7_5" id="__nav_5_7_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_5"> Node Postprocessors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/querying/node_postprocessors/node_postprocessors/" class="md-nav__link"> Node Postprocessor Modules </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_6" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/querying/response_synthesizers/" class="md-nav__link "> Response Synthesis </a> <label class="md-nav__link " for="__nav_5_7_6" id="__nav_5_7_6_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_6"> Response Synthesis </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/querying/response_synthesizers/response_synthesizers/" class="md-nav__link"> Response Synthesis Modules </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../module_guides/querying/router/" class="md-nav__link"> Routing </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/workflow/" class="md-nav__link"> Workflows </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_9" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/querying/pipeline/" class="md-nav__link "> Query Pipelines (Deprecated) </a> <label class="md-nav__link " for="__nav_5_7_9" id="__nav_5_7_9_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_9"> Query Pipelines (Deprecated) </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/querying/pipeline/usage_pattern/" class="md-nav__link"> Usage Pattern </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/querying/pipeline/modules/" class="md-nav__link"> Module Guides </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/querying/pipeline/module_usage/" class="md-nav__link"> Module Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7_10" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/querying/structured_outputs/" class="md-nav__link "> Structured Outputs </a> <label class="md-nav__link " for="__nav_5_7_10" id="__nav_5_7_10_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_7_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7_10"> Structured Outputs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/querying/structured_outputs/output_parser/" class="md-nav__link"> Output Parsing Modules </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/querying/structured_outputs/query_engine/" class="md-nav__link"> (Deprecated) Query Engines + Pydantic Outputs </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/querying/structured_outputs/pydantic_program/" class="md-nav__link"> Pydantic Programs </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_8" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/deploying/agents/" class="md-nav__link "> Agents </a> <label class="md-nav__link " for="__nav_5_8" id="__nav_5_8_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_8"> Agents </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/deploying/agents/usage_pattern/" class="md-nav__link"> Usage Pattern </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/agents/agent_runner/" class="md-nav__link"> Lower-Level Agent API </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/agents/modules/" class="md-nav__link"> Module Guides </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/deploying/agents/tools/" class="md-nav__link"> Tools </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_9" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/workflow/" class="md-nav__link "> Workflows </a> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_9"> Workflows </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_10" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/evaluating/" class="md-nav__link "> Evaluation </a> <label class="md-nav__link " for="__nav_5_10" id="__nav_5_10_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_10"> Evaluation </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/evaluating/usage_pattern/" class="md-nav__link"> Usage Pattern (Response Evaluation) </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/evaluating/usage_pattern_retrieval/" class="md-nav__link"> Usage Pattern (Retrieval) </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/evaluating/modules/" class="md-nav__link"> Modules </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_10_5" > <label class="md-nav__link" for="__nav_5_10_5" id="__nav_5_10_5_label" tabindex="0"> LlamaDatasets </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_10_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_10_5"> LlamaDatasets </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/evaluating/contributing_llamadatasets/" class="md-nav__link"> Contributing A LabelledRagDataset </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/evaluating/evaluating_with_llamadatasets/" class="md-nav__link"> Evaluating With LabelledRagDataset's </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/evaluating/evaluating_evaluators_with_llamadatasets/" class="md-nav__link"> Evaluating Evaluators with LabelledEvaluatorDataset's </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_11" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/observability/" class="md-nav__link "> Observability </a> <label class="md-nav__link " for="__nav_5_11" id="__nav_5_11_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_11"> Observability </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/observability/instrumentation/" class="md-nav__link"> Instrumentation </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../module_guides/supporting_modules/settings/" class="md-nav__link"> Settings </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_13" > <div class="md-nav__link md-nav__container"> <a href="../../../module_guides/llama_deploy/" class="md-nav__link "> Llama Deploy </a> <label class="md-nav__link " for="__nav_5_13" id="__nav_5_13_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_13_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_13"> Llama Deploy </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../module_guides/llama_deploy/10_getting_started/" class="md-nav__link"> Getting Started </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/llama_deploy/20_core_components/" class="md-nav__link"> Core Components </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/llama_deploy/30_manual_orchestration/" class="md-nav__link"> Manual orchestration </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/llama_deploy/40_python_sdk/" class="md-nav__link"> Python SDK </a> </li> <li class="md-nav__item"> <a href="../../../module_guides/llama_deploy/50_llamactl/" class="md-nav__link"> CLI </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" > <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0"> Advanced Topics </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_6"> Advanced Topics </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../optimizing/production_rag/" class="md-nav__link"> Building Performant RAG Applications for Production </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/basic_strategies/basic_strategies/" class="md-nav__link"> Basic Strategies </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/agentic_strategies/agentic_strategies/" class="md-nav__link"> Agentic strategies </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" > <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0"> Retrieval </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_6_4"> Retrieval </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../optimizing/advanced_retrieval/advanced_retrieval/" class="md-nav__link"> Advanced Retrieval Strategies </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/advanced_retrieval/query_transformations/" class="md-nav__link"> Query Transformations </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" > <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0"> Evaluation </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_6_5"> Evaluation </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../optimizing/evaluation/component_wise_evaluation/" class="md-nav__link"> Component Wise Evaluation </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/evaluation/e2e_evaluation/" class="md-nav__link"> End-to-End Evaluation </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/evaluation/evaluation/" class="md-nav__link"> Evaluation </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../optimizing/fine-tuning/fine-tuning/" class="md-nav__link"> Fine-Tuning </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/custom_modules/" class="md-nav__link"> Writing Custom Modules </a> </li> <li class="md-nav__item"> <a href="../../../optimizing/building_rag_from_scratch/" class="md-nav__link"> Building RAG from Scratch (Lower-Level) </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked> <div class="md-nav__link md-nav__container"> <a href="../../" class="md-nav__link "> API Reference </a> <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex=""> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_7"> API Reference </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_2" > <div class="md-nav__link md-nav__container"> <a href="../../agent/" class="md-nav__link "> Agents </a> <label class="md-nav__link " for="__nav_7_2" id="__nav_7_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_2"> Agents </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../agent/coa/" class="md-nav__link"> Coa </a> </li> <li class="md-nav__item"> <a href="../../agent/dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../../agent/introspective/" class="md-nav__link"> Introspective </a> </li> <li class="md-nav__item"> <a href="../../agent/lats/" class="md-nav__link"> Lats </a> </li> <li class="md-nav__item"> <a href="../../agent/llm_compiler/" class="md-nav__link"> Llm compiler </a> </li> <li class="md-nav__item"> <a href="../../agent/openai/" class="md-nav__link"> Openai </a> </li> <li class="md-nav__item"> <a href="../../agent/openai_legacy/" class="md-nav__link"> Openai legacy </a> </li> <li class="md-nav__item"> <a href="../../agent/react/" class="md-nav__link"> React </a> </li> <li class="md-nav__item"> <a href="../../agent/workflow/" class="md-nav__link"> Workflow </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_3" > <div class="md-nav__link md-nav__container"> <a href="../../callbacks/" class="md-nav__link "> Callbacks </a> <label class="md-nav__link " for="__nav_7_3" id="__nav_7_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_3"> Callbacks </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../callbacks/agentops/" class="md-nav__link"> Agentops </a> </li> <li class="md-nav__item"> <a href="../../callbacks/aim/" class="md-nav__link"> Aim </a> </li> <li class="md-nav__item"> <a href="../../callbacks/argilla/" class="md-nav__link"> Argilla </a> </li> <li class="md-nav__item"> <a href="../../callbacks/arize_phoenix/" class="md-nav__link"> Arize phoenix </a> </li> <li class="md-nav__item"> <a href="../../callbacks/deepeval/" class="md-nav__link"> Deepeval </a> </li> <li class="md-nav__item"> <a href="../../callbacks/honeyhive/" class="md-nav__link"> Honeyhive </a> </li> <li class="md-nav__item"> <a href="../../callbacks/langfuse/" class="md-nav__link"> Langfuse </a> </li> <li class="md-nav__item"> <a href="../../callbacks/literalai/" class="md-nav__link"> Literalai </a> </li> <li class="md-nav__item"> <a href="../../callbacks/llama_debug/" class="md-nav__link"> Llama debug </a> </li> <li class="md-nav__item"> <a href="../../callbacks/openinference/" class="md-nav__link"> Openinference </a> </li> <li class="md-nav__item"> <a href="../../callbacks/opentelemetry.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../callbacks/opik/" class="md-nav__link"> Opik </a> </li> <li class="md-nav__item"> <a href="../../callbacks/promptlayer/" class="md-nav__link"> Promptlayer </a> </li> <li class="md-nav__item"> <a href="../../callbacks/token_counter/" class="md-nav__link"> Token counter </a> </li> <li class="md-nav__item"> <a href="../../callbacks/uptrain/" class="md-nav__link"> Uptrain </a> </li> <li class="md-nav__item"> <a href="../../callbacks/wandb/" class="md-nav__link"> Wandb </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_4" > <div class="md-nav__link md-nav__container"> <a href="../../chat_engines/" class="md-nav__link "> Chat Engines </a> <label class="md-nav__link " for="__nav_7_4" id="__nav_7_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_4"> Chat Engines </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../chat_engines/condense_plus_context/" class="md-nav__link"> Condense plus context </a> </li> <li class="md-nav__item"> <a href="../../chat_engines/condense_question/" class="md-nav__link"> Condense question </a> </li> <li class="md-nav__item"> <a href="../../chat_engines/context/" class="md-nav__link"> Context </a> </li> <li class="md-nav__item"> <a href="../../chat_engines/simple/" class="md-nav__link"> Simple </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_5" > <div class="md-nav__link md-nav__container"> <a href="../../embeddings/" class="md-nav__link "> Embeddings </a> <label class="md-nav__link " for="__nav_7_5" id="__nav_7_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_5"> Embeddings </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../embeddings/adapter/" class="md-nav__link"> Adapter </a> </li> <li class="md-nav__item"> <a href="../../embeddings/alephalpha/" class="md-nav__link"> Alephalpha </a> </li> <li class="md-nav__item"> <a href="../../embeddings/alibabacloud_aisearch/" class="md-nav__link"> Alibabacloud aisearch </a> </li> <li class="md-nav__item"> <a href="../../embeddings/anyscale/" class="md-nav__link"> Anyscale </a> </li> <li class="md-nav__item"> <a href="../../embeddings/azure_inference/" class="md-nav__link"> Azure inference </a> </li> <li class="md-nav__item"> <a href="../../embeddings/azure_openai/" class="md-nav__link"> Azure openai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/bedrock/" class="md-nav__link"> Bedrock </a> </li> <li class="md-nav__item"> <a href="../../embeddings/clarifai/" class="md-nav__link"> Clarifai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/clip/" class="md-nav__link"> Clip </a> </li> <li class="md-nav__item"> <a href="../../embeddings/cloudflare_workersai/" class="md-nav__link"> Cloudflare workersai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/cohere/" class="md-nav__link"> Cohere </a> </li> <li class="md-nav__item"> <a href="../../embeddings/dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../../embeddings/databricks/" class="md-nav__link"> Databricks </a> </li> <li class="md-nav__item"> <a href="../../embeddings/deepinfra/" class="md-nav__link"> Deepinfra </a> </li> <li class="md-nav__item"> <a href="../../embeddings/elasticsearch/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../../embeddings/fastembed/" class="md-nav__link"> Fastembed </a> </li> <li class="md-nav__item"> <a href="../../embeddings/fireworks/" class="md-nav__link"> Fireworks </a> </li> <li class="md-nav__item"> <a href="../../embeddings/gaudi/" class="md-nav__link"> Gaudi </a> </li> <li class="md-nav__item"> <a href="../../embeddings/gemini/" class="md-nav__link"> Gemini </a> </li> <li class="md-nav__item"> <a href="../../embeddings/gigachat/" class="md-nav__link"> Gigachat </a> </li> <li class="md-nav__item"> <a href="../../embeddings/google/" class="md-nav__link"> Google </a> </li> <li class="md-nav__item"> <a href="../../embeddings/gradient.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../embeddings/huggingface/" class="md-nav__link"> Huggingface </a> </li> <li class="md-nav__item"> <a href="../../embeddings/huggingface_api/" class="md-nav__link"> Huggingface api </a> </li> <li class="md-nav__item"> <a href="../../embeddings/huggingface_openvino/" class="md-nav__link"> Huggingface openvino </a> </li> <li class="md-nav__item"> <a href="../../embeddings/huggingface_optimum/" class="md-nav__link"> Huggingface optimum </a> </li> <li class="md-nav__item"> <a href="../../embeddings/huggingface_optimum_intel/" class="md-nav__link"> Huggingface optimum intel </a> </li> <li class="md-nav__item"> <a href="../../embeddings/ibm/" class="md-nav__link"> Ibm </a> </li> <li class="md-nav__item"> <a href="../../embeddings/instructor/" class="md-nav__link"> Instructor </a> </li> <li class="md-nav__item"> <a href="../../embeddings/ipex_llm/" class="md-nav__link"> Ipex llm </a> </li> <li class="md-nav__item"> <a href="../../embeddings/jinaai/" class="md-nav__link"> Jinaai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/langchain/" class="md-nav__link"> Langchain </a> </li> <li class="md-nav__item"> <a href="../../embeddings/litellm/" class="md-nav__link"> Litellm </a> </li> <li class="md-nav__item"> <a href="../../embeddings/llamafile/" class="md-nav__link"> Llamafile </a> </li> <li class="md-nav__item"> <a href="../../embeddings/llm_rails/" class="md-nav__link"> Llm rails </a> </li> <li class="md-nav__item"> <a href="../../embeddings/mistralai/" class="md-nav__link"> Mistralai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/mixedbreadai/" class="md-nav__link"> Mixedbreadai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/modelscope/" class="md-nav__link"> Modelscope </a> </li> <li class="md-nav__item"> <a href="../../embeddings/nebius/" class="md-nav__link"> Nebius </a> </li> <li class="md-nav__item"> <a href="../../embeddings/nomic/" class="md-nav__link"> Nomic </a> </li> <li class="md-nav__item"> <a href="../../embeddings/nvidia/" class="md-nav__link"> Nvidia </a> </li> <li class="md-nav__item"> <a href="../../embeddings/oci_data_science/" class="md-nav__link"> Oci data science </a> </li> <li class="md-nav__item"> <a href="../../embeddings/oci_genai/" class="md-nav__link"> Oci genai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/octoai.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../embeddings/ollama/" class="md-nav__link"> Ollama </a> </li> <li class="md-nav__item"> <a href="../../embeddings/opea/" class="md-nav__link"> Opea </a> </li> <li class="md-nav__item"> <a href="../../embeddings/openai/" class="md-nav__link"> Openai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/oracleai/" class="md-nav__link"> Oracleai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/premai/" class="md-nav__link"> Premai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/sagemaker_endpoint/" class="md-nav__link"> Sagemaker endpoint </a> </li> <li class="md-nav__item"> <a href="../../embeddings/siliconflow/" class="md-nav__link"> Siliconflow </a> </li> <li class="md-nav__item"> <a href="../../embeddings/text_embeddings_inference/" class="md-nav__link"> Text embeddings inference </a> </li> <li class="md-nav__item"> <a href="../../embeddings/textembed/" class="md-nav__link"> Textembed </a> </li> <li class="md-nav__item"> <a href="../../embeddings/together/" class="md-nav__link"> Together </a> </li> <li class="md-nav__item"> <a href="../../embeddings/upstage/" class="md-nav__link"> Upstage </a> </li> <li class="md-nav__item"> <a href="../../embeddings/vertex/" class="md-nav__link"> Vertex </a> </li> <li class="md-nav__item"> <a href="../../embeddings/vertex_endpoint/" class="md-nav__link"> Vertex endpoint </a> </li> <li class="md-nav__item"> <a href="../../embeddings/vllm/" class="md-nav__link"> Vllm </a> </li> <li class="md-nav__item"> <a href="../../embeddings/voyageai/" class="md-nav__link"> Voyageai </a> </li> <li class="md-nav__item"> <a href="../../embeddings/xinference/" class="md-nav__link"> Xinference </a> </li> <li class="md-nav__item"> <a href="../../embeddings/yandexgpt/" class="md-nav__link"> Yandexgpt </a> </li> <li class="md-nav__item"> <a href="../../embeddings/zhipuai/" class="md-nav__link"> Zhipuai </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_6" > <div class="md-nav__link md-nav__container"> <a href="../../evaluation/" class="md-nav__link "> Evaluation </a> <label class="md-nav__link " for="__nav_7_6" id="__nav_7_6_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_6"> Evaluation </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../evaluation/answer_relevancy/" class="md-nav__link"> Answer relevancy </a> </li> <li class="md-nav__item"> <a href="../../evaluation/context_relevancy/" class="md-nav__link"> Context relevancy </a> </li> <li class="md-nav__item"> <a href="../../evaluation/correctness/" class="md-nav__link"> Correctness </a> </li> <li class="md-nav__item"> <a href="../../evaluation/dataset_generation/" class="md-nav__link"> Dataset generation </a> </li> <li class="md-nav__item"> <a href="../../evaluation/faithfullness/" class="md-nav__link"> Faithfullness </a> </li> <li class="md-nav__item"> <a href="../../evaluation/guideline/" class="md-nav__link"> Guideline </a> </li> <li class="md-nav__item"> <a href="../../evaluation/metrics/" class="md-nav__link"> Metrics </a> </li> <li class="md-nav__item"> <a href="../../evaluation/multi_modal/" class="md-nav__link"> Multi modal </a> </li> <li class="md-nav__item"> <a href="../../evaluation/pairwise_comparison/" class="md-nav__link"> Pairwise comparison </a> </li> <li class="md-nav__item"> <a href="../../evaluation/query_response/" class="md-nav__link"> Query response </a> </li> <li class="md-nav__item"> <a href="../../evaluation/response/" class="md-nav__link"> Response </a> </li> <li class="md-nav__item"> <a href="../../evaluation/retrieval/" class="md-nav__link"> Retrieval </a> </li> <li class="md-nav__item"> <a href="../../evaluation/semantic_similarity/" class="md-nav__link"> Semantic similarity </a> </li> <li class="md-nav__item"> <a href="../../evaluation/tonic_validate/" class="md-nav__link"> Tonic validate </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_7" > <label class="md-nav__link" for="__nav_7_7" id="__nav_7_7_label" tabindex="0"> Graph RAG </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_7"> Graph RAG </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../graph_rag/cognee/" class="md-nav__link"> Cognee </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_8" > <div class="md-nav__link md-nav__container"> <a href="../../indices/" class="md-nav__link "> Indexes </a> <label class="md-nav__link " for="__nav_7_8" id="__nav_7_8_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_8"> Indexes </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../indices/bge_m3/" class="md-nav__link"> Bge m3 </a> </li> <li class="md-nav__item"> <a href="../../indices/colbert/" class="md-nav__link"> Colbert </a> </li> <li class="md-nav__item"> <a href="../../indices/dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../../indices/document_summary/" class="md-nav__link"> Document summary </a> </li> <li class="md-nav__item"> <a href="../../indices/google/" class="md-nav__link"> Google </a> </li> <li class="md-nav__item"> <a href="../../indices/keyword/" class="md-nav__link"> Keyword </a> </li> <li class="md-nav__item"> <a href="../../indices/knowledge_graph/" class="md-nav__link"> Knowledge graph </a> </li> <li class="md-nav__item"> <a href="../../indices/llama_cloud/" class="md-nav__link"> Llama cloud </a> </li> <li class="md-nav__item"> <a href="../../indices/postgresml/" class="md-nav__link"> Postgresml </a> </li> <li class="md-nav__item"> <a href="../../indices/property_graph/" class="md-nav__link"> Property graph </a> </li> <li class="md-nav__item"> <a href="../../indices/summary/" class="md-nav__link"> Summary </a> </li> <li class="md-nav__item"> <a href="../../indices/tree/" class="md-nav__link"> Tree </a> </li> <li class="md-nav__item"> <a href="../../indices/vectara/" class="md-nav__link"> Vectara </a> </li> <li class="md-nav__item"> <a href="../../indices/vector/" class="md-nav__link"> Vector </a> </li> <li class="md-nav__item"> <a href="../../indices/vertexai/" class="md-nav__link"> Vertexai </a> </li> <li class="md-nav__item"> <a href="../../indices/zilliz/" class="md-nav__link"> Zilliz </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_9" > <div class="md-nav__link md-nav__container"> <a href="../../ingestion/" class="md-nav__link "> Ingestion </a> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_9"> Ingestion </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_10" > <div class="md-nav__link md-nav__container"> <a href="../../instrumentation/" class="md-nav__link "> Instrumentation </a> <label class="md-nav__link " for="__nav_7_10" id="__nav_7_10_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_10"> Instrumentation </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../instrumentation/event_handlers/" class="md-nav__link"> Event handlers </a> </li> <li class="md-nav__item"> <a href="../../instrumentation/event_types/" class="md-nav__link"> Event types </a> </li> <li class="md-nav__item"> <a href="../../instrumentation/span_handlers/" class="md-nav__link"> Span handlers </a> </li> <li class="md-nav__item"> <a href="../../instrumentation/span_types/" class="md-nav__link"> Span types </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_11" > <div class="md-nav__link md-nav__container"> <a href="../../llms/" class="md-nav__link "> LLMs </a> <label class="md-nav__link " for="__nav_7_11" id="__nav_7_11_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_11"> LLMs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../llms/OptimumIntelLLM.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../llms/ai21/" class="md-nav__link"> Ai21 </a> </li> <li class="md-nav__item"> <a href="../../llms/alephalpha/" class="md-nav__link"> Alephalpha </a> </li> <li class="md-nav__item"> <a href="../../llms/alibabacloud_aisearch/" class="md-nav__link"> Alibabacloud aisearch </a> </li> <li class="md-nav__item"> <a href="../../llms/anthropic/" class="md-nav__link"> Anthropic </a> </li> <li class="md-nav__item"> <a href="../../llms/anyscale/" class="md-nav__link"> Anyscale </a> </li> <li class="md-nav__item"> <a href="../../llms/azure_inference/" class="md-nav__link"> Azure inference </a> </li> <li class="md-nav__item"> <a href="../../llms/azure_openai/" class="md-nav__link"> Azure openai </a> </li> <li class="md-nav__item"> <a href="../../llms/bedrock/" class="md-nav__link"> Bedrock </a> </li> <li class="md-nav__item"> <a href="../../llms/bedrock_converse/" class="md-nav__link"> Bedrock converse </a> </li> <li class="md-nav__item"> <a href="../../llms/cerebras/" class="md-nav__link"> Cerebras </a> </li> <li class="md-nav__item"> <a href="../../llms/clarifai/" class="md-nav__link"> Clarifai </a> </li> <li class="md-nav__item"> <a href="../../llms/cleanlab/" class="md-nav__link"> Cleanlab </a> </li> <li class="md-nav__item"> <a href="../../llms/cohere/" class="md-nav__link"> Cohere </a> </li> <li class="md-nav__item"> <a href="../../llms/cortex/" class="md-nav__link"> Cortex </a> </li> <li class="md-nav__item"> <a href="../../llms/custom_llm/" class="md-nav__link"> Custom llm </a> </li> <li class="md-nav__item"> <a href="../../llms/dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../../llms/databricks/" class="md-nav__link"> Databricks </a> </li> <li class="md-nav__item"> <a href="../../llms/deepinfra/" class="md-nav__link"> Deepinfra </a> </li> <li class="md-nav__item"> <a href="../../llms/deepseek/" class="md-nav__link"> Deepseek </a> </li> <li class="md-nav__item"> <a href="../../llms/everlyai/" class="md-nav__link"> Everlyai </a> </li> <li class="md-nav__item"> <a href="../../llms/fireworks/" class="md-nav__link"> Fireworks </a> </li> <li class="md-nav__item"> <a href="../../llms/friendli/" class="md-nav__link"> Friendli </a> </li> <li class="md-nav__item"> <a href="../../llms/gaudi/" class="md-nav__link"> Gaudi </a> </li> <li class="md-nav__item"> <a href="../../llms/gemini/" class="md-nav__link"> Gemini </a> </li> <li class="md-nav__item"> <a href="../../llms/gigachat/" class="md-nav__link"> Gigachat </a> </li> <li class="md-nav__item"> <a href="../../llms/gradient.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../llms/groq/" class="md-nav__link"> Groq </a> </li> <li class="md-nav__item"> <a href="../../llms/huggingface/" class="md-nav__link"> Huggingface </a> </li> <li class="md-nav__item"> <a href="../../llms/huggingface_api/" class="md-nav__link"> Huggingface api </a> </li> <li class="md-nav__item"> <a href="../../llms/ibm/" class="md-nav__link"> Ibm </a> </li> <li class="md-nav__item"> <a href="../../llms/ipex_llm/" class="md-nav__link"> Ipex llm </a> </li> <li class="md-nav__item"> <a href="../../llms/keywordsai/" class="md-nav__link"> Keywordsai </a> </li> <li class="md-nav__item"> <a href="../../llms/konko/" class="md-nav__link"> Konko </a> </li> <li class="md-nav__item"> <a href="../../llms/langchain/" class="md-nav__link"> Langchain </a> </li> <li class="md-nav__item"> <a href="../../llms/litellm/" class="md-nav__link"> Litellm </a> </li> <li class="md-nav__item"> <a href="../../llms/llama_api/" class="md-nav__link"> Llama api </a> </li> <li class="md-nav__item"> <a href="../../llms/llama_cpp/" class="md-nav__link"> Llama cpp </a> </li> <li class="md-nav__item"> <a href="../../llms/llamafile/" class="md-nav__link"> Llamafile </a> </li> <li class="md-nav__item"> <a href="../../llms/lmstudio/" class="md-nav__link"> Lmstudio </a> </li> <li class="md-nav__item"> <a href="../../llms/localai/" class="md-nav__link"> Localai </a> </li> <li class="md-nav__item"> <a href="../../llms/maritalk/" class="md-nav__link"> Maritalk </a> </li> <li class="md-nav__item"> <a href="../../llms/mistral_rs/" class="md-nav__link"> Mistral rs </a> </li> <li class="md-nav__item"> <a href="../../llms/mistralai/" class="md-nav__link"> Mistralai </a> </li> <li class="md-nav__item"> <a href="../../llms/mlx/" class="md-nav__link"> Mlx </a> </li> <li class="md-nav__item"> <a href="../../llms/modelscope/" class="md-nav__link"> Modelscope </a> </li> <li class="md-nav__item"> <a href="../../llms/monsterapi/" class="md-nav__link"> Monsterapi </a> </li> <li class="md-nav__item"> <a href="../../llms/mymagic/" class="md-nav__link"> Mymagic </a> </li> <li class="md-nav__item"> <a href="../../llms/nebius/" class="md-nav__link"> Nebius </a> </li> <li class="md-nav__item"> <a href="../../llms/neutrino/" class="md-nav__link"> Neutrino </a> </li> <li class="md-nav__item"> <a href="../../llms/nvidia/" class="md-nav__link"> Nvidia </a> </li> <li class="md-nav__item"> <a href="../../llms/nvidia_tensorrt/" class="md-nav__link"> Nvidia tensorrt </a> </li> <li class="md-nav__item"> <a href="../../llms/nvidia_triton/" class="md-nav__link"> Nvidia triton </a> </li> <li class="md-nav__item"> <a href="../../llms/oci_data_science/" class="md-nav__link"> Oci data science </a> </li> <li class="md-nav__item"> <a href="../../llms/oci_genai/" class="md-nav__link"> Oci genai </a> </li> <li class="md-nav__item"> <a href="../../llms/octoai/" class="md-nav__link"> Octoai </a> </li> <li class="md-nav__item"> <a href="../../llms/ollama/" class="md-nav__link"> Ollama </a> </li> <li class="md-nav__item"> <a href="../../llms/opea/" class="md-nav__link"> Opea </a> </li> <li class="md-nav__item"> <a href="../../llms/openai/" class="md-nav__link"> Openai </a> </li> <li class="md-nav__item"> <a href="../../llms/openai_like/" class="md-nav__link"> Openai like </a> </li> <li class="md-nav__item"> <a href="../../llms/openllm/" class="md-nav__link"> Openllm </a> </li> <li class="md-nav__item"> <a href="../../llms/openrouter/" class="md-nav__link"> Openrouter </a> </li> <li class="md-nav__item"> <a href="../../llms/openvino/" class="md-nav__link"> Openvino </a> </li> <li class="md-nav__item"> <a href="../../llms/openvino_genai/" class="md-nav__link"> Openvino genai </a> </li> <li class="md-nav__item"> <a href="../../llms/optimum_intel/" class="md-nav__link"> Optimum intel </a> </li> <li class="md-nav__item"> <a href="../../llms/paieas/" class="md-nav__link"> Paieas </a> </li> <li class="md-nav__item"> <a href="../../llms/palm/" class="md-nav__link"> Palm </a> </li> <li class="md-nav__item"> <a href="../../llms/perplexity/" class="md-nav__link"> Perplexity </a> </li> <li class="md-nav__item"> <a href="../../llms/pipeshift/" class="md-nav__link"> Pipeshift </a> </li> <li class="md-nav__item"> <a href="../../llms/portkey/" class="md-nav__link"> Portkey </a> </li> <li class="md-nav__item"> <a href="../../llms/predibase/" class="md-nav__link"> Predibase </a> </li> <li class="md-nav__item"> <a href="../../llms/premai/" class="md-nav__link"> Premai </a> </li> <li class="md-nav__item"> <a href="../../llms/qianfan/" class="md-nav__link"> Qianfan </a> </li> <li class="md-nav__item"> <a href="../../llms/reka/" class="md-nav__link"> Reka </a> </li> <li class="md-nav__item"> <a href="../../llms/replicate/" class="md-nav__link"> Replicate </a> </li> <li class="md-nav__item"> <a href="../../llms/rungpt/" class="md-nav__link"> Rungpt </a> </li> <li class="md-nav__item"> <a href="../../llms/sagemaker_endpoint/" class="md-nav__link"> Sagemaker endpoint </a> </li> <li class="md-nav__item"> <a href="../../llms/sambanovasystems/" class="md-nav__link"> Sambanovasystems </a> </li> <li class="md-nav__item"> <a href="../../llms/siliconflow/" class="md-nav__link"> Siliconflow </a> </li> <li class="md-nav__item"> <a href="../../llms/solar.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../llms/stepfun/" class="md-nav__link"> Stepfun </a> </li> <li class="md-nav__item"> <a href="../../llms/text_generation_inference/" class="md-nav__link"> Text generation inference </a> </li> <li class="md-nav__item"> <a href="../../llms/together/" class="md-nav__link"> Together </a> </li> <li class="md-nav__item"> <a href="../../llms/unify.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../llms/upstage/" class="md-nav__link"> Upstage </a> </li> <li class="md-nav__item"> <a href="../../llms/vertex/" class="md-nav__link"> Vertex </a> </li> <li class="md-nav__item"> <a href="../../llms/vllm/" class="md-nav__link"> Vllm </a> </li> <li class="md-nav__item"> <a href="../../llms/xinference/" class="md-nav__link"> Xinference </a> </li> <li class="md-nav__item"> <a href="../../llms/yi/" class="md-nav__link"> Yi </a> </li> <li class="md-nav__item"> <a href="../../llms/you/" class="md-nav__link"> You </a> </li> <li class="md-nav__item"> <a href="../../llms/zhipuai/" class="md-nav__link"> Zhipuai </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_12" > <div class="md-nav__link md-nav__container"> <a href="../../llama_dataset/" class="md-nav__link "> Llama Datasets </a> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_12_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_12"> Llama Datasets </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_13" > <label class="md-nav__link" for="__nav_7_13" id="__nav_7_13_label" tabindex="0"> Llama Deploy </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_13_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_13"> Llama Deploy </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../llama_deploy/apiserver/" class="md-nav__link"> apiserver </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/control_plane/" class="md-nav__link"> control_plane </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/deploy/" class="md-nav__link"> deploy </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/message_consumers/" class="md-nav__link"> message_consumers </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/message_publishers/" class="md-nav__link"> message_publishers </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/messages/" class="md-nav__link"> messages </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/orchestrators/" class="md-nav__link"> orchestrators </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/python_sdk/" class="md-nav__link"> Python SDK </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/services/" class="md-nav__link"> services </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/types/" class="md-nav__link"> types </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_13_11" > <div class="md-nav__link md-nav__container"> <a href="../../llama_deploy/message_queues/" class="md-nav__link "> message_queues </a> <label class="md-nav__link " for="__nav_7_13_11" id="__nav_7_13_11_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_13_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_13_11"> message_queues </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../llama_deploy/message_queues/kafka/" class="md-nav__link"> apache_kafka </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/message_queues/rabbitmq/" class="md-nav__link"> rabbitmq </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/message_queues/redis/" class="md-nav__link"> redis </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/message_queues/simple/" class="md-nav__link"> simple </a> </li> <li class="md-nav__item"> <a href="../../llama_deploy/message_queues/solace/" class="md-nav__link"> solace </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_14" > <div class="md-nav__link md-nav__container"> <a href="../../packs/" class="md-nav__link "> Llama Packs </a> <label class="md-nav__link " for="__nav_7_14" id="__nav_7_14_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_14_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_14"> Llama Packs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../packs/agent_search_retriever/" class="md-nav__link"> Agent search retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/agents_coa/" class="md-nav__link"> Agents coa </a> </li> <li class="md-nav__item"> <a href="../../packs/agents_lats/" class="md-nav__link"> Agents lats </a> </li> <li class="md-nav__item"> <a href="../../packs/agents_llm_compiler/" class="md-nav__link"> Agents llm compiler </a> </li> <li class="md-nav__item"> <a href="../../packs/amazon_product_extraction/" class="md-nav__link"> Amazon product extraction </a> </li> <li class="md-nav__item"> <a href="../../packs/arize_phoenix_query_engine/" class="md-nav__link"> Arize phoenix query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/auto_merging_retriever/" class="md-nav__link"> Auto merging retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/chroma_autoretrieval/" class="md-nav__link"> Chroma autoretrieval </a> </li> <li class="md-nav__item"> <a href="../../packs/code_hierarchy/" class="md-nav__link"> Code hierarchy </a> </li> <li class="md-nav__item"> <a href="../../packs/cogniswitch_agent/" class="md-nav__link"> Cogniswitch agent </a> </li> <li class="md-nav__item"> <a href="../../packs/cohere_citation_chat/" class="md-nav__link"> Cohere citation chat </a> </li> <li class="md-nav__item"> <a href="../../packs/corrective_rag/" class="md-nav__link"> Corrective rag </a> </li> <li class="md-nav__item"> <a href="../../packs/deeplake_deepmemory_retriever/" class="md-nav__link"> Deeplake deepmemory retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/deeplake_multimodal_retrieval/" class="md-nav__link"> Deeplake multimodal retrieval </a> </li> <li class="md-nav__item"> <a href="../../packs/dense_x_retrieval/" class="md-nav__link"> Dense x retrieval </a> </li> <li class="md-nav__item"> <a href="../../packs/diff_private_simple_dataset/" class="md-nav__link"> Diff private simple dataset </a> </li> <li class="md-nav__item"> <a href="../../packs/evaluator_benchmarker/" class="md-nav__link"> Evaluator benchmarker </a> </li> <li class="md-nav__item"> <a href="../../packs/fusion_retriever/" class="md-nav__link"> Fusion retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/fuzzy_citation/" class="md-nav__link"> Fuzzy citation </a> </li> <li class="md-nav__item"> <a href="../../packs/gmail_openai_agent/" class="md-nav__link"> Gmail openai agent </a> </li> <li class="md-nav__item"> <a href="../../packs/gradio_agent_chat/" class="md-nav__link"> Gradio agent chat </a> </li> <li class="md-nav__item"> <a href="../../packs/gradio_react_agent_chatbot/" class="md-nav__link"> Gradio react agent chatbot </a> </li> <li class="md-nav__item"> <a href="../../packs/infer_retrieve_rerank/" class="md-nav__link"> Infer retrieve rerank </a> </li> <li class="md-nav__item"> <a href="../../packs/koda_retriever/" class="md-nav__link"> Koda retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/llama_dataset_metadata/" class="md-nav__link"> Llama dataset metadata </a> </li> <li class="md-nav__item"> <a href="../../packs/llama_guard_moderator/" class="md-nav__link"> Llama guard moderator </a> </li> <li class="md-nav__item"> <a href="../../packs/llava_completion/" class="md-nav__link"> Llava completion </a> </li> <li class="md-nav__item"> <a href="../../packs/longrag/" class="md-nav__link"> Longrag </a> </li> <li class="md-nav__item"> <a href="../../packs/mixture_of_agents/" class="md-nav__link"> Mixture of agents </a> </li> <li class="md-nav__item"> <a href="../../packs/multi_document_agents/" class="md-nav__link"> Multi document agents </a> </li> <li class="md-nav__item"> <a href="../../packs/multi_tenancy_rag/" class="md-nav__link"> Multi tenancy rag </a> </li> <li class="md-nav__item"> <a href="../../packs/multidoc_autoretrieval/" class="md-nav__link"> Multidoc autoretrieval </a> </li> <li class="md-nav__item"> <a href="../../packs/nebulagraph_query_engine/" class="md-nav__link"> Nebulagraph query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/neo4j_query_engine/" class="md-nav__link"> Neo4j query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/node_parser_semantic_chunking/" class="md-nav__link"> Node parser semantic chunking </a> </li> <li class="md-nav__item"> <a href="../../packs/ollama_query_engine/" class="md-nav__link"> Ollama query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/panel_chatbot/" class="md-nav__link"> Panel chatbot </a> </li> <li class="md-nav__item"> <a href="../../packs/query_understanding_agent/" class="md-nav__link"> Query understanding agent </a> </li> <li class="md-nav__item"> <a href="../../packs/raft_dataset/" class="md-nav__link"> Raft dataset </a> </li> <li class="md-nav__item"> <a href="../../packs/rag_cli_local/" class="md-nav__link"> Rag cli local </a> </li> <li class="md-nav__item"> <a href="../../packs/rag_evaluator/" class="md-nav__link"> Rag evaluator </a> </li> <li class="md-nav__item"> <a href="../../packs/rag_fusion_query_pipeline/" class="md-nav__link"> Rag fusion query pipeline </a> </li> <li class="md-nav__item"> <a href="../../packs/ragatouille_retriever/" class="md-nav__link"> Ragatouille retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/raptor/" class="md-nav__link"> Raptor </a> </li> <li class="md-nav__item"> <a href="../../packs/recursive_retriever/" class="md-nav__link"> Recursive retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/resume_screener/" class="md-nav__link"> Resume screener </a> </li> <li class="md-nav__item"> <a href="../../packs/retry_engine_weaviate/" class="md-nav__link"> Retry engine weaviate </a> </li> <li class="md-nav__item"> <a href="../../packs/secgpt/" class="md-nav__link"> Secgpt </a> </li> <li class="md-nav__item"> <a href="../../packs/self_discover/" class="md-nav__link"> Self discover </a> </li> <li class="md-nav__item"> <a href="../../packs/self_rag/" class="md-nav__link"> Self rag </a> </li> <li class="md-nav__item"> <a href="../../packs/sentence_window_retriever/" class="md-nav__link"> Sentence window retriever </a> </li> <li class="md-nav__item"> <a href="../../packs/snowflake_query_engine/" class="md-nav__link"> Snowflake query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/stock_market_data_query_engine/" class="md-nav__link"> Stock market data query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/streamlit_chatbot/" class="md-nav__link"> Streamlit chatbot </a> </li> <li class="md-nav__item"> <a href="../../packs/sub_question_weaviate/" class="md-nav__link"> Sub question weaviate </a> </li> <li class="md-nav__item"> <a href="../../packs/tables/" class="md-nav__link"> Tables </a> </li> <li class="md-nav__item"> <a href="../../packs/timescale_vector_autoretrieval/" class="md-nav__link"> Timescale vector autoretrieval </a> </li> <li class="md-nav__item"> <a href="../../packs/trulens_eval_packs/" class="md-nav__link"> Trulens eval packs </a> </li> <li class="md-nav__item"> <a href="../../packs/vanna.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../packs/vectara_rag/" class="md-nav__link"> Vectara rag </a> </li> <li class="md-nav__item"> <a href="../../packs/voyage_query_engine/" class="md-nav__link"> Voyage query engine </a> </li> <li class="md-nav__item"> <a href="../../packs/zenguard/" class="md-nav__link"> Zenguard </a> </li> <li class="md-nav__item"> <a href="../../packs/zephyr_query_engine/" class="md-nav__link"> Zephyr query engine </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_15" > <div class="md-nav__link md-nav__container"> <a href="../../memory/" class="md-nav__link "> Memory </a> <label class="md-nav__link " for="__nav_7_15" id="__nav_7_15_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_15_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_15"> Memory </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../memory/chat_memory_buffer/" class="md-nav__link"> Chat memory buffer </a> </li> <li class="md-nav__item"> <a href="../../memory/mem0/" class="md-nav__link"> Mem0 </a> </li> <li class="md-nav__item"> <a href="../../memory/simple_composable_memory/" class="md-nav__link"> Simple composable memory </a> </li> <li class="md-nav__item"> <a href="../../memory/vector_memory/" class="md-nav__link"> Vector memory </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_16" > <div class="md-nav__link md-nav__container"> <a href="../../extractors/" class="md-nav__link "> Metadata Extractors </a> <label class="md-nav__link " for="__nav_7_16" id="__nav_7_16_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_16_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_16"> Metadata Extractors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../extractors/documentcontext/" class="md-nav__link"> Documentcontext </a> </li> <li class="md-nav__item"> <a href="../../extractors/entity/" class="md-nav__link"> Entity </a> </li> <li class="md-nav__item"> <a href="../../extractors/keyword/" class="md-nav__link"> Keyword </a> </li> <li class="md-nav__item"> <a href="../../extractors/llama_extract.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../extractors/marvin/" class="md-nav__link"> Marvin </a> </li> <li class="md-nav__item"> <a href="../../extractors/pydantic/" class="md-nav__link"> Pydantic </a> </li> <li class="md-nav__item"> <a href="../../extractors/question/" class="md-nav__link"> Question </a> </li> <li class="md-nav__item"> <a href="../../extractors/relik/" class="md-nav__link"> Relik </a> </li> <li class="md-nav__item"> <a href="../../extractors/summary/" class="md-nav__link"> Summary </a> </li> <li class="md-nav__item"> <a href="../../extractors/title/" class="md-nav__link"> Title </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_17" > <div class="md-nav__link md-nav__container"> <a href="../../multi_modal_llms/" class="md-nav__link "> Multi-Modal LLMs </a> <label class="md-nav__link " for="__nav_7_17" id="__nav_7_17_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_17_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_17"> Multi-Modal LLMs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../multi_modal_llms/anthropic/" class="md-nav__link"> Anthropic </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/azure_openai/" class="md-nav__link"> Azure openai </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/bedrock/" class="md-nav__link"> Bedrock </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/gemini/" class="md-nav__link"> Gemini </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/huggingface/" class="md-nav__link"> Huggingface </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/mistralai/" class="md-nav__link"> Mistralai </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/nebius/" class="md-nav__link"> Nebius </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/nvidia/" class="md-nav__link"> Nvidia </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/ollama/" class="md-nav__link"> Ollama </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/openai/" class="md-nav__link"> Openai </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/openvino/" class="md-nav__link"> Openvino </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/reka/" class="md-nav__link"> Reka </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/replicate/" class="md-nav__link"> Replicate </a> </li> <li class="md-nav__item"> <a href="../../multi_modal_llms/zhipuai/" class="md-nav__link"> Zhipuai </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_18" > <div class="md-nav__link md-nav__container"> <a href="../../node_parsers/" class="md-nav__link "> Node Parsers & Text Splitters </a> <label class="md-nav__link " for="__nav_7_18" id="__nav_7_18_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_18_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_18"> Node Parsers & Text Splitters </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../node_parser/alibabacloud_aisearch/" class="md-nav__link"> Alibabacloud aisearch </a> </li> <li class="md-nav__item"> <a href="../../node_parser/dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../../node_parser/docling/" class="md-nav__link"> Docling </a> </li> <li class="md-nav__item"> <a href="../../node_parser/topic/" class="md-nav__link"> Topic </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/code/" class="md-nav__link"> Code </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/hierarchical/" class="md-nav__link"> Hierarchical </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/html/" class="md-nav__link"> Html </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/json/" class="md-nav__link"> Json </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/langchain/" class="md-nav__link"> Langchain </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/markdown/" class="md-nav__link"> Markdown </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/markdown_element/" class="md-nav__link"> Markdown element </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/semantic_splitter/" class="md-nav__link"> Semantic splitter </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/sentence_splitter/" class="md-nav__link"> Sentence splitter </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/sentence_window/" class="md-nav__link"> Sentence window </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/token_text_splitter/" class="md-nav__link"> Token text splitter </a> </li> <li class="md-nav__item"> <a href="../../node_parsers/unstructured_element/" class="md-nav__link"> Unstructured element </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_19" > <div class="md-nav__link md-nav__container"> <a href="../../postprocessor/" class="md-nav__link "> Node Postprocessors </a> <label class="md-nav__link " for="__nav_7_19" id="__nav_7_19_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_19_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_19"> Node Postprocessors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../postprocessor/NER_PII/" class="md-nav__link"> NER PII </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/PII/" class="md-nav__link"> PII </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/alibabacloud_aisearch_rerank/" class="md-nav__link"> Alibabacloud aisearch rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/auto_prev_next/" class="md-nav__link"> Auto prev next </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/bedrock_rerank/" class="md-nav__link"> Bedrock rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/cohere_rerank/" class="md-nav__link"> Cohere rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/colbert_rerank/" class="md-nav__link"> Colbert rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/colpali_rerank/" class="md-nav__link"> Colpali rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/dashscope_rerank/" class="md-nav__link"> Dashscope rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/embedding_recency/" class="md-nav__link"> Embedding recency </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/fixed_recency/" class="md-nav__link"> Fixed recency </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/flag_embedding_reranker/" class="md-nav__link"> Flag embedding reranker </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/jinaai_rerank/" class="md-nav__link"> Jinaai rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/keyword/" class="md-nav__link"> Keyword </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/llm_rerank/" class="md-nav__link"> Llm rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/long_context_reorder/" class="md-nav__link"> Long context reorder </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/longllmlingua/" class="md-nav__link"> Longllmlingua </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/metadata_replacement/" class="md-nav__link"> Metadata replacement </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/mixedbreadai_rerank/" class="md-nav__link"> Mixedbreadai rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/nvidia_rerank/" class="md-nav__link"> Nvidia rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/openvino_rerank/" class="md-nav__link"> Openvino rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/pinecone_native_rerank/" class="md-nav__link"> Pinecone native rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/presidio/" class="md-nav__link"> Presidio </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/prev_next/" class="md-nav__link"> Prev next </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/rankgpt_rerank/" class="md-nav__link"> Rankgpt rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/rankllm_rerank/" class="md-nav__link"> Rankllm rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/sbert_rerank/" class="md-nav__link"> Sbert rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/sentence_optimizer/" class="md-nav__link"> Sentence optimizer </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/siliconflow_rerank/" class="md-nav__link"> Siliconflow rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/similarity/" class="md-nav__link"> Similarity </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/tei_rerank/" class="md-nav__link"> Tei rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/time_weighted/" class="md-nav__link"> Time weighted </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/voyageai_rerank/" class="md-nav__link"> Voyageai rerank </a> </li> <li class="md-nav__item"> <a href="../../postprocessor/xinference_rerank/" class="md-nav__link"> Xinference rerank </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_20" > <div class="md-nav__link md-nav__container"> <a href="../../objects/" class="md-nav__link "> Object Stores </a> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_20_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_20"> Object Stores </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_21" > <div class="md-nav__link md-nav__container"> <a href="../../output_parsers/" class="md-nav__link "> Output Parsers </a> <label class="md-nav__link " for="__nav_7_21" id="__nav_7_21_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_21_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_21"> Output Parsers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../output_parsers/guardrails/" class="md-nav__link"> Guardrails </a> </li> <li class="md-nav__item"> <a href="../../output_parsers/langchain/" class="md-nav__link"> Langchain </a> </li> <li class="md-nav__item"> <a href="../../output_parsers/pydantic/" class="md-nav__link"> Pydantic </a> </li> <li class="md-nav__item"> <a href="../../output_parsers/selection/" class="md-nav__link"> Selection </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_22" > <div class="md-nav__link md-nav__container"> <a href="../../program/" class="md-nav__link "> Programs </a> <label class="md-nav__link " for="__nav_7_22" id="__nav_7_22_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_22_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_22"> Programs </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../program/evaporate/" class="md-nav__link"> Evaporate </a> </li> <li class="md-nav__item"> <a href="../../program/guidance/" class="md-nav__link"> Guidance </a> </li> <li class="md-nav__item"> <a href="../../program/llm_text_completion/" class="md-nav__link"> Llm text completion </a> </li> <li class="md-nav__item"> <a href="../../program/lmformatenforcer/" class="md-nav__link"> Lmformatenforcer </a> </li> <li class="md-nav__item"> <a href="../../program/multi_modal/" class="md-nav__link"> Multi modal </a> </li> <li class="md-nav__item"> <a href="../../program/openai/" class="md-nav__link"> Openai </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_23" > <div class="md-nav__link md-nav__container"> <a href="../../prompts/" class="md-nav__link "> Prompts </a> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_23_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_23"> Prompts </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_24" > <div class="md-nav__link md-nav__container"> <a href="../../query_engine/" class="md-nav__link "> Query Engines </a> <label class="md-nav__link " for="__nav_7_24" id="__nav_7_24_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_24_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_24"> Query Engines </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../query_engine/FLARE/" class="md-nav__link"> FLARE </a> </li> <li class="md-nav__item"> <a href="../../query_engine/JSONalayze/" class="md-nav__link"> JSONalayze </a> </li> <li class="md-nav__item"> <a href="../../query_engine/NL_SQL_table/" class="md-nav__link"> NL SQL table </a> </li> <li class="md-nav__item"> <a href="../../query_engine/PGVector_SQL/" class="md-nav__link"> PGVector SQL </a> </li> <li class="md-nav__item"> <a href="../../query_engine/SQL_join/" class="md-nav__link"> SQL join </a> </li> <li class="md-nav__item"> <a href="../../query_engine/SQL_table_retriever/" class="md-nav__link"> SQL table retriever </a> </li> <li class="md-nav__item"> <a href="../../query_engine/citation/" class="md-nav__link"> Citation </a> </li> <li class="md-nav__item"> <a href="../../query_engine/cogniswitch/" class="md-nav__link"> Cogniswitch </a> </li> <li class="md-nav__item"> <a href="../../query_engine/custom/" class="md-nav__link"> Custom </a> </li> <li class="md-nav__item"> <a href="../../query_engine/knowledge_graph/" class="md-nav__link"> Knowledge graph </a> </li> <li class="md-nav__item"> <a href="../../query_engine/multi_step/" class="md-nav__link"> Multi step </a> </li> <li class="md-nav__item"> <a href="../../query_engine/pandas/" class="md-nav__link"> Pandas </a> </li> <li class="md-nav__item"> <a href="../../query_engine/retriever/" class="md-nav__link"> Retriever </a> </li> <li class="md-nav__item"> <a href="../../query_engine/retriever_router/" class="md-nav__link"> Retriever router </a> </li> <li class="md-nav__item"> <a href="../../query_engine/retry/" class="md-nav__link"> Retry </a> </li> <li class="md-nav__item"> <a href="../../query_engine/router/" class="md-nav__link"> Router </a> </li> <li class="md-nav__item"> <a href="../../query_engine/simple_multi_modal/" class="md-nav__link"> Simple multi modal </a> </li> <li class="md-nav__item"> <a href="../../query_engine/sub_question/" class="md-nav__link"> Sub question </a> </li> <li class="md-nav__item"> <a href="../../query_engine/tool_retriever_router/" class="md-nav__link"> Tool retriever router </a> </li> <li class="md-nav__item"> <a href="../../query_engine/transform/" class="md-nav__link"> Transform </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_25" > <div class="md-nav__link md-nav__container"> <a href="../../query_pipeline/" class="md-nav__link "> Query Pipeline </a> <label class="md-nav__link " for="__nav_7_25" id="__nav_7_25_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_25_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_25"> Query Pipeline </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../query_pipeline/agent/" class="md-nav__link"> Agent </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/arg_pack/" class="md-nav__link"> Arg pack </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/custom/" class="md-nav__link"> Custom </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/function/" class="md-nav__link"> Function </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/input/" class="md-nav__link"> Input </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/llm/" class="md-nav__link"> Llm </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/multi_modal/" class="md-nav__link"> Multi modal </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/object/" class="md-nav__link"> Object </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/output_parser/" class="md-nav__link"> Output parser </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/postprocessor/" class="md-nav__link"> Postprocessor </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/prompt/" class="md-nav__link"> Prompt </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/query_engine/" class="md-nav__link"> Query engine </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/query_transform/" class="md-nav__link"> Query transform </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/retriever/" class="md-nav__link"> Retriever </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/router/" class="md-nav__link"> Router </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/synthesizer/" class="md-nav__link"> Synthesizer </a> </li> <li class="md-nav__item"> <a href="../../query_pipeline/tool_runner/" class="md-nav__link"> Tool runner </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_26" > <div class="md-nav__link md-nav__container"> <a href="../../question_gen/" class="md-nav__link "> Question Generators </a> <label class="md-nav__link " for="__nav_7_26" id="__nav_7_26_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_26_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_26"> Question Generators </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../question_gen/guidance/" class="md-nav__link"> Guidance </a> </li> <li class="md-nav__item"> <a href="../../question_gen/llm_question_gen/" class="md-nav__link"> Llm question gen </a> </li> <li class="md-nav__item"> <a href="../../question_gen/openai/" class="md-nav__link"> Openai </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_27" checked> <div class="md-nav__link md-nav__container"> <a href="../" class="md-nav__link "> Readers </a> <label class="md-nav__link " for="__nav_7_27" id="__nav_7_27_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_27_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_7_27"> Readers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../agent_search/" class="md-nav__link"> Agent search </a> </li> <li class="md-nav__item"> <a href="../airbyte_cdk/" class="md-nav__link"> Airbyte cdk </a> </li> <li class="md-nav__item"> <a href="../airbyte_gong/" class="md-nav__link"> Airbyte gong </a> </li> <li class="md-nav__item"> <a href="../airbyte_hubspot/" class="md-nav__link"> Airbyte hubspot </a> </li> <li class="md-nav__item"> <a href="../airbyte_salesforce/" class="md-nav__link"> Airbyte salesforce </a> </li> <li class="md-nav__item"> <a href="../airbyte_shopify/" class="md-nav__link"> Airbyte shopify </a> </li> <li class="md-nav__item"> <a href="../airbyte_stripe/" class="md-nav__link"> Airbyte stripe </a> </li> <li class="md-nav__item"> <a href="../airbyte_typeform/" class="md-nav__link"> Airbyte typeform </a> </li> <li class="md-nav__item"> <a href="../airbyte_zendesk_support/" class="md-nav__link"> Airbyte zendesk support </a> </li> <li class="md-nav__item"> <a href="../airtable/" class="md-nav__link"> Airtable </a> </li> <li class="md-nav__item"> <a href="../alibabacloud_aisearch/" class="md-nav__link"> Alibabacloud aisearch </a> </li> <li class="md-nav__item"> <a href="../apify/" class="md-nav__link"> Apify </a> </li> <li class="md-nav__item"> <a href="../arango_db/" class="md-nav__link"> Arango db </a> </li> <li class="md-nav__item"> <a href="../arxiv/" class="md-nav__link"> Arxiv </a> </li> <li class="md-nav__item"> <a href="../asana/" class="md-nav__link"> Asana </a> </li> <li class="md-nav__item"> <a href="../assemblyai/" class="md-nav__link"> Assemblyai </a> </li> <li class="md-nav__item"> <a href="../astra_db/" class="md-nav__link"> Astra db </a> </li> <li class="md-nav__item"> <a href="../athena/" class="md-nav__link"> Athena </a> </li> <li class="md-nav__item"> <a href="../awadb/" class="md-nav__link"> Awadb </a> </li> <li class="md-nav__item"> <a href="../azcognitive_search/" class="md-nav__link"> Azcognitive search </a> </li> <li class="md-nav__item"> <a href="../azstorage_blob/" class="md-nav__link"> Azstorage blob </a> </li> <li class="md-nav__item"> <a href="../bagel/" class="md-nav__link"> Bagel </a> </li> <li class="md-nav__item"> <a href="../bilibili/" class="md-nav__link"> Bilibili </a> </li> <li class="md-nav__item"> <a href="../bitbucket/" class="md-nav__link"> Bitbucket </a> </li> <li class="md-nav__item"> <a href="../boarddocs/" class="md-nav__link"> Boarddocs </a> </li> <li class="md-nav__item"> <a href="../box/" class="md-nav__link"> Box </a> </li> <li class="md-nav__item"> <a href="../chatgpt_plugin/" class="md-nav__link"> Chatgpt plugin </a> </li> <li class="md-nav__item"> <a href="../chroma/" class="md-nav__link"> Chroma </a> </li> <li class="md-nav__item"> <a href="../clickhouse.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> Confluence </label> <a href="./" class="md-nav__link md-nav__link--active"> Confluence </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#llama_index.readers.confluence.ConfluenceReader" class="md-nav__link"> ConfluenceReader </a> <nav class="md-nav" aria-label="ConfluenceReader"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#llama_index.readers.confluence.ConfluenceReader.load_data" class="md-nav__link"> load_data </a> </li> <li class="md-nav__item"> <a href="#llama_index.readers.confluence.ConfluenceReader.get_next_cursor" class="md-nav__link"> get_next_cursor </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../couchbase/" class="md-nav__link"> Couchbase </a> </li> <li class="md-nav__item"> <a href="../couchdb/" class="md-nav__link"> Couchdb </a> </li> <li class="md-nav__item"> <a href="../dad_jokes/" class="md-nav__link"> Dad jokes </a> </li> <li class="md-nav__item"> <a href="../dashscope/" class="md-nav__link"> Dashscope </a> </li> <li class="md-nav__item"> <a href="../dashvector/" class="md-nav__link"> Dashvector </a> </li> <li class="md-nav__item"> <a href="../database/" class="md-nav__link"> Database </a> </li> <li class="md-nav__item"> <a href="../deeplake/" class="md-nav__link"> Deeplake </a> </li> <li class="md-nav__item"> <a href="../discord/" class="md-nav__link"> Discord </a> </li> <li class="md-nav__item"> <a href="../docling/" class="md-nav__link"> Docling </a> </li> <li class="md-nav__item"> <a href="../docstring_walker/" class="md-nav__link"> Docstring walker </a> </li> <li class="md-nav__item"> <a href="../docugami/" class="md-nav__link"> Docugami </a> </li> <li class="md-nav__item"> <a href="../document360/" class="md-nav__link"> Document360 </a> </li> <li class="md-nav__item"> <a href="../earnings_call_transcript/" class="md-nav__link"> Earnings call transcript </a> </li> <li class="md-nav__item"> <a href="../elasticsearch/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../faiss/" class="md-nav__link"> Faiss </a> </li> <li class="md-nav__item"> <a href="../feedly_rss/" class="md-nav__link"> Feedly rss </a> </li> <li class="md-nav__item"> <a href="../feishu_docs/" class="md-nav__link"> Feishu docs </a> </li> <li class="md-nav__item"> <a href="../file/" class="md-nav__link"> File </a> </li> <li class="md-nav__item"> <a href="../firebase_realtimedb/" class="md-nav__link"> Firebase realtimedb </a> </li> <li class="md-nav__item"> <a href="../firestore/" class="md-nav__link"> Firestore </a> </li> <li class="md-nav__item"> <a href="../gcs/" class="md-nav__link"> Gcs </a> </li> <li class="md-nav__item"> <a href="../genius/" class="md-nav__link"> Genius </a> </li> <li class="md-nav__item"> <a href="../gitbook/" class="md-nav__link"> Gitbook </a> </li> <li class="md-nav__item"> <a href="../github/" class="md-nav__link"> Github </a> </li> <li class="md-nav__item"> <a href="../gitlab/" class="md-nav__link"> Gitlab </a> </li> <li class="md-nav__item"> <a href="../google/" class="md-nav__link"> Google </a> </li> <li class="md-nav__item"> <a href="../gpt_repo/" class="md-nav__link"> Gpt repo </a> </li> <li class="md-nav__item"> <a href="../graphdb_cypher/" class="md-nav__link"> Graphdb cypher </a> </li> <li class="md-nav__item"> <a href="../graphql/" class="md-nav__link"> Graphql </a> </li> <li class="md-nav__item"> <a href="../guru/" class="md-nav__link"> Guru </a> </li> <li class="md-nav__item"> <a href="../hatena_blog/" class="md-nav__link"> Hatena blog </a> </li> <li class="md-nav__item"> <a href="../hive/" class="md-nav__link"> Hive </a> </li> <li class="md-nav__item"> <a href="../hubspot/" class="md-nav__link"> Hubspot </a> </li> <li class="md-nav__item"> <a href="../huggingface_fs/" class="md-nav__link"> Huggingface fs </a> </li> <li class="md-nav__item"> <a href="../hwp/" class="md-nav__link"> Hwp </a> </li> <li class="md-nav__item"> <a href="../iceberg/" class="md-nav__link"> Iceberg </a> </li> <li class="md-nav__item"> <a href="../imdb_review/" class="md-nav__link"> Imdb review </a> </li> <li class="md-nav__item"> <a href="../intercom/" class="md-nav__link"> Intercom </a> </li> <li class="md-nav__item"> <a href="../jaguar/" class="md-nav__link"> Jaguar </a> </li> <li class="md-nav__item"> <a href="../jira/" class="md-nav__link"> Jira </a> </li> <li class="md-nav__item"> <a href="../joplin/" class="md-nav__link"> Joplin </a> </li> <li class="md-nav__item"> <a href="../json/" class="md-nav__link"> Json </a> </li> <li class="md-nav__item"> <a href="../kaltura_esearch/" class="md-nav__link"> Kaltura esearch </a> </li> <li class="md-nav__item"> <a href="../kibela/" class="md-nav__link"> Kibela </a> </li> <li class="md-nav__item"> <a href="../lilac/" class="md-nav__link"> Lilac </a> </li> <li class="md-nav__item"> <a href="../linear/" class="md-nav__link"> Linear </a> </li> <li class="md-nav__item"> <a href="../llama_parse/" class="md-nav__link"> Llama parse </a> </li> <li class="md-nav__item"> <a href="../macrometa_gdn/" class="md-nav__link"> Macrometa gdn </a> </li> <li class="md-nav__item"> <a href="../make_com/" class="md-nav__link"> Make com </a> </li> <li class="md-nav__item"> <a href="../mangadex/" class="md-nav__link"> Mangadex </a> </li> <li class="md-nav__item"> <a href="../mangoapps_guides/" class="md-nav__link"> Mangoapps guides </a> </li> <li class="md-nav__item"> <a href="../maps/" class="md-nav__link"> Maps </a> </li> <li class="md-nav__item"> <a href="../mbox/" class="md-nav__link"> Mbox </a> </li> <li class="md-nav__item"> <a href="../memos/" class="md-nav__link"> Memos </a> </li> <li class="md-nav__item"> <a href="../metal/" class="md-nav__link"> Metal </a> </li> <li class="md-nav__item"> <a href="../microsoft_onedrive/" class="md-nav__link"> Microsoft onedrive </a> </li> <li class="md-nav__item"> <a href="../microsoft_outlook/" class="md-nav__link"> Microsoft outlook </a> </li> <li class="md-nav__item"> <a href="../microsoft_sharepoint/" class="md-nav__link"> Microsoft sharepoint </a> </li> <li class="md-nav__item"> <a href="../milvus/" class="md-nav__link"> Milvus </a> </li> <li class="md-nav__item"> <a href="../minio/" class="md-nav__link"> Minio </a> </li> <li class="md-nav__item"> <a href="../mondaydotcom/" class="md-nav__link"> Mondaydotcom </a> </li> <li class="md-nav__item"> <a href="../mongodb/" class="md-nav__link"> Mongodb </a> </li> <li class="md-nav__item"> <a href="../myscale/" class="md-nav__link"> Myscale </a> </li> <li class="md-nav__item"> <a href="../notion/" class="md-nav__link"> Notion </a> </li> <li class="md-nav__item"> <a href="../nougat_ocr/" class="md-nav__link"> Nougat ocr </a> </li> <li class="md-nav__item"> <a href="../obsidian/" class="md-nav__link"> Obsidian </a> </li> <li class="md-nav__item"> <a href="../openalex/" class="md-nav__link"> Openalex </a> </li> <li class="md-nav__item"> <a href="../openapi.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../opendal/" class="md-nav__link"> Opendal </a> </li> <li class="md-nav__item"> <a href="../opensearch/" class="md-nav__link"> Opensearch </a> </li> <li class="md-nav__item"> <a href="../oracleai/" class="md-nav__link"> Oracleai </a> </li> <li class="md-nav__item"> <a href="../pandas_ai/" class="md-nav__link"> Pandas ai </a> </li> <li class="md-nav__item"> <a href="../papers/" class="md-nav__link"> Papers </a> </li> <li class="md-nav__item"> <a href="../patentsview/" class="md-nav__link"> Patentsview </a> </li> <li class="md-nav__item"> <a href="../pathway/" class="md-nav__link"> Pathway </a> </li> <li class="md-nav__item"> <a href="../pdb/" class="md-nav__link"> Pdb </a> </li> <li class="md-nav__item"> <a href="../pdf_marker/" class="md-nav__link"> Pdf marker </a> </li> <li class="md-nav__item"> <a href="../pdf_table/" class="md-nav__link"> Pdf table </a> </li> <li class="md-nav__item"> <a href="../pebblo/" class="md-nav__link"> Pebblo </a> </li> <li class="md-nav__item"> <a href="../pinecone.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../preprocess/" class="md-nav__link"> Preprocess </a> </li> <li class="md-nav__item"> <a href="../psychic/" class="md-nav__link"> Psychic </a> </li> <li class="md-nav__item"> <a href="../qdrant/" class="md-nav__link"> Qdrant </a> </li> <li class="md-nav__item"> <a href="../quip/" class="md-nav__link"> Quip </a> </li> <li class="md-nav__item"> <a href="../rayyan/" class="md-nav__link"> Rayyan </a> </li> <li class="md-nav__item"> <a href="../readme.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../readwise/" class="md-nav__link"> Readwise </a> </li> <li class="md-nav__item"> <a href="../reddit/" class="md-nav__link"> Reddit </a> </li> <li class="md-nav__item"> <a href="../remote/" class="md-nav__link"> Remote </a> </li> <li class="md-nav__item"> <a href="../remote_depth/" class="md-nav__link"> Remote depth </a> </li> <li class="md-nav__item"> <a href="../s3/" class="md-nav__link"> S3 </a> </li> <li class="md-nav__item"> <a href="../sec_filings/" class="md-nav__link"> Sec filings </a> </li> <li class="md-nav__item"> <a href="../semanticscholar/" class="md-nav__link"> Semanticscholar </a> </li> <li class="md-nav__item"> <a href="../simple_directory_reader/" class="md-nav__link"> Simple directory reader </a> </li> <li class="md-nav__item"> <a href="../singlestore/" class="md-nav__link"> Singlestore </a> </li> <li class="md-nav__item"> <a href="../slack/" class="md-nav__link"> Slack </a> </li> <li class="md-nav__item"> <a href="../smart_pdf_loader/" class="md-nav__link"> Smart pdf loader </a> </li> <li class="md-nav__item"> <a href="../snowflake/" class="md-nav__link"> Snowflake </a> </li> <li class="md-nav__item"> <a href="../spotify/" class="md-nav__link"> Spotify </a> </li> <li class="md-nav__item"> <a href="../stackoverflow/" class="md-nav__link"> Stackoverflow </a> </li> <li class="md-nav__item"> <a href="../steamship/" class="md-nav__link"> Steamship </a> </li> <li class="md-nav__item"> <a href="../string_iterable/" class="md-nav__link"> String iterable </a> </li> <li class="md-nav__item"> <a href="../stripe_docs/" class="md-nav__link"> Stripe docs </a> </li> <li class="md-nav__item"> <a href="../structured_data/" class="md-nav__link"> Structured data </a> </li> <li class="md-nav__item"> <a href="../telegram/" class="md-nav__link"> Telegram </a> </li> <li class="md-nav__item"> <a href="../toggl/" class="md-nav__link"> Toggl </a> </li> <li class="md-nav__item"> <a href="../trello/" class="md-nav__link"> Trello </a> </li> <li class="md-nav__item"> <a href="../twitter/" class="md-nav__link"> Twitter </a> </li> <li class="md-nav__item"> <a href="../txtai/" class="md-nav__link"> Txtai </a> </li> <li class="md-nav__item"> <a href="../upstage/" class="md-nav__link"> Upstage </a> </li> <li class="md-nav__item"> <a href="../weather/" class="md-nav__link"> Weather </a> </li> <li class="md-nav__item"> <a href="../weaviate/" class="md-nav__link"> Weaviate </a> </li> <li class="md-nav__item"> <a href="../web/" class="md-nav__link"> Web </a> </li> <li class="md-nav__item"> <a href="../whatsapp/" class="md-nav__link"> Whatsapp </a> </li> <li class="md-nav__item"> <a href="../whisper/" class="md-nav__link"> Whisper </a> </li> <li class="md-nav__item"> <a href="../wikipedia/" class="md-nav__link"> Wikipedia </a> </li> <li class="md-nav__item"> <a href="../wordlift/" class="md-nav__link"> Wordlift </a> </li> <li class="md-nav__item"> <a href="../wordpress/" class="md-nav__link"> Wordpress </a> </li> <li class="md-nav__item"> <a href="../youtube_transcript/" class="md-nav__link"> Youtube transcript </a> </li> <li class="md-nav__item"> <a href="../zendesk/" class="md-nav__link"> Zendesk </a> </li> <li class="md-nav__item"> <a href="../zep/" class="md-nav__link"> Zep </a> </li> <li class="md-nav__item"> <a href="../zulip/" class="md-nav__link"> Zulip </a> </li> <li class="md-nav__item"> <a href="../zyte_serp/" class="md-nav__link"> Zyte serp </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_28" > <div class="md-nav__link md-nav__container"> <a href="../../response_synthesizers/" class="md-nav__link "> Response Synthesizers </a> <label class="md-nav__link " for="__nav_7_28" id="__nav_7_28_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_28_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_28"> Response Synthesizers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../response_synthesizers/accumulate/" class="md-nav__link"> Accumulate </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/compact_accumulate/" class="md-nav__link"> Compact accumulate </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/compact_and_refine/" class="md-nav__link"> Compact and refine </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/generation/" class="md-nav__link"> Generation </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/google/" class="md-nav__link"> Google </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/refine/" class="md-nav__link"> Refine </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/simple_summarize/" class="md-nav__link"> Simple summarize </a> </li> <li class="md-nav__item"> <a href="../../response_synthesizers/tree_summarize/" class="md-nav__link"> Tree summarize </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_29" > <div class="md-nav__link md-nav__container"> <a href="../../retrievers/" class="md-nav__link "> Retrievers </a> <label class="md-nav__link " for="__nav_7_29" id="__nav_7_29_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_29_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_29"> Retrievers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../retrievers/auto_merging/" class="md-nav__link"> Auto merging </a> </li> <li class="md-nav__item"> <a href="../../retrievers/bedrock/" class="md-nav__link"> Bedrock </a> </li> <li class="md-nav__item"> <a href="../../retrievers/bm25/" class="md-nav__link"> Bm25 </a> </li> <li class="md-nav__item"> <a href="../../retrievers/duckdb_retriever/" class="md-nav__link"> Duckdb retriever </a> </li> <li class="md-nav__item"> <a href="../../retrievers/kendra/" class="md-nav__link"> Kendra </a> </li> <li class="md-nav__item"> <a href="../../retrievers/keyword/" class="md-nav__link"> Keyword </a> </li> <li class="md-nav__item"> <a href="../../retrievers/knowledge_graph/" class="md-nav__link"> Knowledge graph </a> </li> <li class="md-nav__item"> <a href="../../retrievers/mongodb_atlas_bm25_retriever/" class="md-nav__link"> Mongodb atlas bm25 retriever </a> </li> <li class="md-nav__item"> <a href="../../retrievers/pathway/" class="md-nav__link"> Pathway </a> </li> <li class="md-nav__item"> <a href="../../retrievers/query_fusion/" class="md-nav__link"> Query fusion </a> </li> <li class="md-nav__item"> <a href="../../retrievers/recursive/" class="md-nav__link"> Recursive </a> </li> <li class="md-nav__item"> <a href="../../retrievers/router/" class="md-nav__link"> Router </a> </li> <li class="md-nav__item"> <a href="../../retrievers/sql/" class="md-nav__link"> Sql </a> </li> <li class="md-nav__item"> <a href="../../retrievers/summary/" class="md-nav__link"> Summary </a> </li> <li class="md-nav__item"> <a href="../../retrievers/transform/" class="md-nav__link"> Transform </a> </li> <li class="md-nav__item"> <a href="../../retrievers/tree/" class="md-nav__link"> Tree </a> </li> <li class="md-nav__item"> <a href="../../retrievers/vector/" class="md-nav__link"> Vector </a> </li> <li class="md-nav__item"> <a href="../../retrievers/vertexai_search/" class="md-nav__link"> Vertexai search </a> </li> <li class="md-nav__item"> <a href="../../retrievers/videodb/" class="md-nav__link"> Videodb </a> </li> <li class="md-nav__item"> <a href="../../retrievers/you/" class="md-nav__link"> You </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_30" > <div class="md-nav__link md-nav__container"> <a href="../../schema/" class="md-nav__link "> Schema </a> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_30_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_30"> Schema </label> <ul class="md-nav__list" data-md-scrollfix> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_31" > <label class="md-nav__link" for="__nav_7_31" id="__nav_7_31_label" tabindex="0"> Selectors </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_31_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_31"> Selectors </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../selectors/notdiamond/" class="md-nav__link"> Notdiamond </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_32" > <label class="md-nav__link" for="__nav_7_32" id="__nav_7_32_label" tabindex="0"> Sparse Embeddings </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_32_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_32"> Sparse Embeddings </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../sparse_embeddings/fastembed/" class="md-nav__link"> Fastembed </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33" > <label class="md-nav__link" for="__nav_7_33" id="__nav_7_33_label" tabindex="0"> Storage </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_33_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33"> Storage </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_1" > <div class="md-nav__link md-nav__container"> <a href="../../storage/chat_store/" class="md-nav__link "> Chat Store </a> <label class="md-nav__link " for="__nav_7_33_1" id="__nav_7_33_1_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_1_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_1"> Chat Store </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/chat_store/azure/" class="md-nav__link"> Azure </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/azurecosmosmongovcore/" class="md-nav__link"> Azurecosmosmongovcore </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/azurecosmosnosql/" class="md-nav__link"> Azurecosmosnosql </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/dynamodb/" class="md-nav__link"> Dynamodb </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/postgres/" class="md-nav__link"> Postgres </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/redis/" class="md-nav__link"> Redis </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/simple/" class="md-nav__link"> Simple </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/tablestore/" class="md-nav__link"> Tablestore </a> </li> <li class="md-nav__item"> <a href="../../storage/chat_store/upstash/" class="md-nav__link"> Upstash </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_2" > <div class="md-nav__link md-nav__container"> <a href="../../storage/docstore/" class="md-nav__link "> Docstore </a> <label class="md-nav__link " for="__nav_7_33_2" id="__nav_7_33_2_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_2"> Docstore </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/docstore/azure/" class="md-nav__link"> Azure </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/azurecosmosnosql/" class="md-nav__link"> Azurecosmosnosql </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/couchbase/" class="md-nav__link"> Couchbase </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/dynamodb/" class="md-nav__link"> Dynamodb </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/elasticsearch/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/firestore/" class="md-nav__link"> Firestore </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/mongodb/" class="md-nav__link"> Mongodb </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/postgres/" class="md-nav__link"> Postgres </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/redis/" class="md-nav__link"> Redis </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/simple/" class="md-nav__link"> Simple </a> </li> <li class="md-nav__item"> <a href="../../storage/docstore/tablestore/" class="md-nav__link"> Tablestore </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_3" > <div class="md-nav__link md-nav__container"> <a href="../../storage/graph_stores/" class="md-nav__link "> Graph Stores </a> <label class="md-nav__link " for="__nav_7_33_3" id="__nav_7_33_3_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_3"> Graph Stores </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/graph_stores/falkordb/" class="md-nav__link"> Falkordb </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/kuzu/" class="md-nav__link"> Kuzu </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/memgraph/" class="md-nav__link"> Memgraph </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/nebula/" class="md-nav__link"> Nebula </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/neo4j/" class="md-nav__link"> Neo4j </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/neptune/" class="md-nav__link"> Neptune </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/simple/" class="md-nav__link"> Simple </a> </li> <li class="md-nav__item"> <a href="../../storage/graph_stores/tidb/" class="md-nav__link"> Tidb </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_4" > <div class="md-nav__link md-nav__container"> <a href="../../storage/index_store/" class="md-nav__link "> Index Store </a> <label class="md-nav__link " for="__nav_7_33_4" id="__nav_7_33_4_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_4"> Index Store </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/index_store/azure/" class="md-nav__link"> Azure </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/azurecosmosnosql/" class="md-nav__link"> Azurecosmosnosql </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/couchbase/" class="md-nav__link"> Couchbase </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/dynamodb/" class="md-nav__link"> Dynamodb </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/elasticsearch/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/firestore/" class="md-nav__link"> Firestore </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/mongodb/" class="md-nav__link"> Mongodb </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/postgres/" class="md-nav__link"> Postgres </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/redis/" class="md-nav__link"> Redis </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/simple/" class="md-nav__link"> Simple </a> </li> <li class="md-nav__item"> <a href="../../storage/index_store/tablestore/" class="md-nav__link"> Tablestore </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_5" > <div class="md-nav__link md-nav__container"> <a href="../../storage/kvstore/" class="md-nav__link "> Kvstore </a> <label class="md-nav__link " for="__nav_7_33_5" id="__nav_7_33_5_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_5"> Kvstore </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/kvstore/azure/" class="md-nav__link"> Azure </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/azurecosmosnosql/" class="md-nav__link"> Azurecosmosnosql </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/couchbase/" class="md-nav__link"> Couchbase </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/dynamodb/" class="md-nav__link"> Dynamodb </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/elasticsearch/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/firestore/" class="md-nav__link"> Firestore </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/mongodb/" class="md-nav__link"> Mongodb </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/postgres/" class="md-nav__link"> Postgres </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/redis/" class="md-nav__link"> Redis </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/s3/" class="md-nav__link"> S3 </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/simple/" class="md-nav__link"> Simple </a> </li> <li class="md-nav__item"> <a href="../../storage/kvstore/tablestore/" class="md-nav__link"> Tablestore </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_6" > <label class="md-nav__link" for="__nav_7_33_6" id="__nav_7_33_6_label" tabindex="0"> Storage </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_6"> Storage </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/storage_context/" class="md-nav__link"> Storage context </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_33_7" > <div class="md-nav__link md-nav__container"> <a href="../../storage/vector_store/" class="md-nav__link "> Vector Store </a> <label class="md-nav__link " for="__nav_7_33_7" id="__nav_7_33_7_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_7_33_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_33_7"> Vector Store </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../storage/vector_store/alibabacloud_opensearch/" class="md-nav__link"> Alibabacloud opensearch </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/analyticdb/" class="md-nav__link"> Analyticdb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/astra_db/" class="md-nav__link"> Astra db </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/awadb/" class="md-nav__link"> Awadb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/awsdocdb/" class="md-nav__link"> Awsdocdb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/azureaisearch/" class="md-nav__link"> Azureaisearch </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/azurecosmosmongo/" class="md-nav__link"> Azurecosmosmongo </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/azurecosmosnosql/" class="md-nav__link"> Azurecosmosnosql </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/bagel/" class="md-nav__link"> Bagel </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/baiduvectordb/" class="md-nav__link"> Baiduvectordb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/cassandra/" class="md-nav__link"> Cassandra </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/chatgpt_plugin.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/chroma/" class="md-nav__link"> Chroma </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/clickhouse/" class="md-nav__link"> Clickhouse </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/couchbase/" class="md-nav__link"> Couchbase </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/dashvector/" class="md-nav__link"> Dashvector </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/databricks/" class="md-nav__link"> Databricks </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/deeplake/" class="md-nav__link"> Deeplake </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/docarray/" class="md-nav__link"> Docarray </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/duckdb/" class="md-nav__link"> Duckdb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/dynamodb/" class="md-nav__link"> Dynamodb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/elasticsearch/" class="md-nav__link"> Elasticsearch </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/epsilla/" class="md-nav__link"> Epsilla </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/faiss/" class="md-nav__link"> Faiss </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/firestore/" class="md-nav__link"> Firestore </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/google/" class="md-nav__link"> Google </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/hologres/" class="md-nav__link"> Hologres </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/jaguar/" class="md-nav__link"> Jaguar </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/kdbai/" class="md-nav__link"> Kdbai </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/lancedb/" class="md-nav__link"> Lancedb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/lantern/" class="md-nav__link"> Lantern </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/lindorm/" class="md-nav__link"> Lindorm </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/mariadb/" class="md-nav__link"> Mariadb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/metal.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/milvus/" class="md-nav__link"> Milvus </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/mongodb/" class="md-nav__link"> Mongodb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/myscale/" class="md-nav__link"> Myscale </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/neo4jvector/" class="md-nav__link"> Neo4jvector </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/neptune/" class="md-nav__link"> Neptune </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/nile/" class="md-nav__link"> Nile </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/objectbox/" class="md-nav__link"> Objectbox </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/oceanbase/" class="md-nav__link"> Oceanbase </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/opensearch/" class="md-nav__link"> Opensearch </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/oracledb/" class="md-nav__link"> Oracledb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/pgvecto_rs/" class="md-nav__link"> Pgvecto rs </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/pinecone/" class="md-nav__link"> Pinecone </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/postgres/" class="md-nav__link"> Postgres </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/qdrant/" class="md-nav__link"> Qdrant </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/redis/" class="md-nav__link"> Redis </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/relyt/" class="md-nav__link"> Relyt </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/rocksetdb/" class="md-nav__link"> Rocksetdb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/simple/" class="md-nav__link"> Simple </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/singlestoredb/" class="md-nav__link"> Singlestoredb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/sqlalchemy.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/supabase/" class="md-nav__link"> Supabase </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/tablestore/" class="md-nav__link"> Tablestore </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/tair/" class="md-nav__link"> Tair </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/tencentvectordb/" class="md-nav__link"> Tencentvectordb </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/tidbvector/" class="md-nav__link"> Tidbvector </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/timescalevector/" class="md-nav__link"> Timescalevector </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/txtai/" class="md-nav__link"> Txtai </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/typesense/" class="md-nav__link"> Typesense </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/upstash/" class="md-nav__link"> Upstash </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/vearch/" class="md-nav__link"> Vearch </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/vertexaivectorsearch/" class="md-nav__link"> Vertexaivectorsearch </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/vespa/" class="md-nav__link"> Vespa </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/weaviate/" class="md-nav__link"> Weaviate </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/wordlift/" class="md-nav__link"> Wordlift </a> </li> <li class="md-nav__item"> <a href="../../storage/vector_store/zep/" class="md-nav__link"> Zep </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_34" > <div class="md-nav__link md-nav__container"> <a href="../../tools/" class="md-nav__link "> Tools </a> <label class="md-nav__link " for="__nav_7_34" id="__nav_7_34_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_34_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_34"> Tools </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../tools/arxiv/" class="md-nav__link"> Arxiv </a> </li> <li class="md-nav__item"> <a href="../../tools/azure_code_interpreter/" class="md-nav__link"> Azure code interpreter </a> </li> <li class="md-nav__item"> <a href="../../tools/azure_cv/" class="md-nav__link"> Azure cv </a> </li> <li class="md-nav__item"> <a href="../../tools/azure_speech/" class="md-nav__link"> Azure speech </a> </li> <li class="md-nav__item"> <a href="../../tools/azure_translate/" class="md-nav__link"> Azure translate </a> </li> <li class="md-nav__item"> <a href="../../tools/bing_search/" class="md-nav__link"> Bing search </a> </li> <li class="md-nav__item"> <a href="../../tools/box/" class="md-nav__link"> Box </a> </li> <li class="md-nav__item"> <a href="../../tools/brave_search/" class="md-nav__link"> Brave search </a> </li> <li class="md-nav__item"> <a href="../../tools/cassandra/" class="md-nav__link"> Cassandra </a> </li> <li class="md-nav__item"> <a href="../../tools/chatgpt_plugin/" class="md-nav__link"> Chatgpt plugin </a> </li> <li class="md-nav__item"> <a href="../../tools/code_interpreter/" class="md-nav__link"> Code interpreter </a> </li> <li class="md-nav__item"> <a href="../../tools/cogniswitch/" class="md-nav__link"> Cogniswitch </a> </li> <li class="md-nav__item"> <a href="../../tools/database/" class="md-nav__link"> Database </a> </li> <li class="md-nav__item"> <a href="../../tools/docker_code.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../tools/duckduckgo/" class="md-nav__link"> Duckduckgo </a> </li> <li class="md-nav__item"> <a href="../../tools/elevenlabs/" class="md-nav__link"> Elevenlabs </a> </li> <li class="md-nav__item"> <a href="../../tools/exa/" class="md-nav__link"> Exa </a> </li> <li class="md-nav__item"> <a href="../../tools/finance/" class="md-nav__link"> Finance </a> </li> <li class="md-nav__item"> <a href="../../tools/function/" class="md-nav__link"> Function </a> </li> <li class="md-nav__item"> <a href="../../tools/google/" class="md-nav__link"> Google </a> </li> <li class="md-nav__item"> <a href="../../tools/graphql/" class="md-nav__link"> Graphql </a> </li> <li class="md-nav__item"> <a href="../../tools/ionic_shopping/" class="md-nav__link"> Ionic shopping </a> </li> <li class="md-nav__item"> <a href="../../tools/jina/" class="md-nav__link"> Jina </a> </li> <li class="md-nav__item"> <a href="../../tools/jira/" class="md-nav__link"> Jira </a> </li> <li class="md-nav__item"> <a href="../../tools/linkup_research/" class="md-nav__link"> Linkup research </a> </li> <li class="md-nav__item"> <a href="../../tools/load_and_search/" class="md-nav__link"> Load and search </a> </li> <li class="md-nav__item"> <a href="../../tools/metaphor/" class="md-nav__link"> Metaphor </a> </li> <li class="md-nav__item"> <a href="../../tools/multion/" class="md-nav__link"> Multion </a> </li> <li class="md-nav__item"> <a href="../../tools/neo4j/" class="md-nav__link"> Neo4j </a> </li> <li class="md-nav__item"> <a href="../../tools/notion/" class="md-nav__link"> Notion </a> </li> <li class="md-nav__item"> <a href="../../tools/ondemand_loader/" class="md-nav__link"> Ondemand loader </a> </li> <li class="md-nav__item"> <a href="../../tools/openai/" class="md-nav__link"> Openai </a> </li> <li class="md-nav__item"> <a href="../../tools/openapi/" class="md-nav__link"> Openapi </a> </li> <li class="md-nav__item"> <a href="../../tools/oracleai.md" class="md-nav__link"> None </a> </li> <li class="md-nav__item"> <a href="../../tools/playgrounds/" class="md-nav__link"> Playgrounds </a> </li> <li class="md-nav__item"> <a href="../../tools/playwright/" class="md-nav__link"> Playwright </a> </li> <li class="md-nav__item"> <a href="../../tools/python_file/" class="md-nav__link"> Python file </a> </li> <li class="md-nav__item"> <a href="../../tools/query_engine/" class="md-nav__link"> Query engine </a> </li> <li class="md-nav__item"> <a href="../../tools/query_plan/" class="md-nav__link"> Query plan </a> </li> <li class="md-nav__item"> <a href="../../tools/requests/" class="md-nav__link"> Requests </a> </li> <li class="md-nav__item"> <a href="../../tools/retriever/" class="md-nav__link"> Retriever </a> </li> <li class="md-nav__item"> <a href="../../tools/salesforce/" class="md-nav__link"> Salesforce </a> </li> <li class="md-nav__item"> <a href="../../tools/scrapegraph/" class="md-nav__link"> Scrapegraph </a> </li> <li class="md-nav__item"> <a href="../../tools/shopify/" class="md-nav__link"> Shopify </a> </li> <li class="md-nav__item"> <a href="../../tools/slack/" class="md-nav__link"> Slack </a> </li> <li class="md-nav__item"> <a href="../../tools/tavily_research/" class="md-nav__link"> Tavily research </a> </li> <li class="md-nav__item"> <a href="../../tools/text_to_image/" class="md-nav__link"> Text to image </a> </li> <li class="md-nav__item"> <a href="../../tools/tool_spec/" class="md-nav__link"> Tool spec </a> </li> <li class="md-nav__item"> <a href="../../tools/vectara_query/" class="md-nav__link"> Vectara query </a> </li> <li class="md-nav__item"> <a href="../../tools/vector_db/" class="md-nav__link"> Vector db </a> </li> <li class="md-nav__item"> <a href="../../tools/waii/" class="md-nav__link"> Waii </a> </li> <li class="md-nav__item"> <a href="../../tools/weather/" class="md-nav__link"> Weather </a> </li> <li class="md-nav__item"> <a href="../../tools/wikipedia/" class="md-nav__link"> Wikipedia </a> </li> <li class="md-nav__item"> <a href="../../tools/wolfram_alpha/" class="md-nav__link"> Wolfram alpha </a> </li> <li class="md-nav__item"> <a href="../../tools/yahoo_finance/" class="md-nav__link"> Yahoo finance </a> </li> <li class="md-nav__item"> <a href="../../tools/yelp/" class="md-nav__link"> Yelp </a> </li> <li class="md-nav__item"> <a href="../../tools/zapier/" class="md-nav__link"> Zapier </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_35" > <label class="md-nav__link" for="__nav_7_35" id="__nav_7_35_label" tabindex="0"> Workflow </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_35_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_35"> Workflow </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../workflow/decorators/" class="md-nav__link"> Decorators </a> </li> <li class="md-nav__item"> <a href="../../workflow/context/" class="md-nav__link"> Context </a> </li> <li class="md-nav__item"> <a href="../../workflow/events/" class="md-nav__link"> Events </a> </li> <li class="md-nav__item"> <a href="../../workflow/retry_policy/" class="md-nav__link"> Retry policy </a> </li> <li class="md-nav__item"> <a href="../../workflow/workflow/" class="md-nav__link"> Workflow </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" > <div class="md-nav__link md-nav__container"> <a href="../../../community/llama_packs/" class="md-nav__link "> Open-Source Community </a> <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8"> Open-Source Community </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../community/integrations/" class="md-nav__link"> Integrations </a> </li> <li class="md-nav__item"> <a href="../../../community/full_stack_projects/" class="md-nav__link"> Full Stack Projects </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_3" > <label class="md-nav__link" for="__nav_8_3" id="__nav_8_3_label" tabindex="0"> Community FAQ </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_3"> Community FAQ </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../community/faq/chat_engines/" class="md-nav__link"> Chat Engines </a> </li> <li class="md-nav__item"> <a href="../../../community/faq/documents_and_nodes/" class="md-nav__link"> Documents and Nodes </a> </li> <li class="md-nav__item"> <a href="../../../community/faq/embeddings/" class="md-nav__link"> Embeddings </a> </li> <li class="md-nav__item"> <a href="../../../community/faq/llms/" class="md-nav__link"> Large Language Models </a> </li> <li class="md-nav__item"> <a href="../../../community/faq/query_engines/" class="md-nav__link"> Query Engines </a> </li> <li class="md-nav__item"> <a href="../../../community/faq/vector_database/" class="md-nav__link"> Vector Database </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_5" > <label class="md-nav__link" for="__nav_8_5" id="__nav_8_5_label" tabindex="0"> Contributing </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_5"> Contributing </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../CONTRIBUTING/" class="md-nav__link"> Code </a> </li> <li class="md-nav__item"> <a href="../../../DOCS_README/" class="md-nav__link"> Docs </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../CHANGELOG/" class="md-nav__link"> Changelog </a> </li> <li class="md-nav__item"> <a href="../../../presentations/past_presentations/" class="md-nav__link"> Presentations </a> </li> <li class="md-nav__item"> <a href="../../../changes/deprecated_terms/" class="md-nav__link"> Deprecated Terms </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" > <div class="md-nav__link md-nav__container"> <a href="../../../llama_cloud/" class="md-nav__link "> LlamaCloud </a> <label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0"> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_9"> LlamaCloud </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../../llama_cloud/llama_parse/" class="md-nav__link"> LlamaParse </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#llama_index.readers.confluence.ConfluenceReader" class="md-nav__link"> ConfluenceReader </a> <nav class="md-nav" aria-label="ConfluenceReader"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#llama_index.readers.confluence.ConfluenceReader.load_data" class="md-nav__link"> load_data </a> </li> <li class="md-nav__item"> <a href="#llama_index.readers.confluence.ConfluenceReader.get_next_cursor" class="md-nav__link"> get_next_cursor </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1>Confluence</h1> <div class="doc doc-object doc-module"> <div class="doc doc-contents first"> <div class="doc doc-children"> <div class="doc doc-object doc-class"> <h2 id="llama_index.readers.confluence.ConfluenceReader" class="doc doc-heading"> ConfluenceReader <a href="#llama_index.readers.confluence.ConfluenceReader" class="headerlink" title="Permanent link">#</a></h2> <div class="doc doc-contents "> Bases: <code><a class="autorefs autorefs-internal" title="llama_index.core.readers.base.BaseReader" href="../#llama_index.core.readers.base.BaseReader">BaseReader</a></code> Confluence reader. Reads a set of confluence pages given a space key and optionally a list of page ids For more on OAuth login, checkout: - https://atlassian-python-api.readthedocs.io/index.html - https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/ Parameters: <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class="doc-section-item"> <td> <code>oauth2</code> </td> <td> <code>dict</code> </td> <td> <div class="doc-md-description"> Atlassian OAuth 2.0, minimum fields are <code>client_id</code> and <code>token</code>, where <code>token</code> is a dict and must at least contain "access_token" and "token_type". </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>base_url</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> 'base_url' for confluence cloud instance, this is suffixed with '/wiki', eg 'https://yoursite.atlassian.com/wiki' </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>cloud</code> </td> <td> <code>bool</code> </td> <td> <div class="doc-md-description"> connecting to Confluence Cloud or self-hosted instance </div> </td> <td> <code>True</code> </td> </tr> <tr class="doc-section-item"> <td> <code>api_token</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Confluence API token, see https://confluence.atlassian.com/cloud/api-tokens-938839638.html </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>cookies</code> </td> <td> <code>dict</code> </td> <td> <div class="doc-md-description"> Confluence cookies, see https://atlassian-python-api.readthedocs.io/index.html </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>user_name</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Confluence username, used for basic auth. Must be used with <code>password</code>. </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>password</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Confluence password, used for basic auth. Must be used with <code>user_name</code>. </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>client_args</code> </td> <td> <code>dict</code> </td> <td> <div class="doc-md-description"> Additional keyword arguments to pass directly to the Atlassian Confluence client constructor, for example <code>{'backoff_and_retry': True}</code>. </div> </td> <td> <code>None</code> </td> </tr> </tbody> </table> <details class="quote"> <summary>Source code in <code>llama-index-integrations/readers/llama-index-readers-confluence/llama_index/readers/confluence/base.py</code></summary> <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831</pre></div></td><td class="code"><div><pre><code>class ConfluenceReader(BaseReader): """Confluence reader. Reads a set of confluence pages given a space key and optionally a list of page ids For more on OAuth login, checkout: - https://atlassian-python-api.readthedocs.io/index.html - https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/ Args: oauth2 (dict): Atlassian OAuth 2.0, minimum fields are `client_id` and `token`, where `token` is a dict and must at least contain "access_token" and "token_type". base_url (str): 'base_url' for confluence cloud instance, this is suffixed with '/wiki', eg 'https://yoursite.atlassian.com/wiki' cloud (bool): connecting to Confluence Cloud or self-hosted instance api_token (str): Confluence API token, see https://confluence.atlassian.com/cloud/api-tokens-938839638.html cookies (dict): Confluence cookies, see https://atlassian-python-api.readthedocs.io/index.html user_name (str): Confluence username, used for basic auth. Must be used with `password`. password (str): Confluence password, used for basic auth. Must be used with `user_name`. client_args (dict): Additional keyword arguments to pass directly to the Atlassian Confluence client constructor, for example `{'backoff_and_retry': True}`. """ def __init__( self, base_url: str = None, oauth2: Optional[Dict] = None, cloud: bool = True, api_token: Optional[str] = None, cookies: Optional[dict] = None, user_name: Optional[str] = None, password: Optional[str] = None, client_args: Optional[dict] = None, ) -> None: if base_url is None: raise ValueError("Must provide `base_url`") self.base_url = base_url try: from atlassian import Confluence except ImportError: raise ImportError( "`atlassian` package not found, please run `pip install" " atlassian-python-api`" ) self.confluence: Confluence = None if client_args is None: client_args = {} if oauth2: self.confluence = Confluence( url=base_url, oauth2=oauth2, cloud=cloud, **client_args ) else: if api_token is not None: self.confluence = Confluence( url=base_url, token=api_token, cloud=cloud, **client_args ) elif cookies is not None: self.confluence = Confluence( url=base_url, cookies=cookies, cloud=cloud, **client_args ) elif user_name is not None and password is not None: self.confluence = Confluence( url=base_url, username=user_name, password=password, cloud=cloud, **client_args, ) else: api_token = os.getenv(CONFLUENCE_API_TOKEN) if api_token is not None: self.confluence = Confluence( url=base_url, token=api_token, cloud=cloud, **client_args ) else: user_name = os.getenv(CONFLUENCE_USERNAME) password = os.getenv(CONFLUENCE_PASSWORD) if user_name is not None and password is not None: self.confluence = Confluence( url=base_url, username=user_name, password=password, cloud=cloud, **client_args, ) else: raise ValueError( "Must set one of environment variables `CONFLUENCE_API_KEY`, or" " `CONFLUENCE_USERNAME` and `CONFLUENCE_PASSWORD`, if oauth2, or" " api_token, or user_name and password parameters are not provided" ) self._next_cursor = None def load_data( self, space_key: Optional[str] = None, page_ids: Optional[List[str]] = None, page_status: Optional[str] = None, label: Optional[str] = None, cql: Optional[str] = None, include_attachments=False, include_children=False, start: Optional[int] = None, cursor: Optional[str] = None, limit: Optional[int] = None, max_num_results: Optional[int] = None, ) -> List[Document]: """Load Confluence pages from Confluence, specifying by one of four mutually exclusive methods: `space_key`, `page_ids`, `label`, or `cql` (Confluence Query Language https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/ ). Args: space_key (str): Confluence space key, eg 'DS' page_ids (list): List of page ids, eg ['123456', '123457'] page_status (str): Page status, one of None (all statuses), 'current', 'draft', 'archived'. Only compatible with space_key. label (str): Confluence label, eg 'my-label' cql (str): Confluence Query Language query, eg 'label="my-label"' include_attachments (bool): If True, include attachments. include_children (bool): If True, do a DFS of the descendants of each page_id in `page_ids`. Only compatible with `page_ids`. start (int): Skips over the first n elements. Used only with space_key cursor (str): Skips to the cursor. Used with cql and label, set when the max limit has been hit for cql based search limit (int): Deprecated, use `max_num_results` instead. max_num_results (int): Maximum number of results to return. If None, return all results. Requests are made in batches to achieve the desired number of results. """ num_space_key_parameter = 1 if space_key else 0 num_page_ids_parameter = 1 if page_ids is not None else 0 num_label_parameter = 1 if label else 0 num_cql_parameter = 1 if cql else 0 if ( num_space_key_parameter + num_page_ids_parameter + num_label_parameter + num_cql_parameter != 1 ): raise ValueError( "Must specify exactly one among `space_key`, `page_ids`, `label`, `cql`" " parameters." ) if cursor and start: raise ValueError("Must not specify `start` when `cursor` is specified") if space_key and cursor: raise ValueError("Must not specify `cursor` when `space_key` is specified") if page_status and not space_key: raise ValueError( "Must specify `space_key` when `page_status` is specified." ) if include_children and not page_ids: raise ValueError( "Must specify `page_ids` when `include_children` is specified." ) if limit is not None: max_num_results = limit logger.warning( "`limit` is deprecated and no longer relates to the Confluence server's" " API limits. If you wish to limit the number of returned results" " please use `max_num_results` instead." ) try: import html2text # type: ignore except ImportError: raise ImportError( "`html2text` package not found, please run `pip install html2text`" ) text_maker = html2text.HTML2Text() text_maker.ignore_links = True text_maker.ignore_images = True if not start: start = 0 pages: List = [] if space_key: pages.extend( self._get_data_with_paging( self.confluence.get_all_pages_from_space, start=start, max_num_results=max_num_results, space=space_key, status=page_status, expand="body.export_view.value", content_type="page", ) ) elif label: pages.extend( self._get_cql_data_with_paging( start=start, cursor=cursor, cql=f'type="page" AND label="{label}"', max_num_results=max_num_results, expand="body.export_view.value", ) ) elif cql: pages.extend( self._get_cql_data_with_paging( start=start, cursor=cursor, cql=cql, max_num_results=max_num_results, expand="body.export_view.value", ) ) elif page_ids: if include_children: dfs_page_ids = [] max_num_remaining = max_num_results for page_id in page_ids: current_dfs_page_ids = self._dfs_page_ids( page_id, max_num_remaining ) dfs_page_ids.extend(current_dfs_page_ids) if max_num_results is not None: max_num_remaining -= len(current_dfs_page_ids) if max_num_remaining <= 0: break page_ids = dfs_page_ids for page_id in ( page_ids[:max_num_results] if max_num_results is not None else page_ids ): pages.append( self._get_data_with_retry( self.confluence.get_page_by_id, page_id=page_id, expand="body.export_view.value", ) ) docs = [] for page in pages: doc = self.process_page(page, include_attachments, text_maker) docs.append(doc) return docs def _dfs_page_ids(self, page_id, max_num_results): ret = [page_id] max_num_remaining = ( (max_num_results - 1) if max_num_results is not None else None ) if max_num_results is not None and max_num_remaining <= 0: return ret child_page_ids = self._get_data_with_paging( self.confluence.get_child_id_list, page_id=page_id, type="page", max_num_results=max_num_remaining, ) for child_page_id in child_page_ids: dfs_ids = self._dfs_page_ids(child_page_id, max_num_remaining) ret.extend(dfs_ids) if max_num_results is not None: max_num_remaining -= len(dfs_ids) if max_num_remaining <= 0: break return ret def _get_data_with_paging( self, paged_function, start=0, max_num_results=50, **kwargs ): max_num_remaining = max_num_results ret = [] while True: results = self._get_data_with_retry( paged_function, start=start, limit=max_num_remaining, **kwargs ) ret.extend(results) if ( len(results) == 0 or max_num_results is not None and len(results) >= max_num_remaining ): break start += len(results) if max_num_remaining is not None: max_num_remaining -= len(results) return ret def _get_cql_data_with_paging( self, cql, start=0, cursor=None, max_num_results=50, expand="body.export_view.value", ): max_num_remaining = max_num_results ret = [] params = {"cql": cql, "start": start, "expand": expand} if cursor: params["cursor"] = unquote(cursor) if max_num_results is not None: params["limit"] = max_num_remaining while True: results = self._get_data_with_retry( self.confluence.get, path="rest/api/content/search", params=params ) ret.extend(results["results"]) params["start"] += len(results["results"]) next_url = ( results["_links"]["next"] if "next" in results["_links"] else None ) if not next_url: self._next_cursor = None break if "cursor=" in next_url: # On confluence Server this is not set cursor = next_url.split("cursor=")[1].split("&")[0] params["cursor"] = unquote(cursor) if max_num_results is not None: params["limit"] -= len(results["results"]) if params["limit"] <= 0: self._next_cursor = cursor break return ret def get_next_cursor(self): """ Returns: The last set cursor from a cql based search. """ return self._next_cursor @retry(stop_max_attempt_number=1, wait_fixed=4) def _get_data_with_retry(self, function, **kwargs): return function(**kwargs) def process_page(self, page, include_attachments, text_maker): logger.info("Processing " + self.base_url + page["_links"]["webui"]) if include_attachments: attachment_texts = self.process_attachment(page["id"]) else: attachment_texts = [] text = text_maker.handle(page["body"]["export_view"]["value"]) + "".join( attachment_texts ) return Document( text=text, doc_id=page["id"], extra_info={ "title": page["title"], "page_id": page["id"], "status": page["status"], "url": self.base_url + page["_links"]["webui"], }, ) def process_attachment(self, page_id): try: pass except ImportError: raise ImportError( "`pytesseract` or `pdf2image` or `Pillow` package not found, please run" " `pip install pytesseract pdf2image Pillow`" ) # depending on setup you may also need to set the correct path for poppler and tesseract attachments = self.confluence.get_attachments_from_content(page_id)["results"] texts = [] for attachment in attachments: media_type = attachment["metadata"]["mediaType"] absolute_url = self.base_url + attachment["_links"]["download"] title = attachment["title"] if media_type == "application/pdf": logger.info("Processing PDF attachment " + absolute_url) text = title + self.process_pdf(absolute_url) elif ( media_type == "image/png" or media_type == "image/jpg" or media_type == "image/jpeg" or media_type == "image/webp" ): logger.info("Processing image attachment " + absolute_url) text = title + self.process_image(absolute_url) elif ( media_type == "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ): logger.info("Processing Word document attachment " + absolute_url) text = title + self.process_doc(absolute_url) elif ( media_type == "application/vnd.ms-excel" or media_type == "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" or media_type == "application/vnd.ms-excel.sheet.macroenabled.12" ): if title.endswith(".csv") or absolute_url.endswith(".csv"): logger.info("Processing CSV attachment " + absolute_url) text = title + self.process_csv(absolute_url) else: logger.info("Processing XLS attachment " + absolute_url) text = title + self.process_xls(absolute_url) elif media_type == "application/vnd.ms-excel.sheet.binary.macroenabled.12": logger.info("Processing XLSB attachment " + absolute_url) text = title + self.process_xlsb(absolute_url) elif media_type == "text/csv": logger.info("Processing CSV attachment " + absolute_url) text = title + self.process_csv(absolute_url) elif media_type == "application/vnd.ms-outlook": logger.info("Processing Outlook message attachment " + absolute_url) text = title + self.process_msg(absolute_url) elif media_type == "text/html": logger.info(" Processing HTML attachment " + absolute_url) text = title + self.process_html(absolute_url) elif media_type == "text/plain": if title.endswith(".csv") or absolute_url.endswith(".csv"): logger.info("Processing CSV attachment " + absolute_url) text = title + self.process_csv(absolute_url) else: logger.info("Processing Text attachment " + absolute_url) text = title + self.process_txt(absolute_url) elif media_type == "image/svg+xml": logger.info("Processing SVG attachment " + absolute_url) text = title + self.process_svg(absolute_url) elif ( media_type == "application/vnd.openxmlformats-officedocument.presentationml.presentation" or media_type == "application/vnd.ms-powerpoint.presentation.macroenabled.12" ): logger.info( "Processing PowerPoint attachment " + absolute_url + " (" + media_type + ")" ) text = title + self.process_ppt(absolute_url) else: logger.info( f"Skipping unsupported attachment {absolute_url} of media_type {media_type}" ) continue texts.append(text) return texts def process_pdf(self, link): try: import pytesseract # type: ignore from pdf2image import convert_from_bytes # type: ignore except ImportError: raise ImportError( "`pytesseract` or `pdf2image` package not found, please run `pip" " install pytesseract pdf2image`" ) response = self.confluence.request(path=link, absolute=True) text = "" if ( response.status_code != 200 or response.content == b"" or response.content is None ): return text try: images = convert_from_bytes(response.content) except ValueError: return text for i, image in enumerate(images): image_text = pytesseract.image_to_string(image) text += f"Page {i + 1}:\n{image_text}\n\n" return text def process_html(self, link): try: from bs4 import BeautifulSoup # type: ignore import requests except ImportError: raise ImportError( "`beautifulsoup4` or `requests` package not found, please run `pip install beautifulsoup4 requests`" ) try: response = requests.get(link) if response.status_code != 200: return "Error fetching HTML content: HTTP Status Code {}".format( response.status_code ) # Parse the HTML content and extract text soup = BeautifulSoup(response.content, "html.parser") return soup.get_text(separator=" ", strip=True) except Exception as e: logger.error(f"Error processing HTML file at {link}: {e}") return f"Error processing HTML file: {link}. An error occurred while fetching or parsing the content." def process_txt(self, link): try: import requests except ImportError: raise ImportError( "`requests` package not found, please run `pip install requests`" ) try: response = requests.get(link) if response.status_code != 200: return "Error fetching text content: HTTP Status Code {}".format( response.status_code ) return response.text except Exception as e: logger.error(f"Error processing text file at {link}: {e}") return f"Error processing text file: {link}. An error occurred while fetching the content." def process_msg(self, link): try: import extract_msg # type: ignore from io import BytesIO except ImportError: raise ImportError( "`extract-msg` package not found, please run `pip install extract-msg`" ) response = self.confluence.request(path=link, absolute=True) text = "" if response.status_code != 200 or response.content in [b"", None]: logger.error(f"Failed to download .msg file from {link}") return text file_data = BytesIO(response.content) try: # Load the .msg file content with extract_msg.Message(file_data) as msg: subject = msg.subject sender = msg.sender to = msg.to cc = msg.cc body = msg.body # Compile the extracted information into a text string text = ( f"Subject: {subject}\nFrom: {sender}\nTo: {to}\nCC: {cc}\n\n{body}" ) except Exception as e: logger.error(f"Error processing .msg file at {link}: {e}") return "Error processing .msg file." return text def process_image(self, link): try: from io import BytesIO # type: ignore import pytesseract # type: ignore from PIL import Image # type: ignore except ImportError: raise ImportError( "`pytesseract` or `Pillow` package not found, please run `pip install" " pytesseract Pillow`" ) text = "" try: response = self.confluence.request(path=link, absolute=True) # Check if the response status code indicates success (200 OK) if response.status_code == 200 and response.content: try: image = Image.open(BytesIO(response.content)) text = pytesseract.image_to_string(image) except OSError: # Handle errors that occur while opening or processing the image logger.error( f"Error processing image at {link}: Unable to open or read the image content." ) return text else: # Log non-200 responses here if needed logger.error( f"Error fetching image at {link}: HTTP status code {response.status_code}." ) return text except requests.exceptions.RequestException as e: # This catches any Requests-related exceptions, including HTTPError, ConnectionError, etc. logger.error(f"Request error while fetching image at {link}: {e}") return text return text def process_doc(self, link): try: from io import BytesIO import docx2txt import zipfile # Import zipfile to catch BadZipFile exceptions except ImportError: raise ImportError( "`docx2txt` package not found, please run `pip install docx2txt`" ) text = "" try: response = self.confluence.request(path=link, absolute=True) if response.status_code != 200 or response.content in [b"", None]: logger.error( f"Error fetching document at {link}: HTTP status code {response.status_code}." ) return text file_data = BytesIO(response.content) try: text = docx2txt.process(file_data) except zipfile.BadZipFile: logger.error( f"Error processing Word document at {link}: File is not a zip file." ) return text except Exception as e: logger.error(f"Unexpected error processing document at {link}: {e}") return text return text def process_ppt(self, link): try: from io import BytesIO from pptx import Presentation # type: ignore except ImportError: raise ImportError( "`python-pptx` package not found, please run `pip install python-pptx`" ) response = self.confluence.request(path=link, absolute=True) text = "" if ( response.status_code != 200 or response.content == b"" or response.content is None ): return text file_data = BytesIO(response.content) try: presentation = Presentation(file_data) for slide in presentation.slides: for shape in slide.shapes: if hasattr(shape, "text"): text += shape.text + " " except ( Exception ) as e: # Catching a general exception to handle any unexpected errors logger.error(f"Error processing PowerPoint file at {link}: {e}") text = f"Error processing PowerPoint file: {link}. The file might be corrupt or not a valid PowerPoint file." return text.strip() # Remove any leading/trailing whitespace def process_xls(self, link): try: import pandas as pd # type: ignore except ImportError: raise ImportError( "`pandas` package not found, please run `pip install pandas`" ) try: from io import BytesIO except ImportError: raise ImportError("Failed to import BytesIO from io") response = self.confluence.request(path=link, absolute=True) text = "" if ( response.status_code != 200 or response.content == b"" or response.content is None ): return text file_data = BytesIO(response.content) # Try to read the Excel file try: # Use pandas to read all sheets; returns a dict of DataFrame sheets = pd.read_excel(file_data, sheet_name=None, engine="openpyxl") except Exception as e: return f"Failed to read Excel file: {e!s}" for sheet_name, sheet_data in sheets.items(): text += f"{sheet_name}:\n" for row_index, row in sheet_data.iterrows(): text += "\t".join(str(value) for value in row) + "\n" text += "\n" return text.strip() def process_xlsb(self, link): try: import pandas as pd from io import BytesIO except ImportError: raise ImportError( "`pandas` package not found, please run `pip install pandas`" ) response = self.confluence.request(path=link, absolute=True) text = "" if ( response.status_code != 200 or response.content == b"" or response.content is None ): return text file_data = BytesIO(response.content) try: # Use pandas to read the .xlsb file, specifying pyxlsb as the engine df = pd.read_excel(file_data, engine="pyxlsb") # Convert the DataFrame to a text string text_rows = [] for index, row in df.iterrows(): text_rows.append(", ".join(row.astype(str))) text = "\n".join(text_rows) except Exception as e: logger.error(f"Error processing XLSB file at {link}: {e}") text = "Error processing XLSB file." return text def process_csv(self, link): try: import pandas as pd from io import BytesIO except ImportError: raise ImportError( "`pandas` package not found, please run `pip install pandas`" ) response = self.confluence.request(path=link, absolute=True) text = "" if ( response.status_code != 200 or response.content == b"" or response.content is None ): return text file_data = BytesIO(response.content) try: # Assuming CSV uses default comma delimiter. If delimiter varies, consider detecting it. df = pd.read_csv(file_data, low_memory=False) # Convert the DataFrame to a text string, including headers text_rows = [] for index, row in df.iterrows(): text_rows.append(", ".join(row.astype(str))) text = "\n".join(text_rows) except Exception as e: logger.error(f"Error processing CSV file: {e}") text = "Error processing CSV file." return text def process_svg(self, link): try: from io import BytesIO # type: ignore import pytesseract # type: ignore from PIL import Image # type: ignore from reportlab.graphics import renderPM # type: ignore from svglib.svglib import svg2rlg # type: ignore except ImportError: raise ImportError( "`pytesseract`, `Pillow`, or `svglib` package not found, please run" " `pip install pytesseract Pillow svglib`" ) response = self.confluence.request(path=link, absolute=True) text = "" if ( response.status_code != 200 or response.content == b"" or response.content is None ): return text drawing = svg2rlg(BytesIO(response.content)) img_data = BytesIO() renderPM.drawToFile(drawing, img_data, fmt="PNG") img_data.seek(0) image = Image.open(img_data) return pytesseract.image_to_string(image) </code></pre></div></td></tr></table></div> </details> <div class="doc doc-children"> <div class="doc doc-object doc-function"> <h3 id="llama_index.readers.confluence.ConfluenceReader.load_data" class="doc doc-heading"> load_data <a href="#llama_index.readers.confluence.ConfluenceReader.load_data" class="headerlink" title="Permanent link">#</a></h3> <div class="doc-signature highlight"><pre><code>load_data(space_key: Optional[str] = None, page_ids: Optional[List[str]] = None, page_status: Optional[str] = None, label: Optional[str] = None, cql: Optional[str] = None, include_attachments=False, include_children=False, start: Optional[int] = None, cursor: Optional[str] = None, limit: Optional[int] = None, max_num_results: Optional[int] = None) -> List[<a class="autorefs autorefs-internal" title="llama_index.core.schema.Document" href="../../schema/#llama_index.core.schema.Document">Document</a>] </code></pre></div> <div class="doc doc-contents "> Load Confluence pages from Confluence, specifying by one of four mutually exclusive methods: <code>space_key</code>, <code>page_ids</code>, <code>label</code>, or <code>cql</code> (Confluence Query Language https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/ ). Parameters: <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr class="doc-section-item"> <td> <code>space_key</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Confluence space key, eg 'DS' </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>page_ids</code> </td> <td> <code>list</code> </td> <td> <div class="doc-md-description"> List of page ids, eg ['123456', '123457'] </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>page_status</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Page status, one of None (all statuses), 'current', 'draft', 'archived'. Only compatible with space_key. </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>label</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Confluence label, eg 'my-label' </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>cql</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Confluence Query Language query, eg 'label="my-label"' </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>include_attachments</code> </td> <td> <code>bool</code> </td> <td> <div class="doc-md-description"> If True, include attachments. </div> </td> <td> <code>False</code> </td> </tr> <tr class="doc-section-item"> <td> <code>include_children</code> </td> <td> <code>bool</code> </td> <td> <div class="doc-md-description"> If True, do a DFS of the descendants of each page_id in <code>page_ids</code>. Only compatible with <code>page_ids</code>. </div> </td> <td> <code>False</code> </td> </tr> <tr class="doc-section-item"> <td> <code>start</code> </td> <td> <code>int</code> </td> <td> <div class="doc-md-description"> Skips over the first n elements. Used only with space_key </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>cursor</code> </td> <td> <code>str</code> </td> <td> <div class="doc-md-description"> Skips to the cursor. Used with cql and label, set when the max limit has been hit for cql based search </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>limit</code> </td> <td> <code>int</code> </td> <td> <div class="doc-md-description"> Deprecated, use <code>max_num_results</code> instead. </div> </td> <td> <code>None</code> </td> </tr> <tr class="doc-section-item"> <td> <code>max_num_results</code> </td> <td> <code>int</code> </td> <td> <div class="doc-md-description"> Maximum number of results to return. If None, return all results. Requests are made in batches to achieve the desired number of results. </div> </td> <td> <code>None</code> </td> </tr> </tbody> </table> <details class="quote"> <summary>Source code in <code>llama-index-integrations/readers/llama-index-readers-confluence/llama_index/readers/confluence/base.py</code></summary> <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262</pre></div></td><td class="code"><div><pre><code>def load_data( self, space_key: Optional[str] = None, page_ids: Optional[List[str]] = None, page_status: Optional[str] = None, label: Optional[str] = None, cql: Optional[str] = None, include_attachments=False, include_children=False, start: Optional[int] = None, cursor: Optional[str] = None, limit: Optional[int] = None, max_num_results: Optional[int] = None, ) -> List[Document]: """Load Confluence pages from Confluence, specifying by one of four mutually exclusive methods: `space_key`, `page_ids`, `label`, or `cql` (Confluence Query Language https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/ ). Args: space_key (str): Confluence space key, eg 'DS' page_ids (list): List of page ids, eg ['123456', '123457'] page_status (str): Page status, one of None (all statuses), 'current', 'draft', 'archived'. Only compatible with space_key. label (str): Confluence label, eg 'my-label' cql (str): Confluence Query Language query, eg 'label="my-label"' include_attachments (bool): If True, include attachments. include_children (bool): If True, do a DFS of the descendants of each page_id in `page_ids`. Only compatible with `page_ids`. start (int): Skips over the first n elements. Used only with space_key cursor (str): Skips to the cursor. Used with cql and label, set when the max limit has been hit for cql based search limit (int): Deprecated, use `max_num_results` instead. max_num_results (int): Maximum number of results to return. If None, return all results. Requests are made in batches to achieve the desired number of results. """ num_space_key_parameter = 1 if space_key else 0 num_page_ids_parameter = 1 if page_ids is not None else 0 num_label_parameter = 1 if label else 0 num_cql_parameter = 1 if cql else 0 if ( num_space_key_parameter + num_page_ids_parameter + num_label_parameter + num_cql_parameter != 1 ): raise ValueError( "Must specify exactly one among `space_key`, `page_ids`, `label`, `cql`" " parameters." ) if cursor and start: raise ValueError("Must not specify `start` when `cursor` is specified") if space_key and cursor: raise ValueError("Must not specify `cursor` when `space_key` is specified") if page_status and not space_key: raise ValueError( "Must specify `space_key` when `page_status` is specified." ) if include_children and not page_ids: raise ValueError( "Must specify `page_ids` when `include_children` is specified." ) if limit is not None: max_num_results = limit logger.warning( "`limit` is deprecated and no longer relates to the Confluence server's" " API limits. If you wish to limit the number of returned results" " please use `max_num_results` instead." ) try: import html2text # type: ignore except ImportError: raise ImportError( "`html2text` package not found, please run `pip install html2text`" ) text_maker = html2text.HTML2Text() text_maker.ignore_links = True text_maker.ignore_images = True if not start: start = 0 pages: List = [] if space_key: pages.extend( self._get_data_with_paging( self.confluence.get_all_pages_from_space, start=start, max_num_results=max_num_results, space=space_key, status=page_status, expand="body.export_view.value", content_type="page", ) ) elif label: pages.extend( self._get_cql_data_with_paging( start=start, cursor=cursor, cql=f'type="page" AND label="{label}"', max_num_results=max_num_results, expand="body.export_view.value", ) ) elif cql: pages.extend( self._get_cql_data_with_paging( start=start, cursor=cursor, cql=cql, max_num_results=max_num_results, expand="body.export_view.value", ) ) elif page_ids: if include_children: dfs_page_ids = [] max_num_remaining = max_num_results for page_id in page_ids: current_dfs_page_ids = self._dfs_page_ids( page_id, max_num_remaining ) dfs_page_ids.extend(current_dfs_page_ids) if max_num_results is not None: max_num_remaining -= len(current_dfs_page_ids) if max_num_remaining <= 0: break page_ids = dfs_page_ids for page_id in ( page_ids[:max_num_results] if max_num_results is not None else page_ids ): pages.append( self._get_data_with_retry( self.confluence.get_page_by_id, page_id=page_id, expand="body.export_view.value", ) ) docs = [] for page in pages: doc = self.process_page(page, include_attachments, text_maker) docs.append(doc) return docs </code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id="llama_index.readers.confluence.ConfluenceReader.get_next_cursor" class="doc doc-heading"> get_next_cursor <a href="#llama_index.readers.confluence.ConfluenceReader.get_next_cursor" class="headerlink" title="Permanent link">#</a></h3> <div class="doc-signature highlight"><pre><code>get_next_cursor() </code></pre></div> <div class="doc doc-contents "> Returns: The last set cursor from a cql based search. <details class="quote"> <summary>Source code in <code>llama-index-integrations/readers/llama-index-readers-confluence/llama_index/readers/confluence/base.py</code></summary> <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>352 353 354 355 356</pre></div></td><td class="code"><div><pre><code>def get_next_cursor(self): """ Returns: The last set cursor from a cql based search. """ return self._next_cursor </code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> </div> </div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type="button" class="md-top md-icon" data-md-component="top" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../chroma/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Chroma"> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class="md-footer__title"> Previous <div class="md-ellipsis"> Chroma </div> </div> </a> <a href="../couchbase/" class="md-footer__link md-footer__link--next" aria-label="Next: Couchbase"> <div class="md-footer__title"> Next <div class="md-ellipsis"> Couchbase </div> </div> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <readthedocs-flyout position="bottom-left"></readthedocs-flyout> </div> </div> </footer> <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=2b5669c2-eb91-4d0a-81d6-dc7238350598" width="1" height="1" /> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.tabs", "navigation.indexes", "navigation.top", "navigation.footer", "toc.follow", "content.code.copy", "search.suggest", "search.highlight"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../../assets/javascripts/bundle.f1b6f286.min.js"></script> <script src="../../../javascript/runllm.js"></script> <script src="../../../javascript/algolia.js"></script> </body> </html>

CINXE.COM

Confluence - LlamaIndex