mirror of https://github.com/aliasrobotics/cai.git
4486 lines
201 KiB
HTML
4486 lines
201 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="prev" href="../openai_chatcompletions/">
|
|
|
|
|
|
<link rel="next" href="../../extensions/handoff_filters/">
|
|
|
|
|
|
<link rel="icon" href="../../../assets/imago.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
|
|
|
|
|
|
|
|
<title>OpenAI Responses - 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="#openai-responses-model" 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">
|
|
|
|
OpenAI Responses
|
|
|
|
</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--active md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
|
|
|
|
|
|
<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="true">
|
|
<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--active md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10_2" checked>
|
|
|
|
|
|
<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="true">
|
|
<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="../interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../openai_chatcompletions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Chat Completions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Responses
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Responses
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
openai_responses
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.OpenAIResponsesModel" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
OpenAIResponsesModel
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="OpenAIResponsesModel">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.OpenAIResponsesModel.set_agent_name" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
set_agent_name
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.OpenAIResponsesModel.stream_response" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
stream_response
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.Converter" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Converter
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle 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.models.openai_responses" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
openai_responses
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.OpenAIResponsesModel" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
OpenAIResponsesModel
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="OpenAIResponsesModel">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.OpenAIResponsesModel.set_agent_name" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
set_agent_name
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.OpenAIResponsesModel.stream_response" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
stream_response
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.models.openai_responses.Converter" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Converter
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="openai-responses-model"><code>OpenAI Responses model</code></h1>
|
|
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
|
|
|
|
<a id="cai.sdk.agents.models.openai_responses"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.models.openai_responses.OpenAIResponsesModel" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">OpenAIResponsesModel</span>
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="Model (cai.sdk.agents.models.interface.Model)" href="../interface/#cai.sdk.agents.models.interface.Model">Model</a></code></p>
|
|
|
|
|
|
<p>Implementation of <code>Model</code> that uses the OpenAI Responses API.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/models/openai_responses.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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>
|
|
<span class="normal">288</span>
|
|
<span class="normal">289</span>
|
|
<span class="normal">290</span>
|
|
<span class="normal">291</span>
|
|
<span class="normal">292</span>
|
|
<span class="normal">293</span>
|
|
<span class="normal">294</span>
|
|
<span class="normal">295</span>
|
|
<span class="normal">296</span>
|
|
<span class="normal">297</span>
|
|
<span class="normal">298</span>
|
|
<span class="normal">299</span>
|
|
<span class="normal">300</span>
|
|
<span class="normal">301</span>
|
|
<span class="normal">302</span>
|
|
<span class="normal">303</span>
|
|
<span class="normal">304</span>
|
|
<span class="normal">305</span>
|
|
<span class="normal">306</span>
|
|
<span class="normal">307</span>
|
|
<span class="normal">308</span>
|
|
<span class="normal">309</span>
|
|
<span class="normal">310</span>
|
|
<span class="normal">311</span>
|
|
<span class="normal">312</span>
|
|
<span class="normal">313</span>
|
|
<span class="normal">314</span>
|
|
<span class="normal">315</span>
|
|
<span class="normal">316</span>
|
|
<span class="normal">317</span>
|
|
<span class="normal">318</span>
|
|
<span class="normal">319</span>
|
|
<span class="normal">320</span>
|
|
<span class="normal">321</span>
|
|
<span class="normal">322</span>
|
|
<span class="normal">323</span>
|
|
<span class="normal">324</span>
|
|
<span class="normal">325</span>
|
|
<span class="normal">326</span>
|
|
<span class="normal">327</span>
|
|
<span class="normal">328</span>
|
|
<span class="normal">329</span>
|
|
<span class="normal">330</span>
|
|
<span class="normal">331</span>
|
|
<span class="normal">332</span>
|
|
<span class="normal">333</span>
|
|
<span class="normal">334</span>
|
|
<span class="normal">335</span>
|
|
<span class="normal">336</span>
|
|
<span class="normal">337</span>
|
|
<span class="normal">338</span>
|
|
<span class="normal">339</span>
|
|
<span class="normal">340</span>
|
|
<span class="normal">341</span>
|
|
<span class="normal">342</span>
|
|
<span class="normal">343</span>
|
|
<span class="normal">344</span>
|
|
<span class="normal">345</span>
|
|
<span class="normal">346</span>
|
|
<span class="normal">347</span>
|
|
<span class="normal">348</span>
|
|
<span class="normal">349</span>
|
|
<span class="normal">350</span>
|
|
<span class="normal">351</span>
|
|
<span class="normal">352</span>
|
|
<span class="normal">353</span>
|
|
<span class="normal">354</span>
|
|
<span class="normal">355</span>
|
|
<span class="normal">356</span>
|
|
<span class="normal">357</span>
|
|
<span class="normal">358</span>
|
|
<span class="normal">359</span>
|
|
<span class="normal">360</span>
|
|
<span class="normal">361</span>
|
|
<span class="normal">362</span>
|
|
<span class="normal">363</span>
|
|
<span class="normal">364</span>
|
|
<span class="normal">365</span>
|
|
<span class="normal">366</span>
|
|
<span class="normal">367</span>
|
|
<span class="normal">368</span>
|
|
<span class="normal">369</span>
|
|
<span class="normal">370</span>
|
|
<span class="normal">371</span>
|
|
<span class="normal">372</span>
|
|
<span class="normal">373</span>
|
|
<span class="normal">374</span>
|
|
<span class="normal">375</span>
|
|
<span class="normal">376</span>
|
|
<span class="normal">377</span>
|
|
<span class="normal">378</span>
|
|
<span class="normal">379</span>
|
|
<span class="normal">380</span>
|
|
<span class="normal">381</span>
|
|
<span class="normal">382</span>
|
|
<span class="normal">383</span>
|
|
<span class="normal">384</span>
|
|
<span class="normal">385</span>
|
|
<span class="normal">386</span>
|
|
<span class="normal">387</span>
|
|
<span class="normal">388</span>
|
|
<span class="normal">389</span>
|
|
<span class="normal">390</span>
|
|
<span class="normal">391</span>
|
|
<span class="normal">392</span>
|
|
<span class="normal">393</span>
|
|
<span class="normal">394</span>
|
|
<span class="normal">395</span>
|
|
<span class="normal">396</span>
|
|
<span class="normal">397</span>
|
|
<span class="normal">398</span>
|
|
<span class="normal">399</span>
|
|
<span class="normal">400</span>
|
|
<span class="normal">401</span>
|
|
<span class="normal">402</span>
|
|
<span class="normal">403</span>
|
|
<span class="normal">404</span>
|
|
<span class="normal">405</span>
|
|
<span class="normal">406</span>
|
|
<span class="normal">407</span>
|
|
<span class="normal">408</span>
|
|
<span class="normal">409</span>
|
|
<span class="normal">410</span>
|
|
<span class="normal">411</span>
|
|
<span class="normal">412</span>
|
|
<span class="normal">413</span>
|
|
<span class="normal">414</span>
|
|
<span class="normal">415</span>
|
|
<span class="normal">416</span>
|
|
<span class="normal">417</span>
|
|
<span class="normal">418</span>
|
|
<span class="normal">419</span>
|
|
<span class="normal">420</span>
|
|
<span class="normal">421</span>
|
|
<span class="normal">422</span>
|
|
<span class="normal">423</span>
|
|
<span class="normal">424</span>
|
|
<span class="normal">425</span>
|
|
<span class="normal">426</span>
|
|
<span class="normal">427</span>
|
|
<span class="normal">428</span>
|
|
<span class="normal">429</span>
|
|
<span class="normal">430</span>
|
|
<span class="normal">431</span>
|
|
<span class="normal">432</span>
|
|
<span class="normal">433</span>
|
|
<span class="normal">434</span>
|
|
<span class="normal">435</span>
|
|
<span class="normal">436</span>
|
|
<span class="normal">437</span>
|
|
<span class="normal">438</span>
|
|
<span class="normal">439</span>
|
|
<span class="normal">440</span>
|
|
<span class="normal">441</span>
|
|
<span class="normal">442</span>
|
|
<span class="normal">443</span>
|
|
<span class="normal">444</span>
|
|
<span class="normal">445</span>
|
|
<span class="normal">446</span>
|
|
<span class="normal">447</span>
|
|
<span class="normal">448</span>
|
|
<span class="normal">449</span>
|
|
<span class="normal">450</span>
|
|
<span class="normal">451</span>
|
|
<span class="normal">452</span>
|
|
<span class="normal">453</span>
|
|
<span class="normal">454</span>
|
|
<span class="normal">455</span>
|
|
<span class="normal">456</span>
|
|
<span class="normal">457</span>
|
|
<span class="normal">458</span>
|
|
<span class="normal">459</span>
|
|
<span class="normal">460</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-49"><span class="k">class</span><span class="w"> </span><span class="nc">OpenAIResponsesModel</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
|
|
</span><span id="__span-0-50"><span class="w"> </span><span class="sd">"""</span>
|
|
</span><span id="__span-0-51"><span class="sd"> Implementation of `Model` that uses the OpenAI Responses API.</span>
|
|
</span><span id="__span-0-52"><span class="sd"> """</span>
|
|
</span><span id="__span-0-53">
|
|
</span><span id="__span-0-54"> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
</span><span id="__span-0-55"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-56"> <span class="n">model</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">ChatModel</span><span class="p">,</span>
|
|
</span><span id="__span-0-57"> <span class="n">openai_client</span><span class="p">:</span> <span class="n">AsyncOpenAI</span><span class="p">,</span>
|
|
</span><span id="__span-0-58"> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="se">\n</span><span class="s2">DEBUG: OpenAIResponsesModel initialized with model: </span><span class="si">{</span><span class="n">model</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-0-60"> <span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span>
|
|
</span><span id="__span-0-61"> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">openai_client</span>
|
|
</span><span id="__span-0-62">
|
|
</span><span id="__span-0-63"> <span class="c1"># Track interaction counter and token totals for cli display</span>
|
|
</span><span id="__span-0-64"> <span class="bp">self</span><span class="o">.</span><span class="n">interaction_counter</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-65"> <span class="bp">self</span><span class="o">.</span><span class="n">total_input_tokens</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-66"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_tokens</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-67"> <span class="bp">self</span><span class="o">.</span><span class="n">total_reasoning_tokens</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-68"> <span class="bp">self</span><span class="o">.</span><span class="n">agent_name</span> <span class="o">=</span> <span class="s2">"Agent"</span> <span class="c1"># Default name</span>
|
|
</span><span id="__span-0-69">
|
|
</span><span id="__span-0-70"> <span class="k">def</span><span class="w"> </span><span class="nf">set_agent_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-71"><span class="w"> </span><span class="sd">"""Set the agent name for CLI display purposes."""</span>
|
|
</span><span id="__span-0-72"> <span class="bp">self</span><span class="o">.</span><span class="n">agent_name</span> <span class="o">=</span> <span class="n">name</span>
|
|
</span><span id="__span-0-73">
|
|
</span><span id="__span-0-74"> <span class="k">def</span><span class="w"> </span><span class="nf">_non_null_or_not_given</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
|
|
</span><span id="__span-0-75"> <span class="k">return</span> <span class="n">value</span> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">NOT_GIVEN</span>
|
|
</span><span id="__span-0-76">
|
|
</span><span id="__span-0-77"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-78"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-79"> <span class="n">system_instructions</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-80"> <span class="nb">input</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">],</span>
|
|
</span><span id="__span-0-81"> <span class="n">model_settings</span><span class="p">:</span> <span class="n">ModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-82"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-83"> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-84"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">],</span>
|
|
</span><span id="__span-0-85"> <span class="n">tracing</span><span class="p">:</span> <span class="n">ModelTracing</span><span class="p">,</span>
|
|
</span><span id="__span-0-86"> <span class="p">)</span> <span class="o">-></span> <span class="n">ModelResponse</span><span class="p">:</span>
|
|
</span><span id="__span-0-87"> <span class="c1"># Increment the interaction counter for CLI display</span>
|
|
</span><span id="__span-0-88"> <span class="bp">self</span><span class="o">.</span><span class="n">interaction_counter</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
</span><span id="__span-0-89">
|
|
</span><span id="__span-0-90"> <span class="c1"># --- Snapshot inputs for token accounting parity with IN: ---</span>
|
|
</span><span id="__span-0-91"> <span class="n">sys_tokens</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-92"> <span class="n">tool_defs_tokens</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-93"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-94"> <span class="c1"># Count system tokens dynamically</span>
|
|
</span><span id="__span-0-95"> <span class="k">if</span> <span class="n">system_instructions</span><span class="p">:</span>
|
|
</span><span id="__span-0-96"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-97"> <span class="kn">from</span><span class="w"> </span><span class="nn">cai.sdk.agents.models.openai_chatcompletions</span><span class="w"> </span><span class="kn">import</span> <span class="n">count_tokens_with_tiktoken</span> <span class="k">as</span> <span class="n">_ct</span>
|
|
</span><span id="__span-0-98"> <span class="n">sys_tokens</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_ct</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">system_instructions</span><span class="p">))</span>
|
|
</span><span id="__span-0-99"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-100"> <span class="n">sys_tokens</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">system_instructions</span><span class="p">))</span> <span class="o">//</span> <span class="mi">4</span>
|
|
</span><span id="__span-0-101"> <span class="c1"># Count tool definition tokens from params_json_schema</span>
|
|
</span><span id="__span-0-102"> <span class="k">if</span> <span class="n">tools</span><span class="p">:</span>
|
|
</span><span id="__span-0-103"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-104"> <span class="kn">import</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">_json</span>
|
|
</span><span id="__span-0-105"> <span class="kn">import</span><span class="w"> </span><span class="nn">tiktoken</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">_t</span>
|
|
</span><span id="__span-0-106"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-107"> <span class="n">enc</span> <span class="o">=</span> <span class="n">_t</span><span class="o">.</span><span class="n">get_encoding</span><span class="p">(</span><span class="s2">"cl100k_base"</span><span class="p">)</span>
|
|
</span><span id="__span-0-108"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-109"> <span class="n">enc</span> <span class="o">=</span> <span class="n">_t</span><span class="o">.</span><span class="n">get_encoding</span><span class="p">(</span><span class="s2">"gpt2"</span><span class="p">)</span>
|
|
</span><span id="__span-0-110"> <span class="k">for</span> <span class="n">tool</span> <span class="ow">in</span> <span class="n">tools</span><span class="p">:</span>
|
|
</span><span id="__span-0-111"> <span class="n">schema</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="s2">"params_json_schema"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
|
</span><span id="__span-0-112"> <span class="k">if</span> <span class="n">schema</span><span class="p">:</span>
|
|
</span><span id="__span-0-113"> <span class="n">as_str</span> <span class="o">=</span> <span class="n">_json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span>
|
|
</span><span id="__span-0-114"> <span class="n">tool_defs_tokens</span> <span class="o">+=</span> <span class="nb">len</span><span class="p">(</span><span class="n">enc</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">as_str</span><span class="p">))</span> <span class="k">if</span> <span class="n">enc</span> <span class="k">else</span> <span class="nb">len</span><span class="p">(</span><span class="n">as_str</span><span class="p">)</span> <span class="o">//</span> <span class="mi">4</span>
|
|
</span><span id="__span-0-115"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-116"> <span class="k">pass</span>
|
|
</span><span id="__span-0-117"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-0-118"> <span class="s2">"system_tokens"</span><span class="p">:</span> <span class="nb">int</span><span class="p">(</span><span class="n">sys_tokens</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-119"> <span class="s2">"tool_definitions_tokens"</span><span class="p">:</span> <span class="nb">int</span><span class="p">(</span><span class="n">tool_defs_tokens</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-120"> <span class="s2">"messages_breakdown"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"user"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"assistant"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"tool_calls"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"tool_results"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span>
|
|
</span><span id="__span-0-121"> <span class="p">}</span>
|
|
</span><span id="__span-0-122"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-123"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-124">
|
|
</span><span id="__span-0-125"> <span class="k">with</span> <span class="n">response_span</span><span class="p">(</span><span class="n">disabled</span><span class="o">=</span><span class="n">tracing</span><span class="o">.</span><span class="n">is_disabled</span><span class="p">())</span> <span class="k">as</span> <span class="n">span_response</span><span class="p">:</span>
|
|
</span><span id="__span-0-126"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-127"> <span class="k">async</span> <span class="k">with</span> <span class="n">model_wait_hints</span><span class="p">():</span>
|
|
</span><span id="__span-0-128"> <span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-129"> <span class="n">system_instructions</span><span class="p">,</span>
|
|
</span><span id="__span-0-130"> <span class="nb">input</span><span class="p">,</span>
|
|
</span><span id="__span-0-131"> <span class="n">model_settings</span><span class="p">,</span>
|
|
</span><span id="__span-0-132"> <span class="n">tools</span><span class="p">,</span>
|
|
</span><span id="__span-0-133"> <span class="n">output_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-134"> <span class="n">handoffs</span><span class="p">,</span>
|
|
</span><span id="__span-0-135"> <span class="n">stream</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-0-136"> <span class="p">)</span>
|
|
</span><span id="__span-0-137">
|
|
</span><span id="__span-0-138"> <span class="k">if</span> <span class="n">_debug</span><span class="o">.</span><span class="n">DONT_LOG_MODEL_DATA</span><span class="p">:</span>
|
|
</span><span id="__span-0-139"> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"LLM responded"</span><span class="p">)</span>
|
|
</span><span id="__span-0-140"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-141"> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
|
|
</span><span id="__span-0-142"> <span class="s2">"LLM resp:</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-143"> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">([</span><span class="n">x</span><span class="o">.</span><span class="n">model_dump</span><span class="p">()</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">response</span><span class="o">.</span><span class="n">output</span><span class="p">],</span><span class="w"> </span><span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-144"> <span class="p">)</span>
|
|
</span><span id="__span-0-145">
|
|
</span><span id="__span-0-146"> <span class="n">usage</span> <span class="o">=</span> <span class="p">(</span>
|
|
</span><span id="__span-0-147"> <span class="n">Usage</span><span class="p">(</span>
|
|
</span><span id="__span-0-148"> <span class="n">requests</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-0-149"> <span class="n">input_tokens</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-150"> <span class="n">output_tokens</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-151"> <span class="n">total_tokens</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">total_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-152"> <span class="p">)</span>
|
|
</span><span id="__span-0-153"> <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">usage</span>
|
|
</span><span id="__span-0-154"> <span class="k">else</span> <span class="n">Usage</span><span class="p">()</span>
|
|
</span><span id="__span-0-155"> <span class="p">)</span>
|
|
</span><span id="__span-0-156">
|
|
</span><span id="__span-0-157"> <span class="k">if</span> <span class="n">tracing</span><span class="o">.</span><span class="n">include_data</span><span class="p">():</span>
|
|
</span><span id="__span-0-158"> <span class="n">span_response</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="n">response</span>
|
|
</span><span id="__span-0-159"> <span class="n">span_response</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="nb">input</span>
|
|
</span><span id="__span-0-160">
|
|
</span><span id="__span-0-161"> <span class="c1"># Print the agent message for CLI display</span>
|
|
</span><span id="__span-0-162"> <span class="kn">from</span><span class="w"> </span><span class="nn">cai.util</span><span class="w"> </span><span class="kn">import</span> <span class="n">cli_print_agent_messages</span>
|
|
</span><span id="__span-0-163">
|
|
</span><span id="__span-0-164"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-165"> <span class="c1"># Create a message-like object to display</span>
|
|
</span><span id="__span-0-166"> <span class="n">message_obj</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span>
|
|
</span><span id="__span-0-167"> <span class="s2">"ResponseWrapper"</span><span class="p">,</span>
|
|
</span><span id="__span-0-168"> <span class="p">(),</span>
|
|
</span><span id="__span-0-169"> <span class="p">{</span>
|
|
</span><span id="__span-0-170"> <span class="s2">"content"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
|
|
</span><span id="__span-0-171"> <span class="p">[</span>
|
|
</span><span id="__span-0-172"> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"content"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
|
</span><span id="__span-0-173"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"get"</span><span class="p">)</span>
|
|
</span><span id="__span-0-174"> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"text"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
|
</span><span id="__span-0-175"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">output</span>
|
|
</span><span id="__span-0-176"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"get"</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"text"</span><span class="p">)</span>
|
|
</span><span id="__span-0-177"> <span class="p">]</span>
|
|
</span><span id="__span-0-178"> <span class="p">),</span>
|
|
</span><span id="__span-0-179"> <span class="s2">"tool_calls"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span id="__span-0-180"> <span class="nb">type</span><span class="p">(</span>
|
|
</span><span id="__span-0-181"> <span class="s2">"ToolCallWrapper"</span><span class="p">,</span>
|
|
</span><span id="__span-0-182"> <span class="p">(),</span>
|
|
</span><span id="__span-0-183"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">arguments</span><span class="p">},</span>
|
|
</span><span id="__span-0-184"> <span class="p">)</span>
|
|
</span><span id="__span-0-185"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">output</span>
|
|
</span><span id="__span-0-186"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">)</span>
|
|
</span><span id="__span-0-187"> <span class="p">],</span>
|
|
</span><span id="__span-0-188"> <span class="p">},</span>
|
|
</span><span id="__span-0-189"> <span class="p">)</span>
|
|
</span><span id="__span-0-190">
|
|
</span><span id="__span-0-191"> <span class="n">cli_print_agent_messages</span><span class="p">(</span>
|
|
</span><span id="__span-0-192"> <span class="n">agent_name</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"agent_name"</span><span class="p">,</span> <span class="s2">"Agent"</span><span class="p">),</span>
|
|
</span><span id="__span-0-193"> <span class="n">message</span><span class="o">=</span><span class="n">message_obj</span><span class="p">,</span>
|
|
</span><span id="__span-0-194"> <span class="n">counter</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"interaction_counter"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-195"> <span class="n">model</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">),</span>
|
|
</span><span id="__span-0-196"> <span class="n">debug</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-0-197"> <span class="n">interaction_input_tokens</span><span class="o">=</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-198"> <span class="n">interaction_output_tokens</span><span class="o">=</span><span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-199"> <span class="n">interaction_reasoning_tokens</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
|
</span><span id="__span-0-200"> <span class="n">total_input_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_input_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-201"> <span class="n">total_output_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_output_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-202"> <span class="n">total_reasoning_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_reasoning_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-203"> <span class="n">interaction_cost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-204"> <span class="n">total_cost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-205"> <span class="p">)</span>
|
|
</span><span id="__span-0-206">
|
|
</span><span id="__span-0-207"> <span class="c1"># Update token totals</span>
|
|
</span><span id="__span-0-208"> <span class="bp">self</span><span class="o">.</span><span class="n">total_input_tokens</span> <span class="o">+=</span> <span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span>
|
|
</span><span id="__span-0-209"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_tokens</span> <span class="o">+=</span> <span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span>
|
|
</span><span id="__span-0-210">
|
|
</span><span id="__span-0-211"> <span class="c1"># Store actual tokens to align usage metrics with IN:</span>
|
|
</span><span id="__span-0-212"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-213"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_actual_input_tokens</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-214"> <span class="c1"># Compute overhead to reconcile totals</span>
|
|
</span><span id="__span-0-215"> <span class="n">br</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown</span> <span class="ow">or</span> <span class="p">{}</span>
|
|
</span><span id="__span-0-216"> <span class="n">sys_t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"system_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-217"> <span class="n">tool_t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"tool_definitions_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-218"> <span class="n">msg_map</span> <span class="o">=</span> <span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"messages_breakdown"</span><span class="p">,</span> <span class="p">{})</span> <span class="ow">or</span> <span class="p">{}</span>
|
|
</span><span id="__span-0-219"> <span class="n">msg_sum</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">v</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">msg_map</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
|
|
</span><span id="__span-0-220"> <span class="n">known</span> <span class="o">=</span> <span class="n">sys_t</span> <span class="o">+</span> <span class="n">tool_t</span> <span class="o">+</span> <span class="n">msg_sum</span>
|
|
</span><span id="__span-0-221"> <span class="n">overhead</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_last_request_actual_input_tokens</span><span class="p">)</span> <span class="o">-</span> <span class="n">known</span>
|
|
</span><span id="__span-0-222"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown_overhead</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">overhead</span><span class="p">)</span> <span class="k">if</span> <span class="n">overhead</span> <span class="o">></span> <span class="mi">0</span> <span class="k">else</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-223"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-224"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown_overhead</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-225"> <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-226"> <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 printing agent message: </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-227">
|
|
</span><span id="__span-0-228"> <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-229"> <span class="n">span_response</span><span class="o">.</span><span class="n">set_error</span><span class="p">(</span>
|
|
</span><span id="__span-0-230"> <span class="n">SpanError</span><span class="p">(</span>
|
|
</span><span id="__span-0-231"> <span class="n">message</span><span class="o">=</span><span class="s2">"Error getting response"</span><span class="p">,</span>
|
|
</span><span id="__span-0-232"> <span class="n">data</span><span class="o">=</span><span class="p">{</span>
|
|
</span><span id="__span-0-233"> <span class="s2">"error"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="k">if</span> <span class="n">tracing</span><span class="o">.</span><span class="n">include_data</span><span class="p">()</span> <span class="k">else</span> <span class="n">e</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
|
|
</span><span id="__span-0-234"> <span class="p">},</span>
|
|
</span><span id="__span-0-235"> <span class="p">)</span>
|
|
</span><span id="__span-0-236"> <span class="p">)</span>
|
|
</span><span id="__span-0-237"> <span class="n">request_id</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">request_id</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">APIStatusError</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-238"> <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 getting response: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">. (request_id: </span><span class="si">{</span><span class="n">request_id</span><span class="si">}</span><span class="s2">)"</span><span class="p">)</span>
|
|
</span><span id="__span-0-239"> <span class="k">raise</span>
|
|
</span><span id="__span-0-240">
|
|
</span><span id="__span-0-241"> <span class="k">return</span> <span class="n">ModelResponse</span><span class="p">(</span>
|
|
</span><span id="__span-0-242"> <span class="n">output</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">output</span><span class="p">,</span>
|
|
</span><span id="__span-0-243"> <span class="n">usage</span><span class="o">=</span><span class="n">usage</span><span class="p">,</span>
|
|
</span><span id="__span-0-244"> <span class="n">referenceable_id</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
|
</span><span id="__span-0-245"> <span class="p">)</span>
|
|
</span><span id="__span-0-246">
|
|
</span><span id="__span-0-247"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">stream_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-248"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-249"> <span class="n">system_instructions</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-250"> <span class="nb">input</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">],</span>
|
|
</span><span id="__span-0-251"> <span class="n">model_settings</span><span class="p">:</span> <span class="n">ModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-252"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-253"> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-254"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">],</span>
|
|
</span><span id="__span-0-255"> <span class="n">tracing</span><span class="p">:</span> <span class="n">ModelTracing</span><span class="p">,</span>
|
|
</span><span id="__span-0-256"> <span class="p">)</span> <span class="o">-></span> <span class="n">AsyncIterator</span><span class="p">[</span><span class="n">ResponseStreamEvent</span><span class="p">]:</span>
|
|
</span><span id="__span-0-257"><span class="w"> </span><span class="sd">"""</span>
|
|
</span><span id="__span-0-258"><span class="sd"> Yields a partial message as it is generated, as well as the usage information.</span>
|
|
</span><span id="__span-0-259"><span class="sd"> """</span>
|
|
</span><span id="__span-0-260"> <span class="c1"># Increment the interaction counter for CLI display</span>
|
|
</span><span id="__span-0-261"> <span class="bp">self</span><span class="o">.</span><span class="n">interaction_counter</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
</span><span id="__span-0-262">
|
|
</span><span id="__span-0-263"> <span class="k">with</span> <span class="n">response_span</span><span class="p">(</span><span class="n">disabled</span><span class="o">=</span><span class="n">tracing</span><span class="o">.</span><span class="n">is_disabled</span><span class="p">())</span> <span class="k">as</span> <span class="n">span_response</span><span class="p">:</span>
|
|
</span><span id="__span-0-264"> <span class="n">stream_wait_hints</span> <span class="o">=</span> <span class="n">ModelStreamWaitHints</span><span class="p">()</span>
|
|
</span><span id="__span-0-265"> <span class="k">await</span> <span class="n">stream_wait_hints</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
|
|
</span><span id="__span-0-266"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-267"> <span class="n">stream</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-268"> <span class="n">system_instructions</span><span class="p">,</span>
|
|
</span><span id="__span-0-269"> <span class="nb">input</span><span class="p">,</span>
|
|
</span><span id="__span-0-270"> <span class="n">model_settings</span><span class="p">,</span>
|
|
</span><span id="__span-0-271"> <span class="n">tools</span><span class="p">,</span>
|
|
</span><span id="__span-0-272"> <span class="n">output_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-273"> <span class="n">handoffs</span><span class="p">,</span>
|
|
</span><span id="__span-0-274"> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
</span><span id="__span-0-275"> <span class="p">)</span>
|
|
</span><span id="__span-0-276">
|
|
</span><span id="__span-0-277"> <span class="n">final_response</span><span class="p">:</span> <span class="n">Response</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-278">
|
|
</span><span id="__span-0-279"> <span class="k">async</span> <span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">stream</span><span class="p">:</span>
|
|
</span><span id="__span-0-280"> <span class="k">await</span> <span class="n">stream_wait_hints</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
|
|
</span><span id="__span-0-281"> <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">ResponseCompletedEvent</span><span class="p">):</span>
|
|
</span><span id="__span-0-282"> <span class="n">final_response</span> <span class="o">=</span> <span class="n">chunk</span><span class="o">.</span><span class="n">response</span>
|
|
</span><span id="__span-0-283"> <span class="k">yield</span> <span class="n">chunk</span>
|
|
</span><span id="__span-0-284">
|
|
</span><span id="__span-0-285"> <span class="k">if</span> <span class="n">final_response</span> <span class="ow">and</span> <span class="n">tracing</span><span class="o">.</span><span class="n">include_data</span><span class="p">():</span>
|
|
</span><span id="__span-0-286"> <span class="n">span_response</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="n">final_response</span>
|
|
</span><span id="__span-0-287"> <span class="n">span_response</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="nb">input</span>
|
|
</span><span id="__span-0-288">
|
|
</span><span id="__span-0-289"> <span class="c1"># Print the agent message for CLI display</span>
|
|
</span><span id="__span-0-290"> <span class="kn">from</span><span class="w"> </span><span class="nn">cai.util</span><span class="w"> </span><span class="kn">import</span> <span class="n">cli_print_agent_messages</span>
|
|
</span><span id="__span-0-291">
|
|
</span><span id="__span-0-292"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-293"> <span class="c1"># Create a message-like object to display</span>
|
|
</span><span id="__span-0-294"> <span class="n">message_obj</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span>
|
|
</span><span id="__span-0-295"> <span class="s2">"ResponseWrapper"</span><span class="p">,</span>
|
|
</span><span id="__span-0-296"> <span class="p">(),</span>
|
|
</span><span id="__span-0-297"> <span class="p">{</span>
|
|
</span><span id="__span-0-298"> <span class="s2">"content"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
|
|
</span><span id="__span-0-299"> <span class="p">[</span>
|
|
</span><span id="__span-0-300"> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"content"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
|
</span><span id="__span-0-301"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"get"</span><span class="p">)</span>
|
|
</span><span id="__span-0-302"> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"text"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
|
</span><span id="__span-0-303"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">final_response</span><span class="o">.</span><span class="n">output</span>
|
|
</span><span id="__span-0-304"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"get"</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"text"</span><span class="p">)</span>
|
|
</span><span id="__span-0-305"> <span class="p">]</span>
|
|
</span><span id="__span-0-306"> <span class="p">),</span>
|
|
</span><span id="__span-0-307"> <span class="s2">"tool_calls"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span id="__span-0-308"> <span class="nb">type</span><span class="p">(</span>
|
|
</span><span id="__span-0-309"> <span class="s2">"ToolCallWrapper"</span><span class="p">,</span>
|
|
</span><span id="__span-0-310"> <span class="p">(),</span>
|
|
</span><span id="__span-0-311"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">arguments</span><span class="p">},</span>
|
|
</span><span id="__span-0-312"> <span class="p">)</span>
|
|
</span><span id="__span-0-313"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">final_response</span><span class="o">.</span><span class="n">output</span>
|
|
</span><span id="__span-0-314"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">)</span>
|
|
</span><span id="__span-0-315"> <span class="p">],</span>
|
|
</span><span id="__span-0-316"> <span class="p">},</span>
|
|
</span><span id="__span-0-317"> <span class="p">)</span>
|
|
</span><span id="__span-0-318">
|
|
</span><span id="__span-0-319"> <span class="n">cli_print_agent_messages</span><span class="p">(</span>
|
|
</span><span id="__span-0-320"> <span class="n">agent_name</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"agent_name"</span><span class="p">,</span> <span class="s2">"Agent"</span><span class="p">),</span>
|
|
</span><span id="__span-0-321"> <span class="n">message</span><span class="o">=</span><span class="n">message_obj</span><span class="p">,</span>
|
|
</span><span id="__span-0-322"> <span class="n">counter</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"interaction_counter"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-323"> <span class="n">model</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">),</span>
|
|
</span><span id="__span-0-324"> <span class="n">debug</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-0-325"> <span class="n">interaction_input_tokens</span><span class="o">=</span><span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-326"> <span class="n">interaction_output_tokens</span><span class="o">=</span><span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-327"> <span class="n">interaction_reasoning_tokens</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
|
</span><span id="__span-0-328"> <span class="n">total_input_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_input_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-329"> <span class="n">total_output_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_output_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-330"> <span class="n">total_reasoning_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_reasoning_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-331"> <span class="n">interaction_cost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-332"> <span class="n">total_cost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-333"> <span class="p">)</span>
|
|
</span><span id="__span-0-334">
|
|
</span><span id="__span-0-335"> <span class="c1"># Update token totals</span>
|
|
</span><span id="__span-0-336"> <span class="bp">self</span><span class="o">.</span><span class="n">total_input_tokens</span> <span class="o">+=</span> <span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span>
|
|
</span><span id="__span-0-337"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_tokens</span> <span class="o">+=</span> <span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span>
|
|
</span><span id="__span-0-338">
|
|
</span><span id="__span-0-339"> <span class="c1"># Store actual tokens to align usage metrics with IN: for streamed path</span>
|
|
</span><span id="__span-0-340"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-341"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_actual_input_tokens</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-342"> <span class="n">br</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown</span> <span class="ow">or</span> <span class="p">{}</span>
|
|
</span><span id="__span-0-343"> <span class="n">sys_t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"system_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-344"> <span class="n">tool_t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"tool_definitions_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-345"> <span class="n">msg_map</span> <span class="o">=</span> <span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"messages_breakdown"</span><span class="p">,</span> <span class="p">{})</span> <span class="ow">or</span> <span class="p">{}</span>
|
|
</span><span id="__span-0-346"> <span class="n">msg_sum</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">v</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">msg_map</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
|
|
</span><span id="__span-0-347"> <span class="n">known</span> <span class="o">=</span> <span class="n">sys_t</span> <span class="o">+</span> <span class="n">tool_t</span> <span class="o">+</span> <span class="n">msg_sum</span>
|
|
</span><span id="__span-0-348"> <span class="n">overhead</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_last_request_actual_input_tokens</span><span class="p">)</span> <span class="o">-</span> <span class="n">known</span>
|
|
</span><span id="__span-0-349"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown_overhead</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">overhead</span><span class="p">)</span> <span class="k">if</span> <span class="n">overhead</span> <span class="o">></span> <span class="mi">0</span> <span class="k">else</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-350"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-351"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown_overhead</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-352"> <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-353"> <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 printing agent message: </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-354">
|
|
</span><span id="__span-0-355"> <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-356"> <span class="n">span_response</span><span class="o">.</span><span class="n">set_error</span><span class="p">(</span>
|
|
</span><span id="__span-0-357"> <span class="n">SpanError</span><span class="p">(</span>
|
|
</span><span id="__span-0-358"> <span class="n">message</span><span class="o">=</span><span class="s2">"Error streaming response"</span><span class="p">,</span>
|
|
</span><span id="__span-0-359"> <span class="n">data</span><span class="o">=</span><span class="p">{</span>
|
|
</span><span id="__span-0-360"> <span class="s2">"error"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="k">if</span> <span class="n">tracing</span><span class="o">.</span><span class="n">include_data</span><span class="p">()</span> <span class="k">else</span> <span class="n">e</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
|
|
</span><span id="__span-0-361"> <span class="p">},</span>
|
|
</span><span id="__span-0-362"> <span class="p">)</span>
|
|
</span><span id="__span-0-363"> <span class="p">)</span>
|
|
</span><span id="__span-0-364"> <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 response: </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-365"> <span class="k">raise</span>
|
|
</span><span id="__span-0-366"> <span class="k">finally</span><span class="p">:</span>
|
|
</span><span id="__span-0-367"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-368"> <span class="k">await</span> <span class="n">stream_wait_hints</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
|
|
</span><span id="__span-0-369"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-370"> <span class="k">pass</span>
|
|
</span><span id="__span-0-371">
|
|
</span><span id="__span-0-372"> <span class="nd">@overload</span>
|
|
</span><span id="__span-0-373"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_fetch_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-374"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-375"> <span class="n">system_instructions</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-376"> <span class="nb">input</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">],</span>
|
|
</span><span id="__span-0-377"> <span class="n">model_settings</span><span class="p">:</span> <span class="n">ModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-378"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-379"> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-380"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">],</span>
|
|
</span><span id="__span-0-381"> <span class="n">stream</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="kc">True</span><span class="p">],</span>
|
|
</span><span id="__span-0-382"> <span class="p">)</span> <span class="o">-></span> <span class="n">AsyncStream</span><span class="p">[</span><span class="n">ResponseStreamEvent</span><span class="p">]:</span> <span class="o">...</span>
|
|
</span><span id="__span-0-383">
|
|
</span><span id="__span-0-384"> <span class="nd">@overload</span>
|
|
</span><span id="__span-0-385"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_fetch_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-386"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-387"> <span class="n">system_instructions</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-388"> <span class="nb">input</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">],</span>
|
|
</span><span id="__span-0-389"> <span class="n">model_settings</span><span class="p">:</span> <span class="n">ModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-390"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-391"> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-392"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">],</span>
|
|
</span><span id="__span-0-393"> <span class="n">stream</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="kc">False</span><span class="p">],</span>
|
|
</span><span id="__span-0-394"> <span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">:</span> <span class="o">...</span>
|
|
</span><span id="__span-0-395">
|
|
</span><span id="__span-0-396"> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">_fetch_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-397"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-398"> <span class="n">system_instructions</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-399"> <span class="nb">input</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">],</span>
|
|
</span><span id="__span-0-400"> <span class="n">model_settings</span><span class="p">:</span> <span class="n">ModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-401"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-402"> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-403"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">],</span>
|
|
</span><span id="__span-0-404"> <span class="n">stream</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="kc">True</span><span class="p">]</span> <span class="o">|</span> <span class="n">Literal</span><span class="p">[</span><span class="kc">False</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-0-405"> <span class="p">)</span> <span class="o">-></span> <span class="n">Response</span> <span class="o">|</span> <span class="n">AsyncStream</span><span class="p">[</span><span class="n">ResponseStreamEvent</span><span class="p">]:</span>
|
|
</span><span id="__span-0-406"> <span class="n">list_input</span> <span class="o">=</span> <span class="n">ItemHelpers</span><span class="o">.</span><span class="n">input_to_new_input_list</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span>
|
|
</span><span id="__span-0-407">
|
|
</span><span id="__span-0-408"> <span class="n">parallel_tool_calls</span> <span class="o">=</span> <span class="p">(</span>
|
|
</span><span id="__span-0-409"> <span class="kc">True</span>
|
|
</span><span id="__span-0-410"> <span class="k">if</span> <span class="n">model_settings</span><span class="o">.</span><span class="n">parallel_tool_calls</span> <span class="ow">and</span> <span class="n">tools</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">tools</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span>
|
|
</span><span id="__span-0-411"> <span class="k">else</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-412"> <span class="k">if</span> <span class="n">model_settings</span><span class="o">.</span><span class="n">parallel_tool_calls</span> <span class="ow">is</span> <span class="kc">False</span>
|
|
</span><span id="__span-0-413"> <span class="k">else</span> <span class="n">NOT_GIVEN</span>
|
|
</span><span id="__span-0-414"> <span class="p">)</span>
|
|
</span><span id="__span-0-415">
|
|
</span><span id="__span-0-416"> <span class="n">tool_choice</span> <span class="o">=</span> <span class="n">Converter</span><span class="o">.</span><span class="n">convert_tool_choice</span><span class="p">(</span><span class="n">model_settings</span><span class="o">.</span><span class="n">tool_choice</span><span class="p">)</span>
|
|
</span><span id="__span-0-417"> <span class="n">converted_tools</span> <span class="o">=</span> <span class="n">Converter</span><span class="o">.</span><span class="n">convert_tools</span><span class="p">(</span><span class="n">tools</span><span class="p">,</span> <span class="n">handoffs</span><span class="p">)</span>
|
|
</span><span id="__span-0-418"> <span class="n">response_format</span> <span class="o">=</span> <span class="n">Converter</span><span class="o">.</span><span class="n">get_response_format</span><span class="p">(</span><span class="n">output_schema</span><span class="p">)</span>
|
|
</span><span id="__span-0-419">
|
|
</span><span id="__span-0-420"> <span class="k">if</span> <span class="n">_debug</span><span class="o">.</span><span class="n">DONT_LOG_MODEL_DATA</span><span class="p">:</span>
|
|
</span><span id="__span-0-421"> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Calling LLM"</span><span class="p">)</span>
|
|
</span><span id="__span-0-422"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-423"> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
|
|
</span><span id="__span-0-424"> <span class="sa">f</span><span class="s2">"Calling LLM </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="si">}</span><span class="s2"> with input:</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-425"> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">list_input</span><span class="p">,</span><span class="w"> </span><span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-426"> <span class="sa">f</span><span class="s2">"Tools:</span><span class="se">\n</span><span class="si">{</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">converted_tools</span><span class="o">.</span><span class="n">tools</span><span class="p">,</span><span class="w"> </span><span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-427"> <span class="sa">f</span><span class="s2">"Stream: </span><span class="si">{</span><span class="n">stream</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-428"> <span class="sa">f</span><span class="s2">"Tool choice: </span><span class="si">{</span><span class="n">tool_choice</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-429"> <span class="sa">f</span><span class="s2">"Response format: </span><span class="si">{</span><span class="n">response_format</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span>
|
|
</span><span id="__span-0-430"> <span class="p">)</span>
|
|
</span><span id="__span-0-431">
|
|
</span><span id="__span-0-432"> <span class="k">return</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">responses</span><span class="o">.</span><span class="n">create</span><span class="p">(</span>
|
|
</span><span id="__span-0-433"> <span class="n">instructions</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_non_null_or_not_given</span><span class="p">(</span><span class="n">system_instructions</span><span class="p">),</span>
|
|
</span><span id="__span-0-434"> <span class="n">model</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
|
|
</span><span id="__span-0-435"> <span class="nb">input</span><span class="o">=</span><span class="n">list_input</span><span class="p">,</span>
|
|
</span><span id="__span-0-436"> <span class="n">include</span><span class="o">=</span><span class="n">converted_tools</span><span class="o">.</span><span class="n">includes</span><span class="p">,</span>
|
|
</span><span id="__span-0-437"> <span class="n">tools</span><span class="o">=</span><span class="n">converted_tools</span><span class="o">.</span><span class="n">tools</span><span class="p">,</span>
|
|
</span><span id="__span-0-438"> <span class="n">temperature</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_non_null_or_not_given</span><span class="p">(</span><span class="n">model_settings</span><span class="o">.</span><span class="n">temperature</span><span class="p">),</span>
|
|
</span><span id="__span-0-439"> <span class="n">top_p</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_non_null_or_not_given</span><span class="p">(</span><span class="n">model_settings</span><span class="o">.</span><span class="n">top_p</span><span class="p">),</span>
|
|
</span><span id="__span-0-440"> <span class="n">truncation</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_non_null_or_not_given</span><span class="p">(</span><span class="n">model_settings</span><span class="o">.</span><span class="n">truncation</span><span class="p">),</span>
|
|
</span><span id="__span-0-441"> <span class="n">max_output_tokens</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_non_null_or_not_given</span><span class="p">(</span><span class="n">model_settings</span><span class="o">.</span><span class="n">max_tokens</span><span class="p">),</span>
|
|
</span><span id="__span-0-442"> <span class="n">tool_choice</span><span class="o">=</span><span class="n">tool_choice</span><span class="p">,</span>
|
|
</span><span id="__span-0-443"> <span class="n">parallel_tool_calls</span><span class="o">=</span><span class="n">parallel_tool_calls</span><span class="p">,</span>
|
|
</span><span id="__span-0-444"> <span class="n">stream</span><span class="o">=</span><span class="n">stream</span><span class="p">,</span>
|
|
</span><span id="__span-0-445"> <span class="n">extra_headers</span><span class="o">=</span><span class="n">_HEADERS</span><span class="p">,</span>
|
|
</span><span id="__span-0-446"> <span class="n">text</span><span class="o">=</span><span class="n">response_format</span><span class="p">,</span>
|
|
</span><span id="__span-0-447"> <span class="n">store</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_non_null_or_not_given</span><span class="p">(</span><span class="n">model_settings</span><span class="o">.</span><span class="n">store</span><span class="p">),</span>
|
|
</span><span id="__span-0-448"> <span class="p">)</span>
|
|
</span><span id="__span-0-449">
|
|
</span><span id="__span-0-450"> <span class="k">def</span><span class="w"> </span><span class="nf">_get_client</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncOpenAI</span><span class="p">:</span>
|
|
</span><span id="__span-0-451"> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-452"> <span class="n">api_key</span> <span class="o">=</span> <span class="n">resolve_llm_openai_compatible_api_key</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">))</span>
|
|
</span><span id="__span-0-453"> <span class="k">if</span> <span class="ow">not</span> <span class="n">api_key</span><span class="p">:</span>
|
|
</span><span id="__span-0-454"> <span class="k">raise</span> <span class="n">UserError</span><span class="p">(</span>
|
|
</span><span id="__span-0-455"> <span class="s2">"Missing API key for selected model. "</span>
|
|
</span><span id="__span-0-456"> <span class="s2">"For alias-family models (alias*/cai*/csi*), set ALIAS_API_KEY. "</span>
|
|
</span><span id="__span-0-457"> <span class="s2">"For OpenAI models, set OPENAI_API_KEY."</span>
|
|
</span><span id="__span-0-458"> <span class="p">)</span>
|
|
</span><span id="__span-0-459"> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">AsyncOpenAI</span><span class="p">(</span><span class="n">api_key</span><span class="o">=</span><span class="n">api_key</span><span class="p">)</span>
|
|
</span><span id="__span-0-460"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</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.models.openai_responses.OpenAIResponsesModel.set_agent_name" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">set_agent_name</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">set_agent_name</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Set the agent name for CLI display purposes.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/models/openai_responses.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">70</span>
|
|
<span class="normal">71</span>
|
|
<span class="normal">72</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-70"><span class="k">def</span><span class="w"> </span><span class="nf">set_agent_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-71"><span class="w"> </span><span class="sd">"""Set the agent name for CLI display purposes."""</span>
|
|
</span><span id="__span-0-72"> <span class="bp">self</span><span class="o">.</span><span class="n">agent_name</span> <span class="o">=</span> <span class="n">name</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.models.openai_responses.OpenAIResponsesModel.stream_response" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">stream_response</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_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-2"> <span class="n">system_instructions</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-3"> <span class="nb">input</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="n"><a class="autorefs autorefs-internal" href="../../../tui/commands_reference/#list">list</a></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="../../items/#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span><span class="p">],</span>
|
|
</span><span id="__span-0-4"> <span class="n">model_settings</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="ModelSettings
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.model_settings.ModelSettings)" href="../../model_settings/#cai.sdk.agents.model_settings.ModelSettings">ModelSettings</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-5"> <span class="n">tools</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" href="../../../tui/commands_reference/#list">list</a></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title="Tool
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.tool.Tool)" href="../../tool/#cai.sdk.agents.tool.Tool">Tool</a></span><span class="p">],</span>
|
|
</span><span id="__span-0-6"> <span class="n">output_schema</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="AgentOutputSchema
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent_output.AgentOutputSchema)" href="../../agent_output/#cai.sdk.agents.agent_output.AgentOutputSchema">AgentOutputSchema</a></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-7"> <span class="n">handoffs</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" href="../../../tui/commands_reference/#list">list</a></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title="Handoff
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.handoffs.Handoff)" href="../../handoffs/#cai.sdk.agents.handoffs.Handoff">Handoff</a></span><span class="p">],</span>
|
|
</span><span id="__span-0-8"> <span class="n">tracing</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="ModelTracing (cai.sdk.agents.models.interface.ModelTracing)" href="../interface/#cai.sdk.agents.models.interface.ModelTracing">ModelTracing</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-9"><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"><span title="openai.types.responses.ResponseStreamEvent">ResponseStreamEvent</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Yields a partial message as it is generated, as well as the usage information.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/models/openai_responses.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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>
|
|
<span class="normal">288</span>
|
|
<span class="normal">289</span>
|
|
<span class="normal">290</span>
|
|
<span class="normal">291</span>
|
|
<span class="normal">292</span>
|
|
<span class="normal">293</span>
|
|
<span class="normal">294</span>
|
|
<span class="normal">295</span>
|
|
<span class="normal">296</span>
|
|
<span class="normal">297</span>
|
|
<span class="normal">298</span>
|
|
<span class="normal">299</span>
|
|
<span class="normal">300</span>
|
|
<span class="normal">301</span>
|
|
<span class="normal">302</span>
|
|
<span class="normal">303</span>
|
|
<span class="normal">304</span>
|
|
<span class="normal">305</span>
|
|
<span class="normal">306</span>
|
|
<span class="normal">307</span>
|
|
<span class="normal">308</span>
|
|
<span class="normal">309</span>
|
|
<span class="normal">310</span>
|
|
<span class="normal">311</span>
|
|
<span class="normal">312</span>
|
|
<span class="normal">313</span>
|
|
<span class="normal">314</span>
|
|
<span class="normal">315</span>
|
|
<span class="normal">316</span>
|
|
<span class="normal">317</span>
|
|
<span class="normal">318</span>
|
|
<span class="normal">319</span>
|
|
<span class="normal">320</span>
|
|
<span class="normal">321</span>
|
|
<span class="normal">322</span>
|
|
<span class="normal">323</span>
|
|
<span class="normal">324</span>
|
|
<span class="normal">325</span>
|
|
<span class="normal">326</span>
|
|
<span class="normal">327</span>
|
|
<span class="normal">328</span>
|
|
<span class="normal">329</span>
|
|
<span class="normal">330</span>
|
|
<span class="normal">331</span>
|
|
<span class="normal">332</span>
|
|
<span class="normal">333</span>
|
|
<span class="normal">334</span>
|
|
<span class="normal">335</span>
|
|
<span class="normal">336</span>
|
|
<span class="normal">337</span>
|
|
<span class="normal">338</span>
|
|
<span class="normal">339</span>
|
|
<span class="normal">340</span>
|
|
<span class="normal">341</span>
|
|
<span class="normal">342</span>
|
|
<span class="normal">343</span>
|
|
<span class="normal">344</span>
|
|
<span class="normal">345</span>
|
|
<span class="normal">346</span>
|
|
<span class="normal">347</span>
|
|
<span class="normal">348</span>
|
|
<span class="normal">349</span>
|
|
<span class="normal">350</span>
|
|
<span class="normal">351</span>
|
|
<span class="normal">352</span>
|
|
<span class="normal">353</span>
|
|
<span class="normal">354</span>
|
|
<span class="normal">355</span>
|
|
<span class="normal">356</span>
|
|
<span class="normal">357</span>
|
|
<span class="normal">358</span>
|
|
<span class="normal">359</span>
|
|
<span class="normal">360</span>
|
|
<span class="normal">361</span>
|
|
<span class="normal">362</span>
|
|
<span class="normal">363</span>
|
|
<span class="normal">364</span>
|
|
<span class="normal">365</span>
|
|
<span class="normal">366</span>
|
|
<span class="normal">367</span>
|
|
<span class="normal">368</span>
|
|
<span class="normal">369</span>
|
|
<span class="normal">370</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-247"><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">stream_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-248"> <span class="bp">self</span><span class="p">,</span>
|
|
</span><span id="__span-0-249"> <span class="n">system_instructions</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-250"> <span class="nb">input</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">],</span>
|
|
</span><span id="__span-0-251"> <span class="n">model_settings</span><span class="p">:</span> <span class="n">ModelSettings</span><span class="p">,</span>
|
|
</span><span id="__span-0-252"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-253"> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-254"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">],</span>
|
|
</span><span id="__span-0-255"> <span class="n">tracing</span><span class="p">:</span> <span class="n">ModelTracing</span><span class="p">,</span>
|
|
</span><span id="__span-0-256"><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncIterator</span><span class="p">[</span><span class="n">ResponseStreamEvent</span><span class="p">]:</span>
|
|
</span><span id="__span-0-257"><span class="w"> </span><span class="sd">"""</span>
|
|
</span><span id="__span-0-258"><span class="sd"> Yields a partial message as it is generated, as well as the usage information.</span>
|
|
</span><span id="__span-0-259"><span class="sd"> """</span>
|
|
</span><span id="__span-0-260"> <span class="c1"># Increment the interaction counter for CLI display</span>
|
|
</span><span id="__span-0-261"> <span class="bp">self</span><span class="o">.</span><span class="n">interaction_counter</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
</span><span id="__span-0-262">
|
|
</span><span id="__span-0-263"> <span class="k">with</span> <span class="n">response_span</span><span class="p">(</span><span class="n">disabled</span><span class="o">=</span><span class="n">tracing</span><span class="o">.</span><span class="n">is_disabled</span><span class="p">())</span> <span class="k">as</span> <span class="n">span_response</span><span class="p">:</span>
|
|
</span><span id="__span-0-264"> <span class="n">stream_wait_hints</span> <span class="o">=</span> <span class="n">ModelStreamWaitHints</span><span class="p">()</span>
|
|
</span><span id="__span-0-265"> <span class="k">await</span> <span class="n">stream_wait_hints</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
|
|
</span><span id="__span-0-266"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-267"> <span class="n">stream</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fetch_response</span><span class="p">(</span>
|
|
</span><span id="__span-0-268"> <span class="n">system_instructions</span><span class="p">,</span>
|
|
</span><span id="__span-0-269"> <span class="nb">input</span><span class="p">,</span>
|
|
</span><span id="__span-0-270"> <span class="n">model_settings</span><span class="p">,</span>
|
|
</span><span id="__span-0-271"> <span class="n">tools</span><span class="p">,</span>
|
|
</span><span id="__span-0-272"> <span class="n">output_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-273"> <span class="n">handoffs</span><span class="p">,</span>
|
|
</span><span id="__span-0-274"> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
</span><span id="__span-0-275"> <span class="p">)</span>
|
|
</span><span id="__span-0-276">
|
|
</span><span id="__span-0-277"> <span class="n">final_response</span><span class="p">:</span> <span class="n">Response</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-278">
|
|
</span><span id="__span-0-279"> <span class="k">async</span> <span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">stream</span><span class="p">:</span>
|
|
</span><span id="__span-0-280"> <span class="k">await</span> <span class="n">stream_wait_hints</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
|
|
</span><span id="__span-0-281"> <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">ResponseCompletedEvent</span><span class="p">):</span>
|
|
</span><span id="__span-0-282"> <span class="n">final_response</span> <span class="o">=</span> <span class="n">chunk</span><span class="o">.</span><span class="n">response</span>
|
|
</span><span id="__span-0-283"> <span class="k">yield</span> <span class="n">chunk</span>
|
|
</span><span id="__span-0-284">
|
|
</span><span id="__span-0-285"> <span class="k">if</span> <span class="n">final_response</span> <span class="ow">and</span> <span class="n">tracing</span><span class="o">.</span><span class="n">include_data</span><span class="p">():</span>
|
|
</span><span id="__span-0-286"> <span class="n">span_response</span><span class="o">.</span><span class="n">span_data</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="n">final_response</span>
|
|
</span><span id="__span-0-287"> <span class="n">span_response</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="nb">input</span>
|
|
</span><span id="__span-0-288">
|
|
</span><span id="__span-0-289"> <span class="c1"># Print the agent message for CLI display</span>
|
|
</span><span id="__span-0-290"> <span class="kn">from</span><span class="w"> </span><span class="nn">cai.util</span><span class="w"> </span><span class="kn">import</span> <span class="n">cli_print_agent_messages</span>
|
|
</span><span id="__span-0-291">
|
|
</span><span id="__span-0-292"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-293"> <span class="c1"># Create a message-like object to display</span>
|
|
</span><span id="__span-0-294"> <span class="n">message_obj</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span>
|
|
</span><span id="__span-0-295"> <span class="s2">"ResponseWrapper"</span><span class="p">,</span>
|
|
</span><span id="__span-0-296"> <span class="p">(),</span>
|
|
</span><span id="__span-0-297"> <span class="p">{</span>
|
|
</span><span id="__span-0-298"> <span class="s2">"content"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
|
|
</span><span id="__span-0-299"> <span class="p">[</span>
|
|
</span><span id="__span-0-300"> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"content"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
|
</span><span id="__span-0-301"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"get"</span><span class="p">)</span>
|
|
</span><span id="__span-0-302"> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"text"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
|
</span><span id="__span-0-303"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">final_response</span><span class="o">.</span><span class="n">output</span>
|
|
</span><span id="__span-0-304"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"get"</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"text"</span><span class="p">)</span>
|
|
</span><span id="__span-0-305"> <span class="p">]</span>
|
|
</span><span id="__span-0-306"> <span class="p">),</span>
|
|
</span><span id="__span-0-307"> <span class="s2">"tool_calls"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span id="__span-0-308"> <span class="nb">type</span><span class="p">(</span>
|
|
</span><span id="__span-0-309"> <span class="s2">"ToolCallWrapper"</span><span class="p">,</span>
|
|
</span><span id="__span-0-310"> <span class="p">(),</span>
|
|
</span><span id="__span-0-311"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">arguments</span><span class="p">},</span>
|
|
</span><span id="__span-0-312"> <span class="p">)</span>
|
|
</span><span id="__span-0-313"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">final_response</span><span class="o">.</span><span class="n">output</span>
|
|
</span><span id="__span-0-314"> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">)</span>
|
|
</span><span id="__span-0-315"> <span class="p">],</span>
|
|
</span><span id="__span-0-316"> <span class="p">},</span>
|
|
</span><span id="__span-0-317"> <span class="p">)</span>
|
|
</span><span id="__span-0-318">
|
|
</span><span id="__span-0-319"> <span class="n">cli_print_agent_messages</span><span class="p">(</span>
|
|
</span><span id="__span-0-320"> <span class="n">agent_name</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"agent_name"</span><span class="p">,</span> <span class="s2">"Agent"</span><span class="p">),</span>
|
|
</span><span id="__span-0-321"> <span class="n">message</span><span class="o">=</span><span class="n">message_obj</span><span class="p">,</span>
|
|
</span><span id="__span-0-322"> <span class="n">counter</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"interaction_counter"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-323"> <span class="n">model</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">),</span>
|
|
</span><span id="__span-0-324"> <span class="n">debug</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-0-325"> <span class="n">interaction_input_tokens</span><span class="o">=</span><span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-326"> <span class="n">interaction_output_tokens</span><span class="o">=</span><span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span><span class="p">,</span>
|
|
</span><span id="__span-0-327"> <span class="n">interaction_reasoning_tokens</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
|
</span><span id="__span-0-328"> <span class="n">total_input_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_input_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-329"> <span class="n">total_output_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_output_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-330"> <span class="n">total_reasoning_tokens</span><span class="o">=</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"total_reasoning_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
|
|
</span><span id="__span-0-331"> <span class="n">interaction_cost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-332"> <span class="n">total_cost</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-0-333"> <span class="p">)</span>
|
|
</span><span id="__span-0-334">
|
|
</span><span id="__span-0-335"> <span class="c1"># Update token totals</span>
|
|
</span><span id="__span-0-336"> <span class="bp">self</span><span class="o">.</span><span class="n">total_input_tokens</span> <span class="o">+=</span> <span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span>
|
|
</span><span id="__span-0-337"> <span class="bp">self</span><span class="o">.</span><span class="n">total_output_tokens</span> <span class="o">+=</span> <span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">output_tokens</span>
|
|
</span><span id="__span-0-338">
|
|
</span><span id="__span-0-339"> <span class="c1"># Store actual tokens to align usage metrics with IN: for streamed path</span>
|
|
</span><span id="__span-0-340"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-341"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_actual_input_tokens</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">final_response</span><span class="o">.</span><span class="n">usage</span><span class="o">.</span><span class="n">input_tokens</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-342"> <span class="n">br</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown</span> <span class="ow">or</span> <span class="p">{}</span>
|
|
</span><span id="__span-0-343"> <span class="n">sys_t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"system_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-344"> <span class="n">tool_t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"tool_definitions_tokens"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
</span><span id="__span-0-345"> <span class="n">msg_map</span> <span class="o">=</span> <span class="n">br</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"messages_breakdown"</span><span class="p">,</span> <span class="p">{})</span> <span class="ow">or</span> <span class="p">{}</span>
|
|
</span><span id="__span-0-346"> <span class="n">msg_sum</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">v</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">msg_map</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
|
|
</span><span id="__span-0-347"> <span class="n">known</span> <span class="o">=</span> <span class="n">sys_t</span> <span class="o">+</span> <span class="n">tool_t</span> <span class="o">+</span> <span class="n">msg_sum</span>
|
|
</span><span id="__span-0-348"> <span class="n">overhead</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_last_request_actual_input_tokens</span><span class="p">)</span> <span class="o">-</span> <span class="n">known</span>
|
|
</span><span id="__span-0-349"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown_overhead</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">overhead</span><span class="p">)</span> <span class="k">if</span> <span class="n">overhead</span> <span class="o">></span> <span class="mi">0</span> <span class="k">else</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-350"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-351"> <span class="bp">self</span><span class="o">.</span><span class="n">_last_request_breakdown_overhead</span> <span class="o">=</span> <span class="mi">0</span>
|
|
</span><span id="__span-0-352"> <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-353"> <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 printing agent message: </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-354">
|
|
</span><span id="__span-0-355"> <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-356"> <span class="n">span_response</span><span class="o">.</span><span class="n">set_error</span><span class="p">(</span>
|
|
</span><span id="__span-0-357"> <span class="n">SpanError</span><span class="p">(</span>
|
|
</span><span id="__span-0-358"> <span class="n">message</span><span class="o">=</span><span class="s2">"Error streaming response"</span><span class="p">,</span>
|
|
</span><span id="__span-0-359"> <span class="n">data</span><span class="o">=</span><span class="p">{</span>
|
|
</span><span id="__span-0-360"> <span class="s2">"error"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="k">if</span> <span class="n">tracing</span><span class="o">.</span><span class="n">include_data</span><span class="p">()</span> <span class="k">else</span> <span class="n">e</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
|
|
</span><span id="__span-0-361"> <span class="p">},</span>
|
|
</span><span id="__span-0-362"> <span class="p">)</span>
|
|
</span><span id="__span-0-363"> <span class="p">)</span>
|
|
</span><span id="__span-0-364"> <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 response: </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-365"> <span class="k">raise</span>
|
|
</span><span id="__span-0-366"> <span class="k">finally</span><span class="p">:</span>
|
|
</span><span id="__span-0-367"> <span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-0-368"> <span class="k">await</span> <span class="n">stream_wait_hints</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
|
|
</span><span id="__span-0-369"> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
</span><span id="__span-0-370"> <span class="k">pass</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.models.openai_responses.Converter" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">Converter</span>
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/models/openai_responses.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">469</span>
|
|
<span class="normal">470</span>
|
|
<span class="normal">471</span>
|
|
<span class="normal">472</span>
|
|
<span class="normal">473</span>
|
|
<span class="normal">474</span>
|
|
<span class="normal">475</span>
|
|
<span class="normal">476</span>
|
|
<span class="normal">477</span>
|
|
<span class="normal">478</span>
|
|
<span class="normal">479</span>
|
|
<span class="normal">480</span>
|
|
<span class="normal">481</span>
|
|
<span class="normal">482</span>
|
|
<span class="normal">483</span>
|
|
<span class="normal">484</span>
|
|
<span class="normal">485</span>
|
|
<span class="normal">486</span>
|
|
<span class="normal">487</span>
|
|
<span class="normal">488</span>
|
|
<span class="normal">489</span>
|
|
<span class="normal">490</span>
|
|
<span class="normal">491</span>
|
|
<span class="normal">492</span>
|
|
<span class="normal">493</span>
|
|
<span class="normal">494</span>
|
|
<span class="normal">495</span>
|
|
<span class="normal">496</span>
|
|
<span class="normal">497</span>
|
|
<span class="normal">498</span>
|
|
<span class="normal">499</span>
|
|
<span class="normal">500</span>
|
|
<span class="normal">501</span>
|
|
<span class="normal">502</span>
|
|
<span class="normal">503</span>
|
|
<span class="normal">504</span>
|
|
<span class="normal">505</span>
|
|
<span class="normal">506</span>
|
|
<span class="normal">507</span>
|
|
<span class="normal">508</span>
|
|
<span class="normal">509</span>
|
|
<span class="normal">510</span>
|
|
<span class="normal">511</span>
|
|
<span class="normal">512</span>
|
|
<span class="normal">513</span>
|
|
<span class="normal">514</span>
|
|
<span class="normal">515</span>
|
|
<span class="normal">516</span>
|
|
<span class="normal">517</span>
|
|
<span class="normal">518</span>
|
|
<span class="normal">519</span>
|
|
<span class="normal">520</span>
|
|
<span class="normal">521</span>
|
|
<span class="normal">522</span>
|
|
<span class="normal">523</span>
|
|
<span class="normal">524</span>
|
|
<span class="normal">525</span>
|
|
<span class="normal">526</span>
|
|
<span class="normal">527</span>
|
|
<span class="normal">528</span>
|
|
<span class="normal">529</span>
|
|
<span class="normal">530</span>
|
|
<span class="normal">531</span>
|
|
<span class="normal">532</span>
|
|
<span class="normal">533</span>
|
|
<span class="normal">534</span>
|
|
<span class="normal">535</span>
|
|
<span class="normal">536</span>
|
|
<span class="normal">537</span>
|
|
<span class="normal">538</span>
|
|
<span class="normal">539</span>
|
|
<span class="normal">540</span>
|
|
<span class="normal">541</span>
|
|
<span class="normal">542</span>
|
|
<span class="normal">543</span>
|
|
<span class="normal">544</span>
|
|
<span class="normal">545</span>
|
|
<span class="normal">546</span>
|
|
<span class="normal">547</span>
|
|
<span class="normal">548</span>
|
|
<span class="normal">549</span>
|
|
<span class="normal">550</span>
|
|
<span class="normal">551</span>
|
|
<span class="normal">552</span>
|
|
<span class="normal">553</span>
|
|
<span class="normal">554</span>
|
|
<span class="normal">555</span>
|
|
<span class="normal">556</span>
|
|
<span class="normal">557</span>
|
|
<span class="normal">558</span>
|
|
<span class="normal">559</span>
|
|
<span class="normal">560</span>
|
|
<span class="normal">561</span>
|
|
<span class="normal">562</span>
|
|
<span class="normal">563</span>
|
|
<span class="normal">564</span>
|
|
<span class="normal">565</span>
|
|
<span class="normal">566</span>
|
|
<span class="normal">567</span>
|
|
<span class="normal">568</span>
|
|
<span class="normal">569</span>
|
|
<span class="normal">570</span>
|
|
<span class="normal">571</span>
|
|
<span class="normal">572</span>
|
|
<span class="normal">573</span>
|
|
<span class="normal">574</span>
|
|
<span class="normal">575</span>
|
|
<span class="normal">576</span>
|
|
<span class="normal">577</span>
|
|
<span class="normal">578</span>
|
|
<span class="normal">579</span>
|
|
<span class="normal">580</span>
|
|
<span class="normal">581</span>
|
|
<span class="normal">582</span>
|
|
<span class="normal">583</span>
|
|
<span class="normal">584</span>
|
|
<span class="normal">585</span>
|
|
<span class="normal">586</span>
|
|
<span class="normal">587</span>
|
|
<span class="normal">588</span>
|
|
<span class="normal">589</span>
|
|
<span class="normal">590</span>
|
|
<span class="normal">591</span>
|
|
<span class="normal">592</span>
|
|
<span class="normal">593</span>
|
|
<span class="normal">594</span>
|
|
<span class="normal">595</span>
|
|
<span class="normal">596</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-469"><span class="k">class</span><span class="w"> </span><span class="nc">Converter</span><span class="p">:</span>
|
|
</span><span id="__span-0-470"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-471"> <span class="k">def</span><span class="w"> </span><span class="nf">convert_tool_choice</span><span class="p">(</span>
|
|
</span><span id="__span-0-472"> <span class="bp">cls</span><span class="p">,</span> <span class="n">tool_choice</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"auto"</span><span class="p">,</span> <span class="s2">"required"</span><span class="p">,</span> <span class="s2">"none"</span><span class="p">]</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-473"> <span class="p">)</span> <span class="o">-></span> <span class="n">response_create_params</span><span class="o">.</span><span class="n">ToolChoice</span> <span class="o">|</span> <span class="n">NotGiven</span><span class="p">:</span>
|
|
</span><span id="__span-0-474"> <span class="k">if</span> <span class="n">tool_choice</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-475"> <span class="k">return</span> <span class="n">NOT_GIVEN</span>
|
|
</span><span id="__span-0-476"> <span class="k">elif</span> <span class="n">tool_choice</span> <span class="o">==</span> <span class="s2">"required"</span><span class="p">:</span>
|
|
</span><span id="__span-0-477"> <span class="k">return</span> <span class="s2">"required"</span>
|
|
</span><span id="__span-0-478"> <span class="k">elif</span> <span class="n">tool_choice</span> <span class="o">==</span> <span class="s2">"auto"</span><span class="p">:</span>
|
|
</span><span id="__span-0-479"> <span class="k">return</span> <span class="s2">"auto"</span>
|
|
</span><span id="__span-0-480"> <span class="k">elif</span> <span class="n">tool_choice</span> <span class="o">==</span> <span class="s2">"none"</span><span class="p">:</span>
|
|
</span><span id="__span-0-481"> <span class="k">return</span> <span class="s2">"none"</span>
|
|
</span><span id="__span-0-482"> <span class="k">elif</span> <span class="n">tool_choice</span> <span class="o">==</span> <span class="s2">"file_search"</span><span class="p">:</span>
|
|
</span><span id="__span-0-483"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-484"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"file_search"</span><span class="p">,</span>
|
|
</span><span id="__span-0-485"> <span class="p">}</span>
|
|
</span><span id="__span-0-486"> <span class="k">elif</span> <span class="n">tool_choice</span> <span class="o">==</span> <span class="s2">"web_search_preview"</span><span class="p">:</span>
|
|
</span><span id="__span-0-487"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-488"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"web_search_preview"</span><span class="p">,</span>
|
|
</span><span id="__span-0-489"> <span class="p">}</span>
|
|
</span><span id="__span-0-490"> <span class="k">elif</span> <span class="n">tool_choice</span> <span class="o">==</span> <span class="s2">"computer_use_preview"</span><span class="p">:</span>
|
|
</span><span id="__span-0-491"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-492"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"computer_use_preview"</span><span class="p">,</span>
|
|
</span><span id="__span-0-493"> <span class="p">}</span>
|
|
</span><span id="__span-0-494"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-495"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-496"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"function"</span><span class="p">,</span>
|
|
</span><span id="__span-0-497"> <span class="s2">"name"</span><span class="p">:</span> <span class="n">tool_choice</span><span class="p">,</span>
|
|
</span><span id="__span-0-498"> <span class="p">}</span>
|
|
</span><span id="__span-0-499">
|
|
</span><span id="__span-0-500"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-501"> <span class="k">def</span><span class="w"> </span><span class="nf">get_response_format</span><span class="p">(</span>
|
|
</span><span id="__span-0-502"> <span class="bp">cls</span><span class="p">,</span> <span class="n">output_schema</span><span class="p">:</span> <span class="n">AgentOutputSchema</span> <span class="o">|</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-503"> <span class="p">)</span> <span class="o">-></span> <span class="n">ResponseTextConfigParam</span> <span class="o">|</span> <span class="n">NotGiven</span><span class="p">:</span>
|
|
</span><span id="__span-0-504"> <span class="k">if</span> <span class="n">output_schema</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">output_schema</span><span class="o">.</span><span class="n">is_plain_text</span><span class="p">():</span>
|
|
</span><span id="__span-0-505"> <span class="k">return</span> <span class="n">NOT_GIVEN</span>
|
|
</span><span id="__span-0-506"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-507"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-508"> <span class="s2">"format"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-0-509"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"json_schema"</span><span class="p">,</span>
|
|
</span><span id="__span-0-510"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"final_output"</span><span class="p">,</span>
|
|
</span><span id="__span-0-511"> <span class="s2">"schema"</span><span class="p">:</span> <span class="n">output_schema</span><span class="o">.</span><span class="n">json_schema</span><span class="p">(),</span>
|
|
</span><span id="__span-0-512"> <span class="s2">"strict"</span><span class="p">:</span> <span class="n">output_schema</span><span class="o">.</span><span class="n">strict_json_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-513"> <span class="p">}</span>
|
|
</span><span id="__span-0-514"> <span class="p">}</span>
|
|
</span><span id="__span-0-515">
|
|
</span><span id="__span-0-516"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-517"> <span class="k">def</span><span class="w"> </span><span class="nf">convert_tools</span><span class="p">(</span>
|
|
</span><span id="__span-0-518"> <span class="bp">cls</span><span class="p">,</span>
|
|
</span><span id="__span-0-519"> <span class="n">tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Tool</span><span class="p">],</span>
|
|
</span><span id="__span-0-520"> <span class="n">handoffs</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Handoff</span><span class="p">[</span><span class="n">Any</span><span class="p">]],</span>
|
|
</span><span id="__span-0-521"> <span class="p">)</span> <span class="o">-></span> <span class="n">ConvertedTools</span><span class="p">:</span>
|
|
</span><span id="__span-0-522"> <span class="n">converted_tools</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">ToolParam</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-523"> <span class="n">includes</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">IncludeLiteral</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
</span><span id="__span-0-524">
|
|
</span><span id="__span-0-525"> <span class="n">computer_tools</span> <span class="o">=</span> <span class="p">[</span><span class="n">tool</span> <span class="k">for</span> <span class="n">tool</span> <span class="ow">in</span> <span class="n">tools</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">ComputerTool</span><span class="p">)]</span>
|
|
</span><span id="__span-0-526"> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">computer_tools</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
|
|
</span><span id="__span-0-527"> <span class="k">raise</span> <span class="n">UserError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"You can only provide one computer tool. Got </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">computer_tools</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-0-528">
|
|
</span><span id="__span-0-529"> <span class="k">for</span> <span class="n">tool</span> <span class="ow">in</span> <span class="n">tools</span><span class="p">:</span>
|
|
</span><span id="__span-0-530"> <span class="n">converted_tool</span><span class="p">,</span> <span class="n">include</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_convert_tool</span><span class="p">(</span><span class="n">tool</span><span class="p">)</span>
|
|
</span><span id="__span-0-531"> <span class="n">converted_tools</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">converted_tool</span><span class="p">)</span>
|
|
</span><span id="__span-0-532"> <span class="k">if</span> <span class="n">include</span><span class="p">:</span>
|
|
</span><span id="__span-0-533"> <span class="n">includes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">include</span><span class="p">)</span>
|
|
</span><span id="__span-0-534">
|
|
</span><span id="__span-0-535"> <span class="k">for</span> <span class="n">handoff</span> <span class="ow">in</span> <span class="n">handoffs</span><span class="p">:</span>
|
|
</span><span id="__span-0-536"> <span class="n">converted_tools</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">_convert_handoff_tool</span><span class="p">(</span><span class="n">handoff</span><span class="p">))</span>
|
|
</span><span id="__span-0-537">
|
|
</span><span id="__span-0-538"> <span class="k">return</span> <span class="n">ConvertedTools</span><span class="p">(</span><span class="n">tools</span><span class="o">=</span><span class="n">converted_tools</span><span class="p">,</span> <span class="n">includes</span><span class="o">=</span><span class="n">includes</span><span class="p">)</span>
|
|
</span><span id="__span-0-539">
|
|
</span><span id="__span-0-540"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-541"> <span class="k">def</span><span class="w"> </span><span class="nf">_convert_tool</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">tool</span><span class="p">:</span> <span class="n">Tool</span><span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ToolParam</span><span class="p">,</span> <span class="n">IncludeLiteral</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]:</span>
|
|
</span><span id="__span-0-542"><span class="w"> </span><span class="sd">"""Returns converted tool and includes"""</span>
|
|
</span><span id="__span-0-543">
|
|
</span><span id="__span-0-544"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">FunctionTool</span><span class="p">):</span>
|
|
</span><span id="__span-0-545"> <span class="n">converted_tool</span><span class="p">:</span> <span class="n">ToolParam</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-0-546"> <span class="s2">"name"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
|
|
</span><span id="__span-0-547"> <span class="s2">"parameters"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">params_json_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-548"> <span class="s2">"strict"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">strict_json_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-549"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"function"</span><span class="p">,</span>
|
|
</span><span id="__span-0-550"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
|
|
</span><span id="__span-0-551"> <span class="p">}</span>
|
|
</span><span id="__span-0-552"> <span class="n">includes</span><span class="p">:</span> <span class="n">IncludeLiteral</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-553"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">WebSearchTool</span><span class="p">):</span>
|
|
</span><span id="__span-0-554"> <span class="n">ws</span><span class="p">:</span> <span class="n">WebSearchToolParam</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-0-555"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"web_search_preview"</span><span class="p">,</span>
|
|
</span><span id="__span-0-556"> <span class="s2">"user_location"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">user_location</span><span class="p">,</span>
|
|
</span><span id="__span-0-557"> <span class="s2">"search_context_size"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">search_context_size</span><span class="p">,</span>
|
|
</span><span id="__span-0-558"> <span class="p">}</span>
|
|
</span><span id="__span-0-559"> <span class="n">converted_tool</span> <span class="o">=</span> <span class="n">ws</span>
|
|
</span><span id="__span-0-560"> <span class="n">includes</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-561"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">FileSearchTool</span><span class="p">):</span>
|
|
</span><span id="__span-0-562"> <span class="n">converted_tool</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-0-563"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"file_search"</span><span class="p">,</span>
|
|
</span><span id="__span-0-564"> <span class="s2">"vector_store_ids"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">vector_store_ids</span><span class="p">,</span>
|
|
</span><span id="__span-0-565"> <span class="p">}</span>
|
|
</span><span id="__span-0-566"> <span class="k">if</span> <span class="n">tool</span><span class="o">.</span><span class="n">max_num_results</span><span class="p">:</span>
|
|
</span><span id="__span-0-567"> <span class="n">converted_tool</span><span class="p">[</span><span class="s2">"max_num_results"</span><span class="p">]</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">max_num_results</span>
|
|
</span><span id="__span-0-568"> <span class="k">if</span> <span class="n">tool</span><span class="o">.</span><span class="n">ranking_options</span><span class="p">:</span>
|
|
</span><span id="__span-0-569"> <span class="n">converted_tool</span><span class="p">[</span><span class="s2">"ranking_options"</span><span class="p">]</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">ranking_options</span>
|
|
</span><span id="__span-0-570"> <span class="k">if</span> <span class="n">tool</span><span class="o">.</span><span class="n">filters</span><span class="p">:</span>
|
|
</span><span id="__span-0-571"> <span class="n">converted_tool</span><span class="p">[</span><span class="s2">"filters"</span><span class="p">]</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">filters</span>
|
|
</span><span id="__span-0-572">
|
|
</span><span id="__span-0-573"> <span class="n">includes</span> <span class="o">=</span> <span class="s2">"file_search_call.results"</span> <span class="k">if</span> <span class="n">tool</span><span class="o">.</span><span class="n">include_search_results</span> <span class="k">else</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-574"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">ComputerTool</span><span class="p">):</span>
|
|
</span><span id="__span-0-575"> <span class="n">converted_tool</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-0-576"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"computer_use_preview"</span><span class="p">,</span>
|
|
</span><span id="__span-0-577"> <span class="s2">"environment"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">computer</span><span class="o">.</span><span class="n">environment</span><span class="p">,</span>
|
|
</span><span id="__span-0-578"> <span class="s2">"display_width"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">computer</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
|
|
</span><span id="__span-0-579"> <span class="s2">"display_height"</span><span class="p">:</span> <span class="n">tool</span><span class="o">.</span><span class="n">computer</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
|
|
</span><span id="__span-0-580"> <span class="p">}</span>
|
|
</span><span id="__span-0-581"> <span class="n">includes</span> <span class="o">=</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-582">
|
|
</span><span id="__span-0-583"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-584"> <span class="k">raise</span> <span class="n">UserError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unknown tool type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">tool</span><span class="p">)</span><span class="si">}</span><span class="s2">, tool"</span><span class="p">)</span>
|
|
</span><span id="__span-0-585">
|
|
</span><span id="__span-0-586"> <span class="k">return</span> <span class="n">converted_tool</span><span class="p">,</span> <span class="n">includes</span>
|
|
</span><span id="__span-0-587">
|
|
</span><span id="__span-0-588"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-589"> <span class="k">def</span><span class="w"> </span><span class="nf">_convert_handoff_tool</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">handoff</span><span class="p">:</span> <span class="n">Handoff</span><span class="p">)</span> <span class="o">-></span> <span class="n">ToolParam</span><span class="p">:</span>
|
|
</span><span id="__span-0-590"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-591"> <span class="s2">"name"</span><span class="p">:</span> <span class="n">handoff</span><span class="o">.</span><span class="n">tool_name</span><span class="p">,</span>
|
|
</span><span id="__span-0-592"> <span class="s2">"parameters"</span><span class="p">:</span> <span class="n">handoff</span><span class="o">.</span><span class="n">input_json_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-593"> <span class="s2">"strict"</span><span class="p">:</span> <span class="n">handoff</span><span class="o">.</span><span class="n">strict_json_schema</span><span class="p">,</span>
|
|
</span><span id="__span-0-594"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"function"</span><span class="p">,</span>
|
|
</span><span id="__span-0-595"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">handoff</span><span class="o">.</span><span class="n">tool_description</span><span class="p">,</span>
|
|
</span><span id="__span-0-596"> <span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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> |