mirror of https://github.com/aliasrobotics/cai.git
3701 lines
125 KiB
HTML
3701 lines
125 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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="icon" href="../../../assets/imago.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
|
|
|
|
|
|
|
|
<title>Result - CAI</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../../assets/stylesheets/main.4af4bdda.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="../../../stylesheets/extra.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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" 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="#result" 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="CAI" class="md-header__button md-logo" aria-label="CAI" data-md-component="logo">
|
|
|
|
<img src="../../../assets/imago.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">
|
|
CAI
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Result
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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/aliasrobotics/cai" 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 496 512"><!--! Font Awesome Free 6.7.2 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 2024 Fonticons, Inc.--><path d="M165.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.9M244.8 8C106.1 8 0 113.3 0 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.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.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">
|
|
aliasrobotics/cai
|
|
</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="CAI" class="md-nav__button md-logo" aria-label="CAI" data-md-component="logo">
|
|
|
|
<img src="../../../assets/imago.png" alt="logo">
|
|
|
|
</a>
|
|
CAI
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/aliasrobotics/cai" 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 496 512"><!--! Font Awesome Free 6.7.2 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 2024 Fonticons, Inc.--><path d="M165.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.9M244.8 8C106.1 8 0 113.3 0 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.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.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">
|
|
aliasrobotics/cai
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Getting Started
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../.." class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Welcome
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_installation/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Installation
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_quickstart/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quickstart
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_list_of_models/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Available Models
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_5" id="__nav_1_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Model Providers
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</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">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Model Providers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../providers/openrouter.md" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenRouter
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../providers/ollama/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Ollama
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../providers/azure.md" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Azure OpenAI
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_pro/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
🚀 CAI PRO
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Core Concepts
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Core Concepts
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_architecture/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Architecture
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tools/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tools
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../handoffs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoffs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../multi_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Systems
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Benchmarking
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Benchmarking
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/overview/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/running_benchmarks/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Running Benchmarks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/attack_defense/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Attack & Defense CTFs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/jeopardy_ctfs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Jeopardy CTFs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/cyber_ranges/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Cyber Ranges
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/knowledge_benchmarks/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Knowledge Benchmarks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../benchmarking/privacy_benchmarks/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Privacy Benchmarks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guides
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Guides
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../running_agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Running Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../continue_mode/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Continue Mode
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../results/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Working with Results
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../streaming/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Streaming
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tracing/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tracing & Debugging
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../context/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Context Management
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../guardrails/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guardrails & Security
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../environment_variables/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Environment Variables
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai/getting-started/packet_capture_wsl/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Packet Capture on WSL2
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Troubleshooting
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</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">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Troubleshooting
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai/troubleshooting/operator_feedback_reproduction/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Operator Feedback Reproduction
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai/troubleshooting/platform_limitations/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Platform Limitations
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Case Studies
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<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>
|
|
Case Studies
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai/case-studies/operator-artifact-evidence/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Operator Artifact Evidence
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Mobile UI (iOS)
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<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>
|
|
Mobile UI (iOS)
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../mui/mui_index/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../mui/getting_started/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../mui/user_interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
User Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../mui/gestures_shortcuts/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Gestures & Shortcuts
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../mui/chat_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Chat Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Terminal UI (TUI) - Deprecated
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<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>
|
|
Terminal UI (TUI) - Deprecated
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/tui_index/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/getting_started/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/user_interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
User Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/terminals_management/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Terminals Management
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/teams_and_parallel_execution/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Teams & Parallel Execution
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/sidebar_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Sidebar Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/keyboard_shortcuts/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Keyboard Shortcuts
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/commands_reference/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Commands Reference
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/advanced_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../tui/troubleshooting/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Troubleshooting
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
API Reference
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<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 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 md-toggle--indeterminate" type="checkbox" id="__nav_10_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10_1" id="__nav_10_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../run/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Runner
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tool/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tool
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../result/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Result
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../stream_events/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Stream Events
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../handoffs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoffs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../lifecycle/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Lifecycle
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../items/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Items
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../run_context/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Run Context
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../usage/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Usage
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../exceptions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Exceptions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../guardrail/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guardrail
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../model_settings/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Model Settings
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../agent_output/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent Output
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../function_schema/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Function Schema
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10_2" id="__nav_10_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Models
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Models
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../models/interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../models/openai_chatcompletions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Chat Completions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../models/openai_responses/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Responses
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10_3" id="__nav_10_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Extensions
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Extensions
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../extensions/handoff_filters/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoff Filters
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../extensions/handoff_prompt/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoff Prompt
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_11">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Advanced
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_development/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Development
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_12" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Research
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_12">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Research
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../research/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_13" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Resources
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_13">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Resources
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_faq/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
FAQ
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_find_us/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Find Us
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cai_citation_and_acknowledgments/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Citation & Acknowledgments
|
|
|
|
</span>
|
|
|
|
|
|
</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">
|
|
<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="#cai.sdk.agents.voice.result" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
result
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.voice.result.StreamedAudioResult" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
StreamedAudioResult
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="StreamedAudioResult">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.voice.result.StreamedAudioResult.__init__" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
__init__
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.voice.result.StreamedAudioResult.stream" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
stream
|
|
</span>
|
|
</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 id="result"><code>Result</code></h1>
|
|
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
|
|
|
|
<a id="cai.sdk.agents.voice.result"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.voice.result.StreamedAudioResult" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">StreamedAudioResult</span>
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
|
|
<p>The output of a <code>VoicePipeline</code>. Streams events and audio data as they're generated.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/voice/result.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 28</span>
|
|
<span class="normal"> 29</span>
|
|
<span class="normal"> 30</span>
|
|
<span class="normal"> 31</span>
|
|
<span class="normal"> 32</span>
|
|
<span class="normal"> 33</span>
|
|
<span class="normal"> 34</span>
|
|
<span class="normal"> 35</span>
|
|
<span class="normal"> 36</span>
|
|
<span class="normal"> 37</span>
|
|
<span class="normal"> 38</span>
|
|
<span class="normal"> 39</span>
|
|
<span class="normal"> 40</span>
|
|
<span class="normal"> 41</span>
|
|
<span class="normal"> 42</span>
|
|
<span class="normal"> 43</span>
|
|
<span class="normal"> 44</span>
|
|
<span class="normal"> 45</span>
|
|
<span class="normal"> 46</span>
|
|
<span class="normal"> 47</span>
|
|
<span class="normal"> 48</span>
|
|
<span class="normal"> 49</span>
|
|
<span class="normal"> 50</span>
|
|
<span class="normal"> 51</span>
|
|
<span class="normal"> 52</span>
|
|
<span class="normal"> 53</span>
|
|
<span class="normal"> 54</span>
|
|
<span class="normal"> 55</span>
|
|
<span class="normal"> 56</span>
|
|
<span class="normal"> 57</span>
|
|
<span class="normal"> 58</span>
|
|
<span class="normal"> 59</span>
|
|
<span class="normal"> 60</span>
|
|
<span class="normal"> 61</span>
|
|
<span class="normal"> 62</span>
|
|
<span class="normal"> 63</span>
|
|
<span class="normal"> 64</span>
|
|
<span class="normal"> 65</span>
|
|
<span class="normal"> 66</span>
|
|
<span class="normal"> 67</span>
|
|
<span class="normal"> 68</span>
|
|
<span class="normal"> 69</span>
|
|
<span class="normal"> 70</span>
|
|
<span class="normal"> 71</span>
|
|
<span class="normal"> 72</span>
|
|
<span class="normal"> 73</span>
|
|
<span class="normal"> 74</span>
|
|
<span class="normal"> 75</span>
|
|
<span class="normal"> 76</span>
|
|
<span class="normal"> 77</span>
|
|
<span class="normal"> 78</span>
|
|
<span class="normal"> 79</span>
|
|
<span class="normal"> 80</span>
|
|
<span class="normal"> 81</span>
|
|
<span class="normal"> 82</span>
|
|
<span class="normal"> 83</span>
|
|
<span class="normal"> 84</span>
|
|
<span class="normal"> 85</span>
|
|
<span class="normal"> 86</span>
|
|
<span class="normal"> 87</span>
|
|
<span class="normal"> 88</span>
|
|
<span class="normal"> 89</span>
|
|
<span class="normal"> 90</span>
|
|
<span class="normal"> 91</span>
|
|
<span class="normal"> 92</span>
|
|
<span class="normal"> 93</span>
|
|
<span class="normal"> 94</span>
|
|
<span class="normal"> 95</span>
|
|
<span class="normal"> 96</span>
|
|
<span class="normal"> 97</span>
|
|
<span class="normal"> 98</span>
|
|
<span class="normal"> 99</span>
|
|
<span class="normal">100</span>
|
|
<span class="normal">101</span>
|
|
<span class="normal">102</span>
|
|
<span class="normal">103</span>
|
|
<span class="normal">104</span>
|
|
<span class="normal">105</span>
|
|
<span class="normal">106</span>
|
|
<span class="normal">107</span>
|
|
<span class="normal">108</span>
|
|
<span class="normal">109</span>
|
|
<span class="normal">110</span>
|
|
<span class="normal">111</span>
|
|
<span class="normal">112</span>
|
|
<span class="normal">113</span>
|
|
<span class="normal">114</span>
|
|
<span class="normal">115</span>
|
|
<span class="normal">116</span>
|
|
<span class="normal">117</span>
|
|
<span class="normal">118</span>
|
|
<span class="normal">119</span>
|
|
<span class="normal">120</span>
|
|
<span class="normal">121</span>
|
|
<span class="normal">122</span>
|
|
<span class="normal">123</span>
|
|
<span class="normal">124</span>
|
|
<span class="normal">125</span>
|
|
<span class="normal">126</span>
|
|
<span class="normal">127</span>
|
|
<span class="normal">128</span>
|
|
<span class="normal">129</span>
|
|
<span class="normal">130</span>
|
|
<span class="normal">131</span>
|
|
<span class="normal">132</span>
|
|
<span class="normal">133</span>
|
|
<span class="normal">134</span>
|
|
<span class="normal">135</span>
|
|
<span class="normal">136</span>
|
|
<span class="normal">137</span>
|
|
<span class="normal">138</span>
|
|
<span class="normal">139</span>
|
|
<span class="normal">140</span>
|
|
<span class="normal">141</span>
|
|
<span class="normal">142</span>
|
|
<span class="normal">143</span>
|
|
<span class="normal">144</span>
|
|
<span class="normal">145</span>
|
|
<span class="normal">146</span>
|
|
<span class="normal">147</span>
|
|
<span class="normal">148</span>
|
|
<span class="normal">149</span>
|
|
<span class="normal">150</span>
|
|
<span class="normal">151</span>
|
|
<span class="normal">152</span>
|
|
<span class="normal">153</span>
|
|
<span class="normal">154</span>
|
|
<span class="normal">155</span>
|
|
<span class="normal">156</span>
|
|
<span class="normal">157</span>
|
|
<span class="normal">158</span>
|
|
<span class="normal">159</span>
|
|
<span class="normal">160</span>
|
|
<span class="normal">161</span>
|
|
<span class="normal">162</span>
|
|
<span class="normal">163</span>
|
|
<span class="normal">164</span>
|
|
<span class="normal">165</span>
|
|
<span class="normal">166</span>
|
|
<span class="normal">167</span>
|
|
<span class="normal">168</span>
|
|
<span class="normal">169</span>
|
|
<span class="normal">170</span>
|
|
<span class="normal">171</span>
|
|
<span class="normal">172</span>
|
|
<span class="normal">173</span>
|
|
<span class="normal">174</span>
|
|
<span class="normal">175</span>
|
|
<span class="normal">176</span>
|
|
<span class="normal">177</span>
|
|
<span class="normal">178</span>
|
|
<span class="normal">179</span>
|
|
<span class="normal">180</span>
|
|
<span class="normal">181</span>
|
|
<span class="normal">182</span>
|
|
<span class="normal">183</span>
|
|
<span class="normal">184</span>
|
|
<span class="normal">185</span>
|
|
<span class="normal">186</span>
|
|
<span class="normal">187</span>
|
|
<span class="normal">188</span>
|
|
<span class="normal">189</span>
|
|
<span class="normal">190</span>
|
|
<span class="normal">191</span>
|
|
<span class="normal">192</span>
|
|
<span class="normal">193</span>
|
|
<span class="normal">194</span>
|
|
<span class="normal">195</span>
|
|
<span class="normal">196</span>
|
|
<span class="normal">197</span>
|
|
<span class="normal">198</span>
|
|
<span class="normal">199</span>
|
|
<span class="normal">200</span>
|
|
<span class="normal">201</span>
|
|
<span class="normal">202</span>
|
|
<span class="normal">203</span>
|
|
<span class="normal">204</span>
|
|
<span class="normal">205</span>
|
|
<span class="normal">206</span>
|
|
<span class="normal">207</span>
|
|
<span class="normal">208</span>
|
|
<span class="normal">209</span>
|
|
<span class="normal">210</span>
|
|
<span class="normal">211</span>
|
|
<span class="normal">212</span>
|
|
<span class="normal">213</span>
|
|
<span class="normal">214</span>
|
|
<span class="normal">215</span>
|
|
<span class="normal">216</span>
|
|
<span class="normal">217</span>
|
|
<span class="normal">218</span>
|
|
<span class="normal">219</span>
|
|
<span class="normal">220</span>
|
|
<span class="normal">221</span>
|
|
<span class="normal">222</span>
|
|
<span class="normal">223</span>
|
|
<span class="normal">224</span>
|
|
<span class="normal">225</span>
|
|
<span class="normal">226</span>
|
|
<span class="normal">227</span>
|
|
<span class="normal">228</span>
|
|
<span class="normal">229</span>
|
|
<span class="normal">230</span>
|
|
<span class="normal">231</span>
|
|
<span class="normal">232</span>
|
|
<span class="normal">233</span>
|
|
<span class="normal">234</span>
|
|
<span class="normal">235</span>
|
|
<span class="normal">236</span>
|
|
<span class="normal">237</span>
|
|
<span class="normal">238</span>
|
|
<span class="normal">239</span>
|
|
<span class="normal">240</span>
|
|
<span class="normal">241</span>
|
|
<span class="normal">242</span>
|
|
<span class="normal">243</span>
|
|
<span class="normal">244</span>
|
|
<span class="normal">245</span>
|
|
<span class="normal">246</span>
|
|
<span class="normal">247</span>
|
|
<span class="normal">248</span>
|
|
<span class="normal">249</span>
|
|
<span class="normal">250</span>
|
|
<span class="normal">251</span>
|
|
<span class="normal">252</span>
|
|
<span class="normal">253</span>
|
|
<span class="normal">254</span>
|
|
<span class="normal">255</span>
|
|
<span class="normal">256</span>
|
|
<span class="normal">257</span>
|
|
<span class="normal">258</span>
|
|
<span class="normal">259</span>
|
|
<span class="normal">260</span>
|
|
<span class="normal">261</span>
|
|
<span class="normal">262</span>
|
|
<span class="normal">263</span>
|
|
<span class="normal">264</span>
|
|
<span class="normal">265</span>
|
|
<span class="normal">266</span>
|
|
<span class="normal">267</span>
|
|
<span class="normal">268</span>
|
|
<span class="normal">269</span>
|
|
<span class="normal">270</span>
|
|
<span class="normal">271</span>
|
|
<span class="normal">272</span>
|
|
<span class="normal">273</span>
|
|
<span class="normal">274</span>
|
|
<span class="normal">275</span>
|
|
<span class="normal">276</span>
|
|
<span class="normal">277</span>
|
|
<span class="normal">278</span>
|
|
<span class="normal">279</span>
|
|
<span class="normal">280</span>
|
|
<span class="normal">281</span>
|
|
<span class="normal">282</span>
|
|
<span class="normal">283</span>
|
|
<span class="normal">284</span>
|
|
<span class="normal">285</span>
|
|
<span class="normal">286</span>
|
|
<span class="normal">287</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-28"><span class="k">class</span><span class="w"> </span><span class="nc">StreamedAudioResult</span><span class="p">:</span>
|
|
</span><span id="__span-0-29"><span class="w"> </span><span class="sd">"""The output of a `VoicePipeline`. Streams events and audio data as they're generated."""</span>
|
|
</span><span id="__span-0-30">
|
|
</span><span id="__span-0-31"> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
</span><span id="__span-0-32"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-33"> <span class="n">tts_model</span><span class="p">:</span> <span class="n">TTSModel</span><span class="p">,</span>
|
|
</span><span id="__span-0-34"> <span class="n">tts_settings</span><span class="p">:</span> <span class="n">TTSModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-35"> <span class="n">voice_pipeline_config</span><span class="p">:</span> <span class="n">VoicePipelineConfig</span><span class="p">,</span>
|
|
</span><span id="__span-0-36"> <span class="p">):</span>
|
|
</span><span id="__span-0-37"><span class="w"> </span><span class="sd">"""Create a new `StreamedAudioResult` instance.</span>
|
|
</span><span id="__span-0-38">
|
|
</span><span id="__span-0-39"><span class="sd"> Args:</span>
|
|
</span><span id="__span-0-40"><span class="sd"> tts_model: The TTS model to use.</span>
|
|
</span><span id="__span-0-41"><span class="sd"> tts_settings: The TTS settings to use.</span>
|
|
</span><span id="__span-0-42"><span class="sd"> voice_pipeline_config: The voice pipeline config to use.</span>
|
|
</span><span id="__span-0-43"><span class="sd"> """</span>
|
|
</span><span id="__span-0-44"> <span class="bp">self</span><span class="o">.</span><span class="n">tts_model</span> <span class="o">=</span> <span class="n">tts_model</span>
|
|
</span><span id="__span-0-45"> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span> <span class="o">=</span> <span class="n">tts_settings</span>
|
|
</span><span id="__span-0-46"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-47"> <span class="bp">self</span><span class="o">.</span><span class="n">instructions</span> <span class="o">=</span> <span class="n">tts_settings</span><span class="o">.</span><span class="n">instructions</span>
|
|
</span><span id="__span-0-48"> <span class="bp">self</span><span class="o">.</span><span class="n">text_generation_task</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-49">
|
|
</span><span id="__span-0-50"> <span class="bp">self</span><span class="o">.</span><span class="n">_voice_pipeline_config</span> <span class="o">=</span> <span class="n">voice_pipeline_config</span>
|
|
</span><span id="__span-0-51"> <span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-52"> <span class="bp">self</span><span class="o">.</span><span class="n">_turn_text_buffer</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-53"> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span><span class="p">]</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span>
|
|
</span><span id="__span-0-54"> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-55"> <span class="bp">self</span><span class="o">.</span><span class="n">_ordered_tasks</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span>
|
|
</span><span id="__span-0-56"> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span>
|
|
</span><span id="__span-0-57"> <span class="p">]</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># New: list to hold local queues for each text segment</span>
|
|
</span><span id="__span-0-58"> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="p">(</span>
|
|
</span><span id="__span-0-59"> <span class="kc">None</span> <span class="c1"># Task to dispatch audio chunks in order</span>
|
|
</span><span id="__span-0-60"> <span class="p">)</span>
|
|
</span><span id="__span-0-61">
|
|
</span><span id="__span-0-62"> <span class="bp">self</span><span class="o">.</span><span class="n">_done_processing</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-63"> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer_size</span> <span class="o">=</span> <span class="n">tts_settings</span><span class="o">.</span><span class="n">buffer_size</span>
|
|
</span><span id="__span-0-64"> <span class="bp">self</span><span class="o">.</span><span class="n">_started_processing_turn</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-65"> <span class="bp">self</span><span class="o">.</span><span class="n">_first_byte_received</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-66"> <span class="bp">self</span><span class="o">.</span><span class="n">_generation_start_time</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-67"> <span class="bp">self</span><span class="o">.</span><span class="n">_completed_session</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-68"> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-69"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="p">:</span> <span class="n">Span</span><span class="p">[</span><span class="n">SpeechGroupSpanData</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-70">
|
|
</span><span id="__span-0-71"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_start_turn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-72"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_started_processing_turn</span><span class="p">:</span>
|
|
</span><span id="__span-0-73"> <span class="k">return</span>
|
|
</span><span id="__span-0-74">
|
|
</span><span id="__span-0-75"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span> <span class="o">=</span> <span class="n">speech_group_span</span><span class="p">()</span>
|
|
</span><span id="__span-0-76"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
|
|
</span><span id="__span-0-77"> <span class="bp">self</span><span class="o">.</span><span class="n">_started_processing_turn</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</span><span id="__span-0-78"> <span class="bp">self</span><span class="o">.</span><span class="n">_first_byte_received</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-79"> <span class="bp">self</span><span class="o">.</span><span class="n">_generation_start_time</span> <span class="o">=</span> <span class="n">time_iso</span><span class="p">()</span>
|
|
</span><span id="__span-0-80"> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">VoiceStreamEventLifecycle</span><span class="p">(</span><span class="n">event</span><span class="o">=</span><span class="s2">"turn_started"</span><span class="p">))</span>
|
|
</span><span id="__span-0-81">
|
|
</span><span id="__span-0-82"> <span class="k">def</span><span class="w"> </span><span class="nf">_set_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]):</span>
|
|
</span><span id="__span-0-83"> <span class="bp">self</span><span class="o">.</span><span class="n">text_generation_task</span> <span class="o">=</span> <span class="n">task</span>
|
|
</span><span id="__span-0-84">
|
|
</span><span id="__span-0-85"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_add_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">error</span><span class="p">:</span> <span class="ne">Exception</span><span class="p">):</span>
|
|
</span><span id="__span-0-86"> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">VoiceStreamEventError</span><span class="p">(</span><span class="n">error</span><span class="p">))</span>
|
|
</span><span id="__span-0-87">
|
|
</span><span id="__span-0-88"> <span class="k">def</span><span class="w"> </span><span class="nf">_transform_audio_buffer</span><span class="p">(</span>
|
|
</span><span id="__span-0-89"> <span class="bp">self</span><span class="p">,</span> <span class="n">buffer</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">bytes</span><span class="p">],</span> <span class="n">output_dtype</span><span class="p">:</span> <span class="n">npt</span><span class="o">.</span><span class="n">DTypeLike</span>
|
|
</span><span id="__span-0-90"> <span class="p">)</span> <span class="o">-></span> <span class="n">npt</span><span class="o">.</span><span class="n">NDArray</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">int16</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">]:</span>
|
|
</span><span id="__span-0-91"> <span class="n">np_array</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">frombuffer</span><span class="p">(</span><span class="sa">b</span><span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">buffer</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">int16</span><span class="p">)</span>
|
|
</span><span id="__span-0-92">
|
|
</span><span id="__span-0-93"> <span class="k">if</span> <span class="n">output_dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">int16</span><span class="p">:</span>
|
|
</span><span id="__span-0-94"> <span class="k">return</span> <span class="n">np_array</span>
|
|
</span><span id="__span-0-95"> <span class="k">elif</span> <span class="n">output_dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">:</span>
|
|
</span><span id="__span-0-96"> <span class="k">return</span> <span class="p">(</span><span class="n">np_array</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="o">/</span> <span class="mf">32767.0</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
|
</span><span id="__span-0-97"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-98"> <span class="k">raise</span> <span class="n">UserError</span><span class="p">(</span><span class="s2">"Invalid output dtype"</span><span class="p">)</span>
|
|
</span><span id="__span-0-99">
|
|
</span><span id="__span-0-100"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_stream_audio</span><span class="p">(</span>
|
|
</span><span id="__span-0-101"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-102"> <span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
</span><span id="__span-0-103"> <span class="n">local_queue</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span> <span class="o">|</span> <span class="kc">None</span><span class="p">],</span>
|
|
</span><span id="__span-0-104"> <span class="n">finish_turn</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-0-105"> <span class="p">):</span>
|
|
</span><span id="__span-0-106"> <span class="k">with</span> <span class="n">speech_span</span><span class="p">(</span>
|
|
</span><span id="__span-0-107"> <span class="n">model</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tts_model</span><span class="o">.</span><span class="n">model_name</span><span class="p">,</span>
|
|
</span><span id="__span-0-108"> <span class="nb">input</span><span class="o">=</span><span class="n">text</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_voice_pipeline_config</span><span class="o">.</span><span class="n">trace_include_sensitive_data</span> <span class="k">else</span> <span class="s2">""</span><span class="p">,</span>
|
|
</span><span id="__span-0-109"> <span class="n">model_config</span><span class="o">=</span><span class="p">{</span>
|
|
</span><span id="__span-0-110"> <span class="s2">"voice"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">voice</span><span class="p">,</span>
|
|
</span><span id="__span-0-111"> <span class="s2">"instructions"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">instructions</span><span class="p">,</span>
|
|
</span><span id="__span-0-112"> <span class="s2">"speed"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">speed</span><span class="p">,</span>
|
|
</span><span id="__span-0-113"> <span class="p">},</span>
|
|
</span><span id="__span-0-114"> <span class="n">output_format</span><span class="o">=</span><span class="s2">"pcm"</span><span class="p">,</span>
|
|
</span><span id="__span-0-115"> <span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="p">,</span>
|
|
</span><span id="__span-0-116"> <span class="p">)</span> <span class="k">as</span> <span class="n">tts_span</span><span class="p">:</span>
|
|
</span><span id="__span-0-117"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-118"> <span class="n">first_byte_received</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-119"> <span class="n">buffer</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-120"> <span class="n">full_audio_data</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-121">
|
|
</span><span id="__span-0-122"> <span class="k">async</span> <span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_model</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="p">):</span>
|
|
</span><span id="__span-0-123"> <span class="k">if</span> <span class="ow">not</span> <span class="n">first_byte_received</span><span class="p">:</span>
|
|
</span><span id="__span-0-124"> <span class="n">first_byte_received</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</span><span id="__span-0-125"> <span class="n">tts_span</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">first_content_at</span> <span class="o">=</span> <span class="n">time_iso</span><span class="p">()</span>
|
|
</span><span id="__span-0-126">
|
|
</span><span id="__span-0-127"> <span class="k">if</span> <span class="n">chunk</span><span class="p">:</span>
|
|
</span><span id="__span-0-128"> <span class="n">buffer</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
|
|
</span><span id="__span-0-129"> <span class="n">full_audio_data</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
|
|
</span><span id="__span-0-130"> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">buffer</span><span class="p">)</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer_size</span><span class="p">:</span>
|
|
</span><span id="__span-0-131"> <span class="n">audio_np</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transform_audio_buffer</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
|
|
</span><span id="__span-0-132"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">transform_data</span><span class="p">:</span>
|
|
</span><span id="__span-0-133"> <span class="n">audio_np</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">transform_data</span><span class="p">(</span><span class="n">audio_np</span><span class="p">)</span>
|
|
</span><span id="__span-0-134"> <span class="k">await</span> <span class="n">local_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span>
|
|
</span><span id="__span-0-135"> <span class="n">VoiceStreamEventAudio</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">audio_np</span><span class="p">)</span>
|
|
</span><span id="__span-0-136"> <span class="p">)</span> <span class="c1"># Use local queue</span>
|
|
</span><span id="__span-0-137"> <span class="n">buffer</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-138"> <span class="k">if</span> <span class="n">buffer</span><span class="p">:</span>
|
|
</span><span id="__span-0-139"> <span class="n">audio_np</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transform_audio_buffer</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
|
|
</span><span id="__span-0-140"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">transform_data</span><span class="p">:</span>
|
|
</span><span id="__span-0-141"> <span class="n">audio_np</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">transform_data</span><span class="p">(</span><span class="n">audio_np</span><span class="p">)</span>
|
|
</span><span id="__span-0-142"> <span class="k">await</span> <span class="n">local_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">VoiceStreamEventAudio</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">audio_np</span><span class="p">))</span> <span class="c1"># Use local queue</span>
|
|
</span><span id="__span-0-143">
|
|
</span><span id="__span-0-144"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_voice_pipeline_config</span><span class="o">.</span><span class="n">trace_include_sensitive_audio_data</span><span class="p">:</span>
|
|
</span><span id="__span-0-145"> <span class="n">tts_span</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">_audio_to_base64</span><span class="p">(</span><span class="n">full_audio_data</span><span class="p">)</span>
|
|
</span><span id="__span-0-146"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-147"> <span class="n">tts_span</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-148">
|
|
</span><span id="__span-0-149"> <span class="k">if</span> <span class="n">finish_turn</span><span class="p">:</span>
|
|
</span><span id="__span-0-150"> <span class="k">await</span> <span class="n">local_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">VoiceStreamEventLifecycle</span><span class="p">(</span><span class="n">event</span><span class="o">=</span><span class="s2">"turn_ended"</span><span class="p">))</span>
|
|
</span><span id="__span-0-151"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-152"> <span class="k">await</span> <span class="n">local_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># Signal completion for this segment</span>
|
|
</span><span id="__span-0-153"> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
</span><span id="__span-0-154"> <span class="n">tts_span</span><span class="o">.</span><span class="n">set_error</span><span class="p">(</span>
|
|
</span><span id="__span-0-155"> <span class="p">{</span>
|
|
</span><span id="__span-0-156"> <span class="s2">"message"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span>
|
|
</span><span id="__span-0-157"> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-0-158"> <span class="s2">"text"</span><span class="p">:</span> <span class="n">text</span>
|
|
</span><span id="__span-0-159"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_voice_pipeline_config</span><span class="o">.</span><span class="n">trace_include_sensitive_data</span>
|
|
</span><span id="__span-0-160"> <span class="k">else</span> <span class="s2">""</span><span class="p">,</span>
|
|
</span><span id="__span-0-161"> <span class="p">},</span>
|
|
</span><span id="__span-0-162"> <span class="p">}</span>
|
|
</span><span id="__span-0-163"> <span class="p">)</span>
|
|
</span><span id="__span-0-164"> <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error streaming audio: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-0-165">
|
|
</span><span id="__span-0-166"> <span class="c1"># Signal completion for whole session because of error</span>
|
|
</span><span id="__span-0-167"> <span class="k">await</span> <span class="n">local_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">VoiceStreamEventLifecycle</span><span class="p">(</span><span class="n">event</span><span class="o">=</span><span class="s2">"session_ended"</span><span class="p">))</span>
|
|
</span><span id="__span-0-168"> <span class="k">raise</span> <span class="n">e</span>
|
|
</span><span id="__span-0-169">
|
|
</span><span id="__span-0-170"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_add_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
|
</span><span id="__span-0-171"> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_turn</span><span class="p">()</span>
|
|
</span><span id="__span-0-172">
|
|
</span><span id="__span-0-173"> <span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span> <span class="o">+=</span> <span class="n">text</span>
|
|
</span><span id="__span-0-174"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_text</span> <span class="o">+=</span> <span class="n">text</span>
|
|
</span><span id="__span-0-175"> <span class="bp">self</span><span class="o">.</span><span class="n">_turn_text_buffer</span> <span class="o">+=</span> <span class="n">text</span>
|
|
</span><span id="__span-0-176">
|
|
</span><span id="__span-0-177"> <span class="n">combined_sentences</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span><span class="o">.</span><span class="n">text_splitter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span><span class="p">)</span>
|
|
</span><span id="__span-0-178">
|
|
</span><span id="__span-0-179"> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">combined_sentences</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">20</span><span class="p">:</span>
|
|
</span><span id="__span-0-180"> <span class="n">local_queue</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span>
|
|
</span><span id="__span-0-181"> <span class="bp">self</span><span class="o">.</span><span class="n">_ordered_tasks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">local_queue</span><span class="p">)</span>
|
|
</span><span id="__span-0-182"> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
|
</span><span id="__span-0-183"> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_stream_audio</span><span class="p">(</span><span class="n">combined_sentences</span><span class="p">,</span> <span class="n">local_queue</span><span class="p">))</span>
|
|
</span><span id="__span-0-184"> <span class="p">)</span>
|
|
</span><span id="__span-0-185"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-186"> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dispatch_audio</span><span class="p">())</span>
|
|
</span><span id="__span-0-187">
|
|
</span><span id="__span-0-188"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_turn_done</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-189"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span><span class="p">:</span>
|
|
</span><span id="__span-0-190"> <span class="n">local_queue</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span>
|
|
</span><span id="__span-0-191"> <span class="bp">self</span><span class="o">.</span><span class="n">_ordered_tasks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">local_queue</span><span class="p">)</span> <span class="c1"># Append the local queue for the final segment</span>
|
|
</span><span id="__span-0-192"> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
|
</span><span id="__span-0-193"> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span>
|
|
</span><span id="__span-0-194"> <span class="bp">self</span><span class="o">.</span><span class="n">_stream_audio</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span><span class="p">,</span> <span class="n">local_queue</span><span class="p">,</span> <span class="n">finish_turn</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
</span><span id="__span-0-195"> <span class="p">)</span>
|
|
</span><span id="__span-0-196"> <span class="p">)</span>
|
|
</span><span id="__span-0-197"> <span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-198"> <span class="bp">self</span><span class="o">.</span><span class="n">_done_processing</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</span><span id="__span-0-199"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-200"> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dispatch_audio</span><span class="p">())</span>
|
|
</span><span id="__span-0-201"> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">gather</span><span class="p">(</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="p">)</span>
|
|
</span><span id="__span-0-202">
|
|
</span><span id="__span-0-203"> <span class="k">def</span><span class="w"> </span><span class="nf">_finish_turn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-204"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="p">:</span>
|
|
</span><span id="__span-0-205"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_voice_pipeline_config</span><span class="o">.</span><span class="n">trace_include_sensitive_data</span><span class="p">:</span>
|
|
</span><span id="__span-0-206"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">input</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_turn_text_buffer</span>
|
|
</span><span id="__span-0-207"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-208"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">input</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-209">
|
|
</span><span id="__span-0-210"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
|
|
</span><span id="__span-0-211"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-212"> <span class="bp">self</span><span class="o">.</span><span class="n">_turn_text_buffer</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-213"> <span class="bp">self</span><span class="o">.</span><span class="n">_started_processing_turn</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-214">
|
|
</span><span id="__span-0-215"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_done</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-216"> <span class="bp">self</span><span class="o">.</span><span class="n">_completed_session</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</span><span id="__span-0-217"> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_completion</span><span class="p">()</span>
|
|
</span><span id="__span-0-218">
|
|
</span><span id="__span-0-219"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_dispatch_audio</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-220"> <span class="c1"># Dispatch audio chunks from each segment in the order they were added</span>
|
|
</span><span id="__span-0-221"> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
|
|
</span><span id="__span-0-222"> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ordered_tasks</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
|
</span><span id="__span-0-223"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_completed_session</span><span class="p">:</span>
|
|
</span><span id="__span-0-224"> <span class="k">break</span>
|
|
</span><span id="__span-0-225"> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-226"> <span class="k">continue</span>
|
|
</span><span id="__span-0-227"> <span class="n">local_queue</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ordered_tasks</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-228"> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
|
|
</span><span id="__span-0-229"> <span class="n">chunk</span> <span class="o">=</span> <span class="k">await</span> <span class="n">local_queue</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
|
|
</span><span id="__span-0-230"> <span class="k">if</span> <span class="n">chunk</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-231"> <span class="k">break</span>
|
|
</span><span id="__span-0-232"> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
|
|
</span><span id="__span-0-233"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">chunk</span><span class="p">,</span> <span class="n">VoiceStreamEventLifecycle</span><span class="p">):</span>
|
|
</span><span id="__span-0-234"> <span class="n">local_queue</span><span class="o">.</span><span class="n">task_done</span><span class="p">()</span>
|
|
</span><span id="__span-0-235"> <span class="k">if</span> <span class="n">chunk</span><span class="o">.</span><span class="n">event</span> <span class="o">==</span> <span class="s2">"turn_ended"</span><span class="p">:</span>
|
|
</span><span id="__span-0-236"> <span class="bp">self</span><span class="o">.</span><span class="n">_finish_turn</span><span class="p">()</span>
|
|
</span><span id="__span-0-237"> <span class="k">break</span>
|
|
</span><span id="__span-0-238"> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">VoiceStreamEventLifecycle</span><span class="p">(</span><span class="n">event</span><span class="o">=</span><span class="s2">"session_ended"</span><span class="p">))</span>
|
|
</span><span id="__span-0-239">
|
|
</span><span id="__span-0-240"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_wait_for_completion</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-241"> <span class="n">tasks</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span>
|
|
</span><span id="__span-0-242"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-243"> <span class="n">tasks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span><span class="p">)</span>
|
|
</span><span id="__span-0-244"> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">gather</span><span class="p">(</span><span class="o">*</span><span class="n">tasks</span><span class="p">)</span>
|
|
</span><span id="__span-0-245">
|
|
</span><span id="__span-0-246"> <span class="k">def</span><span class="w"> </span><span class="nf">_cleanup_tasks</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-247"> <span class="bp">self</span><span class="o">.</span><span class="n">_finish_turn</span><span class="p">()</span>
|
|
</span><span id="__span-0-248">
|
|
</span><span id="__span-0-249"> <span class="k">for</span> <span class="n">task</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="p">:</span>
|
|
</span><span id="__span-0-250"> <span class="k">if</span> <span class="ow">not</span> <span class="n">task</span><span class="o">.</span><span class="n">done</span><span class="p">():</span>
|
|
</span><span id="__span-0-251"> <span class="n">task</span><span class="o">.</span><span class="n">cancel</span><span class="p">()</span>
|
|
</span><span id="__span-0-252">
|
|
</span><span id="__span-0-253"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span><span class="o">.</span><span class="n">done</span><span class="p">():</span>
|
|
</span><span id="__span-0-254"> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span><span class="o">.</span><span class="n">cancel</span><span class="p">()</span>
|
|
</span><span id="__span-0-255">
|
|
</span><span id="__span-0-256"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">text_generation_task</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">text_generation_task</span><span class="o">.</span><span class="n">done</span><span class="p">():</span>
|
|
</span><span id="__span-0-257"> <span class="bp">self</span><span class="o">.</span><span class="n">text_generation_task</span><span class="o">.</span><span class="n">cancel</span><span class="p">()</span>
|
|
</span><span id="__span-0-258">
|
|
</span><span id="__span-0-259"> <span class="k">def</span><span class="w"> </span><span class="nf">_check_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
</span><span id="__span-0-260"> <span class="k">for</span> <span class="n">task</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="p">:</span>
|
|
</span><span id="__span-0-261"> <span class="k">if</span> <span class="n">task</span><span class="o">.</span><span class="n">done</span><span class="p">():</span>
|
|
</span><span id="__span-0-262"> <span class="k">if</span> <span class="n">task</span><span class="o">.</span><span class="n">exception</span><span class="p">():</span>
|
|
</span><span id="__span-0-263"> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span> <span class="o">=</span> <span class="n">task</span><span class="o">.</span><span class="n">exception</span><span class="p">()</span>
|
|
</span><span id="__span-0-264"> <span class="k">break</span>
|
|
</span><span id="__span-0-265">
|
|
</span><span id="__span-0-266"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">stream</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncIterator</span><span class="p">[</span><span class="n">VoiceStreamEvent</span><span class="p">]:</span>
|
|
</span><span id="__span-0-267"><span class="w"> </span><span class="sd">"""Stream the events and audio data as they're generated."""</span>
|
|
</span><span id="__span-0-268"> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
|
|
</span><span id="__span-0-269"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-270"> <span class="n">event</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
|
|
</span><span id="__span-0-271"> <span class="k">except</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">CancelledError</span><span class="p">:</span>
|
|
</span><span id="__span-0-272"> <span class="k">break</span>
|
|
</span><span id="__span-0-273"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">VoiceStreamEventError</span><span class="p">):</span>
|
|
</span><span id="__span-0-274"> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">error</span>
|
|
</span><span id="__span-0-275"> <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error processing output: </span><span class="si">{</span><span class="n">event</span><span class="o">.</span><span class="n">error</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-0-276"> <span class="k">break</span>
|
|
</span><span id="__span-0-277"> <span class="k">if</span> <span class="n">event</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-278"> <span class="k">break</span>
|
|
</span><span id="__span-0-279"> <span class="k">yield</span> <span class="n">event</span>
|
|
</span><span id="__span-0-280"> <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s2">"voice_stream_event_lifecycle"</span> <span class="ow">and</span> <span class="n">event</span><span class="o">.</span><span class="n">event</span> <span class="o">==</span> <span class="s2">"session_ended"</span><span class="p">:</span>
|
|
</span><span id="__span-0-281"> <span class="k">break</span>
|
|
</span><span id="__span-0-282">
|
|
</span><span id="__span-0-283"> <span class="bp">self</span><span class="o">.</span><span class="n">_check_errors</span><span class="p">()</span>
|
|
</span><span id="__span-0-284"> <span class="bp">self</span><span class="o">.</span><span class="n">_cleanup_tasks</span><span class="p">()</span>
|
|
</span><span id="__span-0-285">
|
|
</span><span id="__span-0-286"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-287"> <span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.voice.result.StreamedAudioResult.__init__" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">__init__</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="fm">__init__</span><span class="p">(</span>
|
|
</span><span id="__span-0-2"> <span class="nf">tts_model</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="TTSModel (cai.sdk.agents.voice.model.TTSModel)" href="../model/#cai.sdk.agents.voice.model.TTSModel">TTSModel</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-3"> <span class="n">tts_settings</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="TTSModelSettings
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.voice.model.TTSModelSettings)" href="../model/#cai.sdk.agents.voice.model.TTSModelSettings">TTSModelSettings</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-4"> <span class="n">voice_pipeline_config</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="VoicePipelineConfig
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.voice.pipeline_config.VoicePipelineConfig)" href="../pipeline_config/#cai.sdk.agents.voice.pipeline_config.VoicePipelineConfig">VoicePipelineConfig</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-5"><span class="p">)</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Create a new <code>StreamedAudioResult</code> instance.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<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>tts_model</code>
|
|
</td>
|
|
<td>
|
|
<code><a class="autorefs autorefs-internal" title="TTSModel (cai.sdk.agents.voice.model.TTSModel)" href="../model/#cai.sdk.agents.voice.model.TTSModel">TTSModel</a></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>The TTS model to use.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>tts_settings</code>
|
|
</td>
|
|
<td>
|
|
<code><a class="autorefs autorefs-internal" title="TTSModelSettings
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.voice.model.TTSModelSettings)" href="../model/#cai.sdk.agents.voice.model.TTSModelSettings">TTSModelSettings</a></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>The TTS settings to use.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>voice_pipeline_config</code>
|
|
</td>
|
|
<td>
|
|
<code><a class="autorefs autorefs-internal" title="VoicePipelineConfig
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.voice.pipeline_config.VoicePipelineConfig)" href="../pipeline_config/#cai.sdk.agents.voice.pipeline_config.VoicePipelineConfig">VoicePipelineConfig</a></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>The voice pipeline config to use.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/voice/result.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">31</span>
|
|
<span class="normal">32</span>
|
|
<span class="normal">33</span>
|
|
<span class="normal">34</span>
|
|
<span class="normal">35</span>
|
|
<span class="normal">36</span>
|
|
<span class="normal">37</span>
|
|
<span class="normal">38</span>
|
|
<span class="normal">39</span>
|
|
<span class="normal">40</span>
|
|
<span class="normal">41</span>
|
|
<span class="normal">42</span>
|
|
<span class="normal">43</span>
|
|
<span class="normal">44</span>
|
|
<span class="normal">45</span>
|
|
<span class="normal">46</span>
|
|
<span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span>
|
|
<span class="normal">57</span>
|
|
<span class="normal">58</span>
|
|
<span class="normal">59</span>
|
|
<span class="normal">60</span>
|
|
<span class="normal">61</span>
|
|
<span class="normal">62</span>
|
|
<span class="normal">63</span>
|
|
<span class="normal">64</span>
|
|
<span class="normal">65</span>
|
|
<span class="normal">66</span>
|
|
<span class="normal">67</span>
|
|
<span class="normal">68</span>
|
|
<span class="normal">69</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-31"><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
</span><span id="__span-0-32"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-33"> <span class="n">tts_model</span><span class="p">:</span> <span class="n">TTSModel</span><span class="p">,</span>
|
|
</span><span id="__span-0-34"> <span class="n">tts_settings</span><span class="p">:</span> <span class="n">TTSModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-35"> <span class="n">voice_pipeline_config</span><span class="p">:</span> <span class="n">VoicePipelineConfig</span><span class="p">,</span>
|
|
</span><span id="__span-0-36"><span class="p">):</span>
|
|
</span><span id="__span-0-37"><span class="w"> </span><span class="sd">"""Create a new `StreamedAudioResult` instance.</span>
|
|
</span><span id="__span-0-38">
|
|
</span><span id="__span-0-39"><span class="sd"> Args:</span>
|
|
</span><span id="__span-0-40"><span class="sd"> tts_model: The TTS model to use.</span>
|
|
</span><span id="__span-0-41"><span class="sd"> tts_settings: The TTS settings to use.</span>
|
|
</span><span id="__span-0-42"><span class="sd"> voice_pipeline_config: The voice pipeline config to use.</span>
|
|
</span><span id="__span-0-43"><span class="sd"> """</span>
|
|
</span><span id="__span-0-44"> <span class="bp">self</span><span class="o">.</span><span class="n">tts_model</span> <span class="o">=</span> <span class="n">tts_model</span>
|
|
</span><span id="__span-0-45"> <span class="bp">self</span><span class="o">.</span><span class="n">tts_settings</span> <span class="o">=</span> <span class="n">tts_settings</span>
|
|
</span><span id="__span-0-46"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-47"> <span class="bp">self</span><span class="o">.</span><span class="n">instructions</span> <span class="o">=</span> <span class="n">tts_settings</span><span class="o">.</span><span class="n">instructions</span>
|
|
</span><span id="__span-0-48"> <span class="bp">self</span><span class="o">.</span><span class="n">text_generation_task</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-49">
|
|
</span><span id="__span-0-50"> <span class="bp">self</span><span class="o">.</span><span class="n">_voice_pipeline_config</span> <span class="o">=</span> <span class="n">voice_pipeline_config</span>
|
|
</span><span id="__span-0-51"> <span class="bp">self</span><span class="o">.</span><span class="n">_text_buffer</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-52"> <span class="bp">self</span><span class="o">.</span><span class="n">_turn_text_buffer</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-53"> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span><span class="p">]</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span>
|
|
</span><span id="__span-0-54"> <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-55"> <span class="bp">self</span><span class="o">.</span><span class="n">_ordered_tasks</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span>
|
|
</span><span id="__span-0-56"> <span class="n">asyncio</span><span class="o">.</span><span class="n">Queue</span><span class="p">[</span><span class="n">VoiceStreamEvent</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span>
|
|
</span><span id="__span-0-57"> <span class="p">]</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># New: list to hold local queues for each text segment</span>
|
|
</span><span id="__span-0-58"> <span class="bp">self</span><span class="o">.</span><span class="n">_dispatcher_task</span><span class="p">:</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="p">(</span>
|
|
</span><span id="__span-0-59"> <span class="kc">None</span> <span class="c1"># Task to dispatch audio chunks in order</span>
|
|
</span><span id="__span-0-60"> <span class="p">)</span>
|
|
</span><span id="__span-0-61">
|
|
</span><span id="__span-0-62"> <span class="bp">self</span><span class="o">.</span><span class="n">_done_processing</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-63"> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer_size</span> <span class="o">=</span> <span class="n">tts_settings</span><span class="o">.</span><span class="n">buffer_size</span>
|
|
</span><span id="__span-0-64"> <span class="bp">self</span><span class="o">.</span><span class="n">_started_processing_turn</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-65"> <span class="bp">self</span><span class="o">.</span><span class="n">_first_byte_received</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-66"> <span class="bp">self</span><span class="o">.</span><span class="n">_generation_start_time</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-67"> <span class="bp">self</span><span class="o">.</span><span class="n">_completed_session</span> <span class="o">=</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-68"> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-69"> <span class="bp">self</span><span class="o">.</span><span class="n">_tracing_span</span><span class="p">:</span> <span class="n">Span</span><span class="p">[</span><span class="n">SpeechGroupSpanData</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.voice.result.StreamedAudioResult.stream" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">stream</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-async"><code>async</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">stream</span><span class="p">()</span> <span class="o">-></span> <span class="n"><span title="collections.abc.AsyncIterator">AsyncIterator</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title="VoiceStreamEvent
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.voice.events.VoiceStreamEvent)" href="../events/#cai.sdk.agents.voice.events.VoiceStreamEvent">VoiceStreamEvent</a></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Stream the events and audio data as they're generated.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/voice/result.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">266</span>
|
|
<span class="normal">267</span>
|
|
<span class="normal">268</span>
|
|
<span class="normal">269</span>
|
|
<span class="normal">270</span>
|
|
<span class="normal">271</span>
|
|
<span class="normal">272</span>
|
|
<span class="normal">273</span>
|
|
<span class="normal">274</span>
|
|
<span class="normal">275</span>
|
|
<span class="normal">276</span>
|
|
<span class="normal">277</span>
|
|
<span class="normal">278</span>
|
|
<span class="normal">279</span>
|
|
<span class="normal">280</span>
|
|
<span class="normal">281</span>
|
|
<span class="normal">282</span>
|
|
<span class="normal">283</span>
|
|
<span class="normal">284</span>
|
|
<span class="normal">285</span>
|
|
<span class="normal">286</span>
|
|
<span class="normal">287</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-266"><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">stream</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncIterator</span><span class="p">[</span><span class="n">VoiceStreamEvent</span><span class="p">]:</span>
|
|
</span><span id="__span-0-267"><span class="w"> </span><span class="sd">"""Stream the events and audio data as they're generated."""</span>
|
|
</span><span id="__span-0-268"> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
|
|
</span><span id="__span-0-269"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-270"> <span class="n">event</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
|
|
</span><span id="__span-0-271"> <span class="k">except</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">CancelledError</span><span class="p">:</span>
|
|
</span><span id="__span-0-272"> <span class="k">break</span>
|
|
</span><span id="__span-0-273"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">VoiceStreamEventError</span><span class="p">):</span>
|
|
</span><span id="__span-0-274"> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">error</span>
|
|
</span><span id="__span-0-275"> <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error processing output: </span><span class="si">{</span><span class="n">event</span><span class="o">.</span><span class="n">error</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-0-276"> <span class="k">break</span>
|
|
</span><span id="__span-0-277"> <span class="k">if</span> <span class="n">event</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-278"> <span class="k">break</span>
|
|
</span><span id="__span-0-279"> <span class="k">yield</span> <span class="n">event</span>
|
|
</span><span id="__span-0-280"> <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s2">"voice_stream_event_lifecycle"</span> <span class="ow">and</span> <span class="n">event</span><span class="o">.</span><span class="n">event</span> <span class="o">==</span> <span class="s2">"session_ended"</span><span class="p">:</span>
|
|
</span><span id="__span-0-281"> <span class="k">break</span>
|
|
</span><span id="__span-0-282">
|
|
</span><span id="__span-0-283"> <span class="bp">self</span><span class="o">.</span><span class="n">_check_errors</span><span class="p">()</span>
|
|
</span><span id="__span-0-284"> <span class="bp">self</span><span class="o">.</span><span class="n">_cleanup_tasks</span><span class="p">()</span>
|
|
</span><span id="__span-0-285">
|
|
</span><span id="__span-0-286"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-287"> <span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stored_exception</span>
|
|
</span></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>
|
|
|
|
</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>
|
|
|
|
</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">{"base": "../../..", "features": ["content.code.copy", "content.code.select", "navigation.path", "navigation.sections", "navigation.expand", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.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.c8b220af.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |