Files
txtai/examples/index.html
T
2026-10-11 21:29:39 +00:00

4125 lines
103 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="txtai is an all-in-one open-source AI framework for semantic search, LLM orchestration and language model workflows">
<link rel="prev" href="../cloud/">
<link rel="next" href="../faq/">
<link rel="icon" href="../images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
<title>Examples - txtai</title>
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.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">
<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>
<meta property="og:type" content="website" />
<meta property="og:title" content="txtai - Examples" />
<meta property="og:description" content="txtai is an all-in-one open-source AI framework for semantic search, LLM orchestration and language model workflows" />
<meta property="og:url" content="None" />
<meta property="og:image" content="https://repository-images.githubusercontent.com/286301447/a5a3cc1d-0e3f-4fee-b1a4-a30a0d11e794" />
<meta property="og:image:type" content="image/png" />
<meta property="og:image:width" content="1920" />
<meta property="og:image:height" content="960" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="txtai - Examples" />
<meta name="twitter:description" content="txtai is an all-in-one open-source AI framework for semantic search, LLM orchestration and language model workflows" />
<meta name="twitter:image" content="https://repository-images.githubusercontent.com/286301447/a5a3cc1d-0e3f-4fee-b1a4-a30a0d11e794" />
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="blue">
<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="#examples" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="txtai" class="md-header__button md-logo" aria-label="txtai" data-md-component="logo">
<img src="../images/logo.png" 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">
<span class="md-ellipsis">
txtai
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Examples
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="blue" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6m0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4M7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="light-blue" data-md-color-accent="light-blue" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></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 class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon 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>
<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>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/neuml/txtai" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
neuml/txtai
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<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" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="txtai" class="md-nav__button md-logo" aria-label="txtai" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
</a>
txtai
</label>
<div class="md-nav__source">
<a href="https://github.com/neuml/txtai" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
neuml/txtai
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../why/" class="md-nav__link">
<span class="md-ellipsis">
Why txtai?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../usecases/" class="md-nav__link">
<span class="md-ellipsis">
Use Cases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../install/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../models/" class="md-nav__link">
<span class="md-ellipsis">
Model Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<div class="md-nav__link md-nav__container">
<a href="../embeddings/" class="md-nav__link ">
<span class="md-ellipsis">
Embeddings
</span>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Embeddings
</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_6_2" >
<div class="md-nav__link md-nav__container">
<a href="../embeddings/configuration/" class="md-nav__link ">
<span class="md-ellipsis">
Configuration
</span>
</a>
<label class="md-nav__link " for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../embeddings/configuration/ann/" class="md-nav__link">
<span class="md-ellipsis">
ANN
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/configuration/cloud/" class="md-nav__link">
<span class="md-ellipsis">
Cloud
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/configuration/database/" class="md-nav__link">
<span class="md-ellipsis">
Database
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/configuration/general/" class="md-nav__link">
<span class="md-ellipsis">
General
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/configuration/graph/" class="md-nav__link">
<span class="md-ellipsis">
Graph
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/configuration/scoring/" class="md-nav__link">
<span class="md-ellipsis">
Scoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/configuration/vectors/" class="md-nav__link">
<span class="md-ellipsis">
Vectors
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../embeddings/format/" class="md-nav__link">
<span class="md-ellipsis">
Index Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/indexing/" class="md-nav__link">
<span class="md-ellipsis">
Index Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/methods/" class="md-nav__link">
<span class="md-ellipsis">
Methods
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../embeddings/query/" class="md-nav__link">
<span class="md-ellipsis">
Query Guide
</span>
</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" >
<div class="md-nav__link md-nav__container">
<a href="../agent/" class="md-nav__link ">
<span class="md-ellipsis">
Agent
</span>
</a>
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Agent
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../agent/configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../agent/methods/" class="md-nav__link">
<span class="md-ellipsis">
Methods
</span>
</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" >
<div class="md-nav__link md-nav__container">
<a href="../pipeline/" class="md-nav__link ">
<span class="md-ellipsis">
Pipeline
</span>
</a>
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</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">
<span class="md-nav__icon md-icon"></span>
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_8_2" >
<label class="md-nav__link" for="__nav_8_2" id="__nav_8_2_label" tabindex="0">
<span class="md-ellipsis">
Audio
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8_2">
<span class="md-nav__icon md-icon"></span>
Audio
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../pipeline/audio/audiomixer/" class="md-nav__link">
<span class="md-ellipsis">
Audio Mixer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/audio/audiostream/" class="md-nav__link">
<span class="md-ellipsis">
Audio Stream
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/audio/microphone/" class="md-nav__link">
<span class="md-ellipsis">
Microphone
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/audio/texttoaudio/" class="md-nav__link">
<span class="md-ellipsis">
Text To Audio
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/audio/texttospeech/" class="md-nav__link">
<span class="md-ellipsis">
Text To Speech
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/audio/transcription/" class="md-nav__link">
<span class="md-ellipsis">
Transcription
</span>
</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_3" >
<label class="md-nav__link" for="__nav_8_3" id="__nav_8_3_label" tabindex="0">
<span class="md-ellipsis">
Data
</span>
<span class="md-nav__icon md-icon"></span>
</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">
<span class="md-nav__icon md-icon"></span>
Data
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../pipeline/data/filetohtml/" class="md-nav__link">
<span class="md-ellipsis">
File To HTML
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/data/htmltomd/" class="md-nav__link">
<span class="md-ellipsis">
HTML To Markdown
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/data/segmentation/" class="md-nav__link">
<span class="md-ellipsis">
Segmentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/data/tabular/" class="md-nav__link">
<span class="md-ellipsis">
Tabular
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/data/textractor/" class="md-nav__link">
<span class="md-ellipsis">
Textractor
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/data/tokenizer/" class="md-nav__link">
<span class="md-ellipsis">
Tokenizer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/data/urlretrieve/" class="md-nav__link">
<span class="md-ellipsis">
URL Retrieve
</span>
</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_4" >
<label class="md-nav__link" for="__nav_8_4" id="__nav_8_4_label" tabindex="0">
<span class="md-ellipsis">
Image
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8_4">
<span class="md-nav__icon md-icon"></span>
Image
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../pipeline/image/caption/" class="md-nav__link">
<span class="md-ellipsis">
Caption
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/image/imagehash/" class="md-nav__link">
<span class="md-ellipsis">
Image Hash
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/image/objects/" class="md-nav__link">
<span class="md-ellipsis">
Objects
</span>
</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">
<span class="md-ellipsis">
LLM
</span>
<span class="md-nav__icon md-icon"></span>
</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">
<span class="md-nav__icon md-icon"></span>
LLM
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../pipeline/llm/llm/" class="md-nav__link">
<span class="md-ellipsis">
LLM
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/llm/rag/" class="md-nav__link">
<span class="md-ellipsis">
RAG
</span>
</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_6" >
<label class="md-nav__link" for="__nav_8_6" id="__nav_8_6_label" tabindex="0">
<span class="md-ellipsis">
Text
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8_6">
<span class="md-nav__icon md-icon"></span>
Text
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../pipeline/text/entity/" class="md-nav__link">
<span class="md-ellipsis">
Entity
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/text/labels/" class="md-nav__link">
<span class="md-ellipsis">
Labels
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/text/reranker/" class="md-nav__link">
<span class="md-ellipsis">
Reranker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/text/similarity/" class="md-nav__link">
<span class="md-ellipsis">
Similarity
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/text/summary/" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/text/translation/" class="md-nav__link">
<span class="md-ellipsis">
Translation
</span>
</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_7" >
<label class="md-nav__link" for="__nav_8_7" id="__nav_8_7_label" tabindex="0">
<span class="md-ellipsis">
Train
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8_7">
<span class="md-nav__icon md-icon"></span>
Train
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../pipeline/train/hfonnx/" class="md-nav__link">
<span class="md-ellipsis">
HF ONNX
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/train/lemur/" class="md-nav__link">
<span class="md-ellipsis">
LEMUR Trainer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/train/mlonnx/" class="md-nav__link">
<span class="md-ellipsis">
ML ONNX
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../pipeline/train/trainer/" class="md-nav__link">
<span class="md-ellipsis">
Trainer
</span>
</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_9" >
<div class="md-nav__link md-nav__container">
<a href="../workflow/" class="md-nav__link ">
<span class="md-ellipsis">
Workflow
</span>
</a>
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</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">
<span class="md-nav__icon md-icon"></span>
Workflow
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../workflow/schedule/" class="md-nav__link">
<span class="md-ellipsis">
Schedule
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_3" >
<div class="md-nav__link md-nav__container">
<a href="../workflow/task/" class="md-nav__link ">
<span class="md-ellipsis">
Tasks
</span>
</a>
<label class="md-nav__link " for="__nav_9_3" id="__nav_9_3_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_9_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9_3">
<span class="md-nav__icon md-icon"></span>
Tasks
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../workflow/task/console/" class="md-nav__link">
<span class="md-ellipsis">
Console
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/export/" class="md-nav__link">
<span class="md-ellipsis">
Export
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/file/" class="md-nav__link">
<span class="md-ellipsis">
File
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/image/" class="md-nav__link">
<span class="md-ellipsis">
Image
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/retrieve/" class="md-nav__link">
<span class="md-ellipsis">
Retrieve
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/service/" class="md-nav__link">
<span class="md-ellipsis">
Service
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/storage/" class="md-nav__link">
<span class="md-ellipsis">
Storage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/template/" class="md-nav__link">
<span class="md-ellipsis">
Template
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/url/" class="md-nav__link">
<span class="md-ellipsis">
Url
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../workflow/task/workflow/" class="md-nav__link">
<span class="md-ellipsis">
Workflow
</span>
</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_10" >
<div class="md-nav__link md-nav__container">
<a href="../api/" class="md-nav__link ">
<span class="md-ellipsis">
API
</span>
</a>
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../api/cluster/" class="md-nav__link">
<span class="md-ellipsis">
Cluster
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/customization/" class="md-nav__link">
<span class="md-ellipsis">
Customization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/methods/" class="md-nav__link">
<span class="md-ellipsis">
Methods
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/mcp/" class="md-nav__link">
<span class="md-ellipsis">
Model Context Protocol
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/openai/" class="md-nav__link">
<span class="md-ellipsis">
OpenAI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../cloud/" class="md-nav__link">
<span class="md-ellipsis">
Cloud
</span>
</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">
<span class="md-ellipsis">
Examples
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Examples
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#semantic-search" class="md-nav__link">
<span class="md-ellipsis">
Semantic Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#llm" class="md-nav__link">
<span class="md-ellipsis">
LLM
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#pipelines" class="md-nav__link">
<span class="md-ellipsis">
Pipelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#workflows" class="md-nav__link">
<span class="md-ellipsis">
Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#model-training" class="md-nav__link">
<span class="md-ellipsis">
Model Training
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#api" class="md-nav__link">
<span class="md-ellipsis">
API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#releases" class="md-nav__link">
<span class="md-ellipsis">
Releases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#applications" class="md-nav__link">
<span class="md-ellipsis">
Applications
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../observability/" class="md-nav__link">
<span class="md-ellipsis">
Observability
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../poweredby/" class="md-nav__link">
<span class="md-ellipsis">
Powered by txtai
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../further/" class="md-nav__link">
<span class="md-ellipsis">
Further Reading
</span>
</a>
</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">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#semantic-search" class="md-nav__link">
<span class="md-ellipsis">
Semantic Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#llm" class="md-nav__link">
<span class="md-ellipsis">
LLM
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#pipelines" class="md-nav__link">
<span class="md-ellipsis">
Pipelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#workflows" class="md-nav__link">
<span class="md-ellipsis">
Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#model-training" class="md-nav__link">
<span class="md-ellipsis">
Model Training
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#api" class="md-nav__link">
<span class="md-ellipsis">
API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#architecture" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#releases" class="md-nav__link">
<span class="md-ellipsis">
Releases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#applications" class="md-nav__link">
<span class="md-ellipsis">
Applications
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="examples">Examples</h1>
<p><img alt="examples" src="../images/examples.png#only-light" />
<img alt="examples" src="../images/examples-dark.png#only-dark" /></p>
<p>See below for a comprehensive series of example notebooks and applications covering txtai.</p>
<h2 id="semantic-search">Semantic Search</h2>
<p>Build semantic/similarity/vector/neural search applications.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/01_Introducing_txtai.ipynb">Introducing txtai</a> <a href="https://www.youtube.com/watch?v=SIezMnVdmMs">▶️</a></td>
<td style="text-align: left;">Overview of the functionality provided by txtai</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/01_Introducing_txtai.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/02_Build_an_Embeddings_index_with_Hugging_Face_Datasets.ipynb">Build an Embeddings index with Hugging Face Datasets</a></td>
<td style="text-align: left;">Index and search Hugging Face Datasets</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/02_Build_an_Embeddings_index_with_Hugging_Face_Datasets.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb">Build an Embeddings index from a data source</a></td>
<td style="text-align: left;">Index and search a data source with word embeddings</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/04_Add_semantic_search_to_Elasticsearch.ipynb">Add semantic search to Elasticsearch</a></td>
<td style="text-align: left;">Add semantic search to existing search systems</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/04_Add_semantic_search_to_Elasticsearch.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/13_Similarity_search_with_images.ipynb">Similarity search with images</a></td>
<td style="text-align: left;">Embed images and text into the same space for search</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/13_Similarity_search_with_images.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/30_Embeddings_SQL_custom_functions.ipynb">Custom Embeddings SQL functions</a></td>
<td style="text-align: left;">Add user-defined functions to Embeddings SQL</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/30_Embeddings_SQL_custom_functions.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/32_Model_explainability.ipynb">Model explainability</a></td>
<td style="text-align: left;">Explainability for semantic search</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/32_Model_explainability.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/33_Query_translation.ipynb">Query translation</a></td>
<td style="text-align: left;">Domain-specific natural language queries with query translation</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/33_Query_translation.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/34_Build_a_QA_database.ipynb">Build a QA database</a></td>
<td style="text-align: left;">Question matching with semantic search</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/34_Build_a_QA_database.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/38_Introducing_the_Semantic_Graph.ipynb">Semantic Graphs</a></td>
<td style="text-align: left;">Explore topics, data connectivity and run network analysis</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/38_Introducing_the_Semantic_Graph.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/39_Classic_Topic_Modeling_with_BM25.ipynb">Topic Modeling with BM25</a></td>
<td style="text-align: left;">Topic modeling backed by a BM25 index</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/39_Classic_Topic_Modeling_with_BM25.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="llm">LLM</h2>
<p>Autonomous agents, retrieval augmented generation (RAG), chat with your data, pipelines and workflows that interface with large language models (LLMs).</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/42_Prompt_driven_search_with_LLMs.ipynb">Prompt-driven search with LLMs</a></td>
<td style="text-align: left;">Embeddings-guided and Prompt-driven search with Large Language Models (LLMs)</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/42_Prompt_driven_search_with_LLMs.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/44_Prompt_templates_and_task_chains.ipynb">Prompt templates and task chains</a></td>
<td style="text-align: left;">Build model prompts and connect tasks together with workflows</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/44_Prompt_templates_and_task_chains.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/52_Build_RAG_pipelines_with_txtai.ipynb">Build RAG pipelines with txtai</a> <a href="https://www.youtube.com/watch?v=t_OeAc8NVfQ">▶️</a></td>
<td style="text-align: left;">Guide on retrieval augmented generation including how to create citations</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/52_Build_RAG_pipelines_with_txtai.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/53_Integrate_LLM_Frameworks.ipynb">Integrate LLM frameworks</a></td>
<td style="text-align: left;">Integrate llama.cpp, LiteLLM and custom generation frameworks</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/53_Integrate_LLM_Frameworks.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/55_Generate_knowledge_with_Semantic_Graphs_and_RAG.ipynb">Generate knowledge with Semantic Graphs and RAG</a></td>
<td style="text-align: left;">Knowledge exploration and discovery with Semantic Graphs and RAG</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/55_Generate_knowledge_with_Semantic_Graphs_and_RAG.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/57_Build_knowledge_graphs_with_LLM_driven_entity_extraction.ipynb">Build knowledge graphs with LLMs</a></td>
<td style="text-align: left;">Build knowledge graphs with LLM-driven entity extraction</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/57_Build_knowledge_graphs_with_LLM_driven_entity_extraction.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/58_Advanced_RAG_with_graph_path_traversal.ipynb">Advanced RAG with graph path traversal</a></td>
<td style="text-align: left;">Graph path traversal to collect complex sets of data for advanced RAG</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/58_Advanced_RAG_with_graph_path_traversal.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/60_Advanced_RAG_with_guided_generation.ipynb">Advanced RAG with guided generation</a></td>
<td style="text-align: left;">Retrieval Augmented and Guided Generation</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/60_Advanced_RAG_with_guided_generation.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/62_RAG_with_llama_cpp_and_external_API_services.ipynb">RAG with llama.cpp and external API services</a></td>
<td style="text-align: left;">RAG with additional vector and LLM frameworks</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/62_RAG_with_llama_cpp_and_external_API_services.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/63_How_RAG_with_txtai_works.ipynb">How RAG with txtai works</a></td>
<td style="text-align: left;">Create RAG processes, API services and Docker instances</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/63_How_RAG_with_txtai_works.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/65_Speech_to_Speech_RAG.ipynb">Speech to Speech RAG</a> <a href="https://www.youtube.com/watch?v=tH8QWwkVMKA">▶️</a></td>
<td style="text-align: left;">Full cycle speech to speech workflow with RAG</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/65_Speech_to_Speech_RAG.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/68_Analyzing_Hugging_Face_Posts_with_Graphs_and_Agents.ipynb">Analyzing Hugging Face Posts with Graphs and Agents</a></td>
<td style="text-align: left;">Explore a rich dataset with Graph Analysis and Agents</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/68_Analyzing_Hugging_Face_Posts_with_Graphs_and_Agents.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/69_Granting_autonomy_to_agents.ipynb">Granting autonomy to agents</a></td>
<td style="text-align: left;">Agents that iteratively solve problems as they see fit</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/69_Granting_autonomy_to_agents.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/70_Getting_started_with_LLM_APIs.ipynb">Getting started with LLM APIs</a></td>
<td style="text-align: left;">Generate embeddings and run LLMs with OpenAI, Claude, Gemini, Bedrock and more</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/70_Getting_started_with_LLM_APIs.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/71_Analyzing_LinkedIn_Company_Posts_with_Graphs_and_Agents.ipynb">Analyzing LinkedIn Company Posts with Graphs and Agents</a></td>
<td style="text-align: left;">Exploring how to improve social media engagement with AI</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/71_Analyzing_LinkedIn_Company_Posts_with_Graphs_and_Agents.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/72_Parsing_the_stars_with_txtai.ipynb">Parsing the stars with txtai</a></td>
<td style="text-align: left;">Explore an astronomical knowledge graph of known stars, planets, galaxies</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/72_Parsing_the_stars_with_txtai.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/73_Chunking_your_data_for_RAG.ipynb">Chunking your data for RAG</a></td>
<td style="text-align: left;">Extract, chunk and index content for effective retrieval</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/73_Chunking_your_data_for_RAG.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/75_Medical_RAG_Research_with_txtai.ipynb">Medical RAG Research with txtai</a></td>
<td style="text-align: left;">Analyze PubMed article metadata with RAG</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/75_Medical_RAG_Research_with_txtai.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/77_GraphRAG_with_Wikipedia_and_GPT_OSS.ipynb">GraphRAG with Wikipedia and GPT OSS</a></td>
<td style="text-align: left;">Deep graph search powered RAG</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/77_GraphRAG_with_Wikipedia_and_GPT_OSS.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/79_RAG_is_more_than_Vector_Search.ipynb">RAG is more than Vector Search</a></td>
<td style="text-align: left;">Context retrieval via Web, SQL and other sources</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/79_RAG_is_more_than_Vector_Search.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/81_OpenCode_as_a_txtai_LLM.ipynb">OpenCode as a txtai LLM</a></td>
<td style="text-align: left;">Integrate OpenCode with the txtai ecosystem</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/81_OpenCode_as_a_txtai_LLM.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/82_Agentic_College_Search.ipynb">Agentic College Search</a></td>
<td style="text-align: left;">Identify a list of strong engineering colleges</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/82_Agentic_College_Search.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/83_TxtAI_got_skills.ipynb">TxtAI got skills</a></td>
<td style="text-align: left;">Integrate skill.md files with your agent</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/83_TxtAI_got_skills.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/84_Agent_Tools.ipynb">Agent Tools</a> <a href="https://www.youtube.com/watch?v=RDNaFXQy3GQ">▶️</a></td>
<td style="text-align: left;">Learn about the txtai agent toolkit</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/84_Agent_Tools.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="pipelines">Pipelines</h2>
<p>Transform data with language model backed pipelines.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/05_Extractive_QA_with_txtai.ipynb">Extractive QA with txtai</a></td>
<td style="text-align: left;">Introduction to extractive question-answering with txtai</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/05_Extractive_QA_with_txtai.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/06_Extractive_QA_with_Elasticsearch.ipynb">Extractive QA with Elasticsearch</a></td>
<td style="text-align: left;">Run extractive question-answering queries with Elasticsearch</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/06_Extractive_QA_with_Elasticsearch.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/20_Extractive_QA_to_build_structured_data.ipynb">Extractive QA to build structured data</a></td>
<td style="text-align: left;">Build structured datasets using extractive question-answering</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/20_Extractive_QA_to_build_structured_data.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/07_Apply_labels_with_zero_shot_classification.ipynb">Apply labels with zero shot classification</a></td>
<td style="text-align: left;">Use zero shot learning for labeling, classification and topic modeling</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/07_Apply_labels_with_zero_shot_classification.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/09_Building_abstractive_text_summaries.ipynb">Building abstractive text summaries</a></td>
<td style="text-align: left;">Run abstractive text summarization</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/09_Building_abstractive_text_summaries.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/10_Extract_text_from_documents.ipynb">Extract text from documents</a></td>
<td style="text-align: left;">Extract text from PDF, Office, HTML and more</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/10_Extract_text_from_documents.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/40_Text_to_Speech_Generation.ipynb">Text to speech generation</a></td>
<td style="text-align: left;">Generate speech from text</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/40_Text_to_Speech_Generation.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/11_Transcribe_audio_to_text.ipynb">Transcribe audio to text</a></td>
<td style="text-align: left;">Convert audio files to text</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/11_Transcribe_audio_to_text.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/12_Translate_text_between_languages.ipynb">Translate text between languages</a></td>
<td style="text-align: left;">Streamline machine translation and language detection</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/12_Translate_text_between_languages.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/25_Generate_image_captions_and_detect_objects.ipynb">Generate image captions and detect objects</a></td>
<td style="text-align: left;">Captions and object detection for images</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/25_Generate_image_captions_and_detect_objects.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/31_Near_duplicate_image_detection.ipynb">Near duplicate image detection</a></td>
<td style="text-align: left;">Identify duplicate and near-duplicate images</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/31_Near_duplicate_image_detection.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="workflows">Workflows</h2>
<p>Efficiently process data at scale.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/14_Run_pipeline_workflows.ipynb">Run pipeline workflows</a> <a href="https://www.youtube.com/watch?v=UBMPDCn1gEU">▶️</a></td>
<td style="text-align: left;">Simple yet powerful constructs to efficiently process data</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/14_Run_pipeline_workflows.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/22_Transform_tabular_data_with_composable_workflows.ipynb">Transform tabular data with composable workflows</a></td>
<td style="text-align: left;">Transform, index and search tabular data</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/22_Transform_tabular_data_with_composable_workflows.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/23_Tensor_workflows.ipynb">Tensor workflows</a></td>
<td style="text-align: left;">Performant processing of large tensor arrays</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/23_Tensor_workflows.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/26_Entity_extraction_workflows.ipynb">Entity extraction workflows</a></td>
<td style="text-align: left;">Identify entity/label combinations</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/26_Entity_extraction_workflows.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/27_Workflow_scheduling.ipynb">Workflow Scheduling</a></td>
<td style="text-align: left;">Schedule workflows with cron expressions</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/27_Workflow_scheduling.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/28_Push_notifications_with_workflows.ipynb">Push notifications with workflows</a></td>
<td style="text-align: left;">Generate and push notifications with workflows</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/28_Push_notifications_with_workflows.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/35_Pictures_are_worth_a_thousand_words.ipynb">Pictures are a worth a thousand words</a></td>
<td style="text-align: left;">Generate webpage summary images with DALL-E mini</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/35_Pictures_are_worth_a_thousand_words.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/36_Run_txtai_in_native_code.ipynb">Run txtai with native code</a></td>
<td style="text-align: left;">Execute workflows in native code with the Python C API</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/36_Run_txtai_in_native_code.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/66_Generative_Audio.ipynb">Generative Audio</a></td>
<td style="text-align: left;">Storytelling with generative audio workflows</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/66_Generative_Audio.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="model-training">Model Training</h2>
<p>Train, distill, fine-tune and export models.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/16_Train_a_text_labeler.ipynb">Train a text labeler</a></td>
<td style="text-align: left;">Build text sequence classification models</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/16_Train_a_text_labeler.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/17_Train_without_labels.ipynb">Train without labels</a></td>
<td style="text-align: left;">Use zero-shot classifiers to train new models</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/17_Train_without_labels.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/19_Train_a_QA_model.ipynb">Train a QA model</a></td>
<td style="text-align: left;">Build and fine-tune question-answering models</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/19_Train_a_QA_model.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/41_Train_a_language_model_from_scratch.ipynb">Train a language model from scratch</a></td>
<td style="text-align: left;">Build new language models</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/41_Train_a_language_model_from_scratch.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/80_Distilling_Knowledge_into_Tiny_LLMs.ipynb">Distilling Knowledge into Tiny LLMs</a> <a href="https://www.youtube.com/watch?v=Ol560ktgkf0">▶️</a></td>
<td style="text-align: left;">Finetune tiny LLMs to enable inference using less resources</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/80_Distilling_Knowledge_into_Tiny_LLMs.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/85_Progressive_Distillation.ipynb">Progressive Distillation</a></td>
<td style="text-align: left;">Incrementally compress knowledge from a series of teachers</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/85_Progressive_Distillation.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/18_Export_and_run_models_with_ONNX.ipynb">Export and run models with ONNX</a></td>
<td style="text-align: left;">Export models with ONNX, run natively in JavaScript, Java and Rust</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/18_Export_and_run_models_with_ONNX.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/21_Export_and_run_other_machine_learning_models.ipynb">Export and run other machine learning models</a></td>
<td style="text-align: left;">Export and run models from scikit-learn, PyTorch and more</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/21_Export_and_run_other_machine_learning_models.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="api">API</h2>
<p>Run distributed txtai, integrate with the API and cloud endpoints.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/08_API_Gallery.ipynb">API Gallery</a></td>
<td style="text-align: left;">Using txtai in JavaScript, Java, Rust and Go</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/08_API_Gallery.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/15_Distributed_embeddings_cluster.ipynb">Distributed embeddings cluster</a></td>
<td style="text-align: left;">Distribute an embeddings index across multiple data nodes</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/15_Distributed_embeddings_cluster.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/43_Embeddings_in_the_Cloud.ipynb">Embeddings in the Cloud</a></td>
<td style="text-align: left;">Load and use an embeddings index from the Hugging Face Hub</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/43_Embeddings_in_the_Cloud.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/51_Custom_API_Endpoints.ipynb">Custom API Endpoints</a></td>
<td style="text-align: left;">Extend the API with custom endpoints</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/51_Custom_API_Endpoints.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/54_API_Authorization_and_Authentication.ipynb">API Authorization and Authentication</a></td>
<td style="text-align: left;">Add authorization, authentication and middleware dependencies to the API</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/54_API_Authorization_and_Authentication.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/74_OpenAI_Compatible_API.ipynb">OpenAI Compatible API</a></td>
<td style="text-align: left;">Connect to txtai with a standard OpenAI client library</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/74_OpenAI_Compatible_API.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="architecture">Architecture</h2>
<p>Project architecture, data formats, external integrations, scale to production, benchmarks, and performance.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/29_Anatomy_of_a_txtai_index.ipynb">Anatomy of a txtai index</a></td>
<td style="text-align: left;">Deep dive into the file formats behind a txtai embeddings index</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/29_Anatomy_of_a_txtai_index.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/37_Embeddings_index_components.ipynb">Embeddings components</a></td>
<td style="text-align: left;">Composable search with vector, SQL and scoring components</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/37_Embeddings_index_components.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/45_Customize_your_own_embeddings_database.ipynb">Customize your own embeddings database</a></td>
<td style="text-align: left;">Ways to combine vector indexes with relational databases</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/45_Customize_your_own_embeddings_database.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/47_Building_an_efficient_sparse_keyword_index_in_Python.ipynb">Building an efficient sparse keyword index in Python</a></td>
<td style="text-align: left;">Fast and accurate sparse keyword indexing</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/47_Building_an_efficient_sparse_keyword_index_in_Python.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/48_Benefits_of_hybrid_search.ipynb">Benefits of hybrid search</a></td>
<td style="text-align: left;">Improve accuracy with a combination of semantic and keyword search</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/48_Benefits_of_hybrid_search.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/49_External_database_integration.ipynb">External database integration</a></td>
<td style="text-align: left;">Store metadata in PostgreSQL, MariaDB, MySQL and more</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/49_External_database_integration.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/50_All_about_vector_quantization.ipynb">All about vector quantization</a></td>
<td style="text-align: left;">Benchmarking scalar and product quantization methods</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/50_All_about_vector_quantization.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/56_External_vectorization.ipynb">External vectorization</a></td>
<td style="text-align: left;">Vectorization with precomputed embeddings datasets and APIs</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/56_External_vectorization.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/61_Integrate_txtai_with_Postgres.ipynb">Integrate txtai with Postgres</a></td>
<td style="text-align: left;">Persist content, vectors and graph data in Postgres</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/61_Integrate_txtai_with_Postgres.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/64_Embeddings_index_format_for_open_data_access.ipynb">Embeddings index format for open data access</a></td>
<td style="text-align: left;">Platform and programming language independent data storage with txtai</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/64_Embeddings_index_format_for_open_data_access.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/78_Accessing_Low_Level_Vector_APIs.ipynb">Accessing Low Level Vector APIs</a></td>
<td style="text-align: left;">Build a vector database using txtai's low-level APIs</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/78_Accessing_Low_Level_Vector_APIs.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="releases">Releases</h2>
<p>New functionality added in major releases.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Notebook</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/24_Whats_new_in_txtai_4_0.ipynb">What's new in txtai 4.0</a></td>
<td style="text-align: left;">Content storage, SQL, object storage, reindex and compressed indexes</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/24_Whats_new_in_txtai_4_0.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/46_Whats_new_in_txtai_6_0.ipynb">What's new in txtai 6.0</a></td>
<td style="text-align: left;">Sparse, hybrid and subindexes for embeddings, LLM improvements</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/46_Whats_new_in_txtai_6_0.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/59_Whats_new_in_txtai_7_0.ipynb">What's new in txtai 7.0</a></td>
<td style="text-align: left;">Semantic graph 2.0, LoRA/QLoRA training and binary API support</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/59_Whats_new_in_txtai_7_0.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/67_Whats_new_in_txtai_8_0.ipynb">What's new in txtai 8.0</a></td>
<td style="text-align: left;">Agents with txtai</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/67_Whats_new_in_txtai_8_0.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/76_Whats_new_in_txtai_9_0.ipynb">What's new in txtai 9.0</a></td>
<td style="text-align: left;">Learned sparse vectors, late interaction models and rerankers</td>
<td style="text-align: right;"><a href="https://colab.research.google.com/github/neuml/txtai/blob/master/examples/76_Whats_new_in_txtai_9_0.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a></td>
</tr>
</tbody>
</table>
<h2 id="applications">Applications</h2>
<p>Series of example applications with txtai. Links to hosted versions on <a href="https://hf.co/spaces">Hugging Face Spaces</a> are also provided, when available.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Application</th>
<th style="text-align: left;">Description</th>
<th style="text-align: right;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/similarity.py">Basic similarity search</a></td>
<td style="text-align: left;">Basic similarity search example. Data from the original txtai demo.</td>
<td style="text-align: right;"><a href="https://hf.co/spaces/NeuML/similarity">🤗</a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/baseball.py">Baseball stats</a></td>
<td style="text-align: left;">Match historical baseball player stats using vector search.</td>
<td style="text-align: right;"><a href="https://hf.co/spaces/NeuML/baseball">🤗</a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/benchmarks.py">Benchmarks</a></td>
<td style="text-align: left;">Calculate performance metrics for the BEIR datasets.</td>
<td style="text-align: right;"><em>Local run only</em></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/books.py">Book search</a></td>
<td style="text-align: left;">Book similarity search application. Index book descriptions and query using natural language statements.</td>
<td style="text-align: right;"><em>Local run only</em></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/images.py">Image search</a></td>
<td style="text-align: left;">Image similarity search application. Index a directory of images and run searches to identify images similar to the input query.</td>
<td style="text-align: right;"><a href="https://hf.co/spaces/NeuML/imagesearch">🤗</a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/rag/">Retrieval Augmented Generation</a></td>
<td style="text-align: left;">RAG with txtai embeddings databases. Ask questions and get answers from LLMs bound by a context.</td>
<td style="text-align: right;"><em>Local run only</em></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/article.py">Summarize an article</a></td>
<td style="text-align: left;">Summarize an article. Workflow that extracts text from a webpage and builds a summary.</td>
<td style="text-align: right;"><a href="https://hf.co/spaces/NeuML/articlesummary">🤗</a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/wiki.py">Wiki search</a></td>
<td style="text-align: left;">Wikipedia search application. Queries Wikipedia API and summarizes the top result.</td>
<td style="text-align: right;"><a href="https://hf.co/spaces/NeuML/wikisummary">🤗</a></td>
</tr>
<tr>
<td style="text-align: left;"><a href="https://github.com/neuml/txtai/blob/master/examples/workflows.py">Workflow builder</a></td>
<td style="text-align: left;">Build and execute txtai workflows. Connect summarization, text extraction, transcription, translation and similarity search pipelines together to run unified workflows.</td>
<td style="text-align: right;"><a href="https://hf.co/spaces/NeuML/txtai">🤗</a></td>
</tr>
</tbody>
</table>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
© NeuML LLC, Apache-2.0 License
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.indexes", "navigation.instant"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "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"}, "version": null}</script>
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
</body>
</html>