mirror of https://github.com/aliasrobotics/cai.git
6160 lines
190 KiB
HTML
6160 lines
190 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="../lifecycle/">
|
|
|
|
|
|
<link rel="next" href="../run_context/">
|
|
|
|
|
|
<link rel="icon" href="../../assets/imago.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
|
|
|
|
|
|
|
|
<title>Items - 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="#items" 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">
|
|
|
|
Items
|
|
|
|
</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--active md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10_1" checked>
|
|
|
|
|
|
<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="true">
|
|
<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 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">
|
|
Items
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Items
|
|
|
|
</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.items" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
items
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponse" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponse
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponseInputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponseInputItem
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponseOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponseOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponseStreamEvent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponseStreamEvent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItemTypes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ToolCallItemTypes
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
RunItem
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
RunItemBase
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="RunItemBase">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
MessageOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="MessageOutputItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
HandoffCallItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="HandoffCallItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
HandoffOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="HandoffOutputItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.source_agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
source_agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.target_agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
target_agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ToolCallItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ToolCallItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ToolCallOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ToolCallOutputItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.output" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
output
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ReasoningItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ReasoningItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ModelResponse
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ModelResponse">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.output" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
output
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.usage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
usage
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.referenceable_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
referenceable_id
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.to_input_items" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_items
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ItemHelpers
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ItemHelpers">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.extract_last_content" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
extract_last_content
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.extract_last_text" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
extract_last_text
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.input_to_new_input_list" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
input_to_new_input_list
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.text_message_outputs" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
text_message_outputs
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.text_message_output" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
text_message_output
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.tool_call_output_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
tool_call_output_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../run_context/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Run Context
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../usage/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Usage
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../exceptions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Exceptions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../guardrail/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guardrail
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../model_settings/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Model Settings
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../agent_output/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent Output
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../function_schema/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Function Schema
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10_2" id="__nav_10_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Models
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Models
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../models/interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../models/openai_chatcompletions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Chat Completions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../models/openai_responses/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Responses
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10_3" id="__nav_10_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Extensions
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Extensions
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../extensions/handoff_filters/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoff Filters
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../extensions/handoff_prompt/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoff Prompt
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_11">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Advanced
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai_development/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Development
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_12" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Research
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_12">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Research
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../research/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_13" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Resources
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_13">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Resources
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai_faq/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
FAQ
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai_find_us/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Find Us
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai_citation_and_acknowledgments/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Citation & Acknowledgments
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
items
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponse" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponse
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponseInputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponseInputItem
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponseOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponseOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.TResponseStreamEvent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
TResponseStreamEvent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItemTypes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ToolCallItemTypes
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
RunItem
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
RunItemBase
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="RunItemBase">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.RunItemBase.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
MessageOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="MessageOutputItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.MessageOutputItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
HandoffCallItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="HandoffCallItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffCallItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
HandoffOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="HandoffOutputItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.source_agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
source_agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.target_agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
target_agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.HandoffOutputItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ToolCallItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ToolCallItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ToolCallOutputItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ToolCallOutputItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.output" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
output
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ToolCallOutputItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ReasoningItem
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ReasoningItem">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem.raw_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
raw_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem.agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ReasoningItem.to_input_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ModelResponse
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ModelResponse">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.output" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
output
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.usage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
usage
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.referenceable_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
referenceable_id
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ModelResponse.to_input_items" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
to_input_items
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
ItemHelpers
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ItemHelpers">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.extract_last_content" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
extract_last_content
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.extract_last_text" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
extract_last_text
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.input_to_new_input_list" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
input_to_new_input_list
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.text_message_outputs" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
text_message_outputs
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.text_message_output" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
text_message_output
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cai.sdk.agents.items.ItemHelpers.tool_call_output_item" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
tool_call_output_item
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="items"><code>Items</code></h1>
|
|
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
|
|
|
|
<a id="cai.sdk.agents.items"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.TResponse" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TResponse</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">TResponse</span> <span class="o">=</span> <span class="n"><span title="openai.types.responses.Response">Response</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A type alias for the Response type.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.TResponseInputItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TResponseInputItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">TResponseInputItem</span> <span class="o">=</span> <span class="n"><span title="openai.types.responses.ResponseInputItemParam">ResponseInputItemParam</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A type alias for the ResponseInputItemParam type.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.TResponseOutputItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TResponseOutputItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">TResponseOutputItem</span> <span class="o">=</span> <span class="n"><span title="openai.types.responses.ResponseOutputItem">ResponseOutputItem</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A type alias for the ResponseOutputItem type.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.TResponseStreamEvent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TResponseStreamEvent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">TResponseStreamEvent</span> <span class="o">=</span> <span class="n"><span title="openai.types.responses.ResponseStreamEvent">ResponseStreamEvent</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A type alias for the ResponseStreamEvent type.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.ToolCallItemTypes" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">ToolCallItemTypes</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">ToolCallItemTypes</span><span class="p">:</span> <span class="n"><span title="typing_extensions.TypeAlias">TypeAlias</span></span> <span class="o">=</span> <span class="n"><span title="typing.Union">Union</span></span><span class="p">[</span>
|
|
</span><span id="__span-0-2"> <span class="n"><span title="openai.types.responses.ResponseFunctionToolCall">ResponseFunctionToolCall</span></span><span class="p">,</span>
|
|
</span><span id="__span-0-3"> <span class="n"><span title="openai.types.responses.ResponseComputerToolCall">ResponseComputerToolCall</span></span><span class="p">,</span>
|
|
</span><span id="__span-0-4"> <span class="n"><span title="openai.types.responses.ResponseFileSearchToolCall">ResponseFileSearchToolCall</span></span><span class="p">,</span>
|
|
</span><span id="__span-0-5"> <span class="n"><span title="openai.types.responses.ResponseFunctionWebSearch">ResponseFunctionWebSearch</span></span><span class="p">,</span>
|
|
</span><span id="__span-0-6"><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A type that represents a tool call item.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.RunItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">RunItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">RunItem</span><span class="p">:</span> <span class="n"><span title="typing_extensions.TypeAlias">TypeAlias</span></span> <span class="o">=</span> <span class="n"><span title="typing.Union">Union</span></span><span class="p">[</span>
|
|
</span><span id="__span-0-2"> <span class="n"><a class="autorefs autorefs-internal" title="MessageOutputItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.MessageOutputItem)" href="#cai.sdk.agents.items.MessageOutputItem">MessageOutputItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-3"> <span class="n"><a class="autorefs autorefs-internal" title="HandoffCallItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.HandoffCallItem)" href="#cai.sdk.agents.items.HandoffCallItem">HandoffCallItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-4"> <span class="n"><a class="autorefs autorefs-internal" title="HandoffOutputItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.HandoffOutputItem)" href="#cai.sdk.agents.items.HandoffOutputItem">HandoffOutputItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-5"> <span class="n"><a class="autorefs autorefs-internal" title="ToolCallItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.ToolCallItem)" href="#cai.sdk.agents.items.ToolCallItem">ToolCallItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-6"> <span class="n"><a class="autorefs autorefs-internal" title="ToolCallOutputItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.ToolCallOutputItem)" href="#cai.sdk.agents.items.ToolCallOutputItem">ToolCallOutputItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-7"> <span class="n"><a class="autorefs autorefs-internal" title="ReasoningItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.ReasoningItem)" href="#cai.sdk.agents.items.ReasoningItem">ReasoningItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-8"><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>An item generated by an agent.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="cai.sdk.agents.items.RunItemBase" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">RunItemBase</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="typing.Generic">Generic</span>[<span title="cai.sdk.agents.items.T">T</span>]</code>, <code><span title="abc.ABC">ABC</span></code></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">47</span>
|
|
<span class="normal">48</span>
|
|
<span class="normal">49</span>
|
|
<span class="normal">50</span>
|
|
<span class="normal">51</span>
|
|
<span class="normal">52</span>
|
|
<span class="normal">53</span>
|
|
<span class="normal">54</span>
|
|
<span class="normal">55</span>
|
|
<span class="normal">56</span>
|
|
<span class="normal">57</span>
|
|
<span class="normal">58</span>
|
|
<span class="normal">59</span>
|
|
<span class="normal">60</span>
|
|
<span class="normal">61</span>
|
|
<span class="normal">62</span>
|
|
<span class="normal">63</span>
|
|
<span class="normal">64</span>
|
|
<span class="normal">65</span>
|
|
<span class="normal">66</span>
|
|
<span class="normal">67</span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-47"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-48"><span class="k">class</span><span class="w"> </span><span class="nc">RunItemBase</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
|
</span><span id="__span-0-49"> <span class="n">agent</span><span class="p">:</span> <span class="n">Agent</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span>
|
|
</span><span id="__span-0-50"><span class="w"> </span><span class="sd">"""The agent whose run caused this item to be generated."""</span>
|
|
</span><span id="__span-0-51">
|
|
</span><span id="__span-0-52"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">T</span>
|
|
</span><span id="__span-0-53"><span class="w"> </span><span class="sd">"""The raw Responses item from the run. This will always be a either an output item (i.e.</span>
|
|
</span><span id="__span-0-54"><span class="sd"> `openai.types.responses.ResponseOutputItem` or an input item</span>
|
|
</span><span id="__span-0-55"><span class="sd"> (i.e. `openai.types.responses.ResponseInputItemParam`).</span>
|
|
</span><span id="__span-0-56"><span class="sd"> """</span>
|
|
</span><span id="__span-0-57">
|
|
</span><span id="__span-0-58"> <span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.RunItemBase.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.RunItemBase.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><span title="cai.sdk.agents.items.T">T</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw Responses item from the run. This will always be a either an output item (i.e.
|
|
<code>openai.types.responses.ResponseOutputItem</code> or an input item
|
|
(i.e. <code>openai.types.responses.ResponseInputItemParam</code>).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.RunItemBase.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.MessageOutputItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">MessageOutputItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="RunItemBase
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.RunItemBase)" href="#cai.sdk.agents.items.RunItemBase">RunItemBase</a>[<span title="openai.types.responses.ResponseOutputMessage">ResponseOutputMessage</span>]</code></p>
|
|
|
|
|
|
<p>Represents a message from the LLM.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.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>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-70"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-71"><span class="k">class</span><span class="w"> </span><span class="nc">MessageOutputItem</span><span class="p">(</span><span class="n">RunItemBase</span><span class="p">[</span><span class="n">ResponseOutputMessage</span><span class="p">]):</span>
|
|
</span><span id="__span-0-72"><span class="w"> </span><span class="sd">"""Represents a message from the LLM."""</span>
|
|
</span><span id="__span-0-73">
|
|
</span><span id="__span-0-74"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">ResponseOutputMessage</span>
|
|
</span><span id="__span-0-75"><span class="w"> </span><span class="sd">"""The raw response output message."""</span>
|
|
</span><span id="__span-0-76">
|
|
</span><span id="__span-0-77"> <span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"message_output_item"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"message_output_item"</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.MessageOutputItem.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><span title="openai.types.responses.ResponseOutputMessage">ResponseOutputMessage</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw response output message.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.MessageOutputItem.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.MessageOutputItem.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.HandoffCallItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">HandoffCallItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="RunItemBase
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.RunItemBase)" href="#cai.sdk.agents.items.RunItemBase">RunItemBase</a>[<span title="openai.types.responses.ResponseFunctionToolCall">ResponseFunctionToolCall</span>]</code></p>
|
|
|
|
|
|
<p>Represents a tool call for a handoff from one agent to another.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-80"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-81"><span class="k">class</span><span class="w"> </span><span class="nc">HandoffCallItem</span><span class="p">(</span><span class="n">RunItemBase</span><span class="p">[</span><span class="n">ResponseFunctionToolCall</span><span class="p">]):</span>
|
|
</span><span id="__span-0-82"><span class="w"> </span><span class="sd">"""Represents a tool call for a handoff from one agent to another."""</span>
|
|
</span><span id="__span-0-83">
|
|
</span><span id="__span-0-84"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">ResponseFunctionToolCall</span>
|
|
</span><span id="__span-0-85"><span class="w"> </span><span class="sd">"""The raw response function tool call that represents the handoff."""</span>
|
|
</span><span id="__span-0-86">
|
|
</span><span id="__span-0-87"> <span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handoff_call_item"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handoff_call_item"</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffCallItem.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><span title="openai.types.responses.ResponseFunctionToolCall">ResponseFunctionToolCall</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw response function tool call that represents the handoff.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffCallItem.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffCallItem.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.HandoffOutputItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">HandoffOutputItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="RunItemBase
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.RunItemBase)" href="#cai.sdk.agents.items.RunItemBase">RunItemBase</a>[<a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a>]</code></p>
|
|
|
|
|
|
<p>Represents the output of a handoff.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-90"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-91"><span class="k">class</span><span class="w"> </span><span class="nc">HandoffOutputItem</span><span class="p">(</span><span class="n">RunItemBase</span><span class="p">[</span><span class="n">TResponseInputItem</span><span class="p">]):</span>
|
|
</span><span id="__span-0-92"><span class="w"> </span><span class="sd">"""Represents the output of a handoff."""</span>
|
|
</span><span id="__span-0-93">
|
|
</span><span id="__span-0-94"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">TResponseInputItem</span>
|
|
</span><span id="__span-0-95"><span class="w"> </span><span class="sd">"""The raw input item that represents the handoff taking place."""</span>
|
|
</span><span id="__span-0-96">
|
|
</span><span id="__span-0-97"> <span class="n">source_agent</span><span class="p">:</span> <span class="n">Agent</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span>
|
|
</span><span id="__span-0-98"><span class="w"> </span><span class="sd">"""The agent that made the handoff."""</span>
|
|
</span><span id="__span-0-99">
|
|
</span><span id="__span-0-100"> <span class="n">target_agent</span><span class="p">:</span> <span class="n">Agent</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span>
|
|
</span><span id="__span-0-101"><span class="w"> </span><span class="sd">"""The agent that is being handed off to."""</span>
|
|
</span><span id="__span-0-102">
|
|
</span><span id="__span-0-103"> <span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handoff_output_item"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handoff_output_item"</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffOutputItem.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw input item that represents the handoff taking place.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffOutputItem.source_agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">source_agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">source_agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent that made the handoff.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffOutputItem.target_agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">target_agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">target_agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent that is being handed off to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffOutputItem.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.HandoffOutputItem.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.ToolCallItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">ToolCallItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="RunItemBase
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.RunItemBase)" href="#cai.sdk.agents.items.RunItemBase">RunItemBase</a>[<a class="autorefs autorefs-internal" title="ToolCallItemTypes
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.ToolCallItemTypes)" href="#cai.sdk.agents.items.ToolCallItemTypes">ToolCallItemTypes</a>]</code></p>
|
|
|
|
|
|
<p>Represents a tool call e.g. a function call or computer action call.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-115"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-116"><span class="k">class</span><span class="w"> </span><span class="nc">ToolCallItem</span><span class="p">(</span><span class="n">RunItemBase</span><span class="p">[</span><span class="n">ToolCallItemTypes</span><span class="p">]):</span>
|
|
</span><span id="__span-0-117"><span class="w"> </span><span class="sd">"""Represents a tool call e.g. a function call or computer action call."""</span>
|
|
</span><span id="__span-0-118">
|
|
</span><span id="__span-0-119"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">ToolCallItemTypes</span>
|
|
</span><span id="__span-0-120"><span class="w"> </span><span class="sd">"""The raw tool call item."""</span>
|
|
</span><span id="__span-0-121">
|
|
</span><span id="__span-0-122"> <span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"tool_call_item"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"tool_call_item"</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallItem.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="ToolCallItemTypes
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.ToolCallItemTypes)" href="#cai.sdk.agents.items.ToolCallItemTypes">ToolCallItemTypes</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw tool call item.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallItem.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallItem.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.ToolCallOutputItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">ToolCallOutputItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="RunItemBase
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.RunItemBase)" href="#cai.sdk.agents.items.RunItemBase">RunItemBase</a>[<span title="typing.Union">Union</span>[<span title="openai.types.responses.response_input_item_param.FunctionCallOutput">FunctionCallOutput</span>, <span title="openai.types.responses.response_input_item_param.ComputerCallOutput">ComputerCallOutput</span>]]</code></p>
|
|
|
|
|
|
<p>Represents the output of a tool call.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-125"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-126"><span class="k">class</span><span class="w"> </span><span class="nc">ToolCallOutputItem</span><span class="p">(</span><span class="n">RunItemBase</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FunctionCallOutput</span><span class="p">,</span> <span class="n">ComputerCallOutput</span><span class="p">]]):</span>
|
|
</span><span id="__span-0-127"><span class="w"> </span><span class="sd">"""Represents the output of a tool call."""</span>
|
|
</span><span id="__span-0-128">
|
|
</span><span id="__span-0-129"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">FunctionCallOutput</span> <span class="o">|</span> <span class="n">ComputerCallOutput</span>
|
|
</span><span id="__span-0-130"><span class="w"> </span><span class="sd">"""The raw item from the model."""</span>
|
|
</span><span id="__span-0-131">
|
|
</span><span id="__span-0-132"> <span class="n">output</span><span class="p">:</span> <span class="n">Any</span>
|
|
</span><span id="__span-0-133"><span class="w"> </span><span class="sd">"""The output of the tool call. This is whatever the tool call returned; the `raw_item`</span>
|
|
</span><span id="__span-0-134"><span class="sd"> contains a string representation of the output.</span>
|
|
</span><span id="__span-0-135"><span class="sd"> """</span>
|
|
</span><span id="__span-0-136">
|
|
</span><span id="__span-0-137"> <span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"tool_call_output_item"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"tool_call_output_item"</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallOutputItem.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><span title="openai.types.responses.response_input_item_param.FunctionCallOutput">FunctionCallOutput</span></span> <span class="o">|</span> <span class="n"><span title="openai.types.responses.response_input_item_param.ComputerCallOutput">ComputerCallOutput</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw item from the model.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallOutputItem.output" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">output</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">output</span><span class="p">:</span> <span class="n"><span title="typing.Any">Any</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The output of the tool call. This is whatever the tool call returned; the <code>raw_item</code>
|
|
contains a string representation of the output.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallOutputItem.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ToolCallOutputItem.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.ReasoningItem" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">ReasoningItem</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="RunItemBase
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.RunItemBase)" href="#cai.sdk.agents.items.RunItemBase">RunItemBase</a>[<span title="openai.types.responses.response_reasoning_item.ResponseReasoningItem">ResponseReasoningItem</span>]</code></p>
|
|
|
|
|
|
<p>Represents a reasoning item.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-140"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-141"><span class="k">class</span><span class="w"> </span><span class="nc">ReasoningItem</span><span class="p">(</span><span class="n">RunItemBase</span><span class="p">[</span><span class="n">ResponseReasoningItem</span><span class="p">]):</span>
|
|
</span><span id="__span-0-142"><span class="w"> </span><span class="sd">"""Represents a reasoning item."""</span>
|
|
</span><span id="__span-0-143">
|
|
</span><span id="__span-0-144"> <span class="n">raw_item</span><span class="p">:</span> <span class="n">ResponseReasoningItem</span>
|
|
</span><span id="__span-0-145"><span class="w"> </span><span class="sd">"""The raw reasoning item."""</span>
|
|
</span><span id="__span-0-146">
|
|
</span><span id="__span-0-147"> <span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"reasoning_item"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"reasoning_item"</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ReasoningItem.raw_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">raw_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">raw_item</span><span class="p">:</span> <span class="n"><span title="openai.types.responses.response_reasoning_item.ResponseReasoningItem">ResponseReasoningItem</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The raw reasoning item.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ReasoningItem.agent" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">agent</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">agent</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Agent
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.agent.Agent)" href="../agent/#cai.sdk.agents.agent.Agent">Agent</a></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The agent whose run caused this item to be generated.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ReasoningItem.to_input_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_item</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_item</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseInputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseInputItem)" href="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts this item into an input item suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-58"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_item</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TResponseInputItem</span><span class="p">:</span>
|
|
</span><span id="__span-0-59"><span class="w"> </span><span class="sd">"""Converts this item into an input item suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-60"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
</span><span id="__span-0-61"> <span class="c1"># We know that input items are dicts, so we can ignore the type error</span>
|
|
</span><span id="__span-0-62"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-63"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">,</span> <span class="n">BaseModel</span><span class="p">):</span>
|
|
</span><span id="__span-0-64"> <span class="c1"># All output items are Pydantic models that can be converted to input items.</span>
|
|
</span><span id="__span-0-65"> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
</span><span id="__span-0-66"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-67"> <span class="k">raise</span> <span class="n">AgentsException</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected raw item type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_item</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</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.items.ModelResponse" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">ModelResponse</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-161"><span class="nd">@dataclass</span>
|
|
</span><span id="__span-0-162"><span class="k">class</span><span class="w"> </span><span class="nc">ModelResponse</span><span class="p">:</span>
|
|
</span><span id="__span-0-163"> <span class="n">output</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">TResponseOutputItem</span><span class="p">]</span>
|
|
</span><span id="__span-0-164"><span class="w"> </span><span class="sd">"""A list of outputs (messages, tool calls, etc) generated by the model"""</span>
|
|
</span><span id="__span-0-165">
|
|
</span><span id="__span-0-166"> <span class="n">usage</span><span class="p">:</span> <span class="n">Usage</span>
|
|
</span><span id="__span-0-167"><span class="w"> </span><span class="sd">"""The usage information for the response."""</span>
|
|
</span><span id="__span-0-168">
|
|
</span><span id="__span-0-169"> <span class="n">referenceable_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-170"><span class="w"> </span><span class="sd">"""An ID for the response which can be used to refer to the response in subsequent calls to the</span>
|
|
</span><span id="__span-0-171"><span class="sd"> model. Not supported by all model providers.</span>
|
|
</span><span id="__span-0-172"><span class="sd"> """</span>
|
|
</span><span id="__span-0-173">
|
|
</span><span id="__span-0-174"> <span class="k">def</span><span class="w"> </span><span class="nf">to_input_items</span><span class="p">(</span><span class="bp">self</span><span class="p">)</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-175"><span class="w"> </span><span class="sd">"""Convert the output into a list of input items suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-176"> <span class="c1"># We happen to know that the shape of the Pydantic output items are the same as the</span>
|
|
</span><span id="__span-0-177"> <span class="c1"># equivalent TypedDict input items, so we can just convert each one.</span>
|
|
</span><span id="__span-0-178"> <span class="c1"># This is also tested via unit tests.</span>
|
|
</span><span id="__span-0-179"> <span class="k">return</span> <span class="p">[</span><span class="n">it</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">for</span> <span class="n">it</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">]</span> <span class="c1"># type: ignore</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ModelResponse.output" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">output</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">output</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="TResponseOutputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseOutputItem)" href="#cai.sdk.agents.items.TResponseOutputItem">TResponseOutputItem</a></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A list of outputs (messages, tool calls, etc) generated by the model</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ModelResponse.usage" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">usage</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">usage</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="Usage
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.usage.Usage)" href="../usage/#cai.sdk.agents.usage.Usage">Usage</a></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>The usage information for the response.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ModelResponse.referenceable_id" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">referenceable_id</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="n">referenceable_id</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>An ID for the response which can be used to refer to the response in subsequent calls to the
|
|
model. Not supported by all model providers.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ModelResponse.to_input_items" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">to_input_items</span>
|
|
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">to_input_items</span><span class="p">()</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="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Convert the output into a list of input items suitable for passing to the model.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-174"><span class="k">def</span><span class="w"> </span><span class="nf">to_input_items</span><span class="p">(</span><span class="bp">self</span><span class="p">)</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-175"><span class="w"> </span><span class="sd">"""Convert the output into a list of input items suitable for passing to the model."""</span>
|
|
</span><span id="__span-0-176"> <span class="c1"># We happen to know that the shape of the Pydantic output items are the same as the</span>
|
|
</span><span id="__span-0-177"> <span class="c1"># equivalent TypedDict input items, so we can just convert each one.</span>
|
|
</span><span id="__span-0-178"> <span class="c1"># This is also tested via unit tests.</span>
|
|
</span><span id="__span-0-179"> <span class="k">return</span> <span class="p">[</span><span class="n">it</span><span class="o">.</span><span class="n">model_dump</span><span class="p">(</span><span class="n">exclude_unset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">for</span> <span class="n">it</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">]</span> <span class="c1"># type: ignore</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.items.ItemHelpers" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">ItemHelpers</span>
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-182"><span class="k">class</span><span class="w"> </span><span class="nc">ItemHelpers</span><span class="p">:</span>
|
|
</span><span id="__span-0-183"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-184"> <span class="k">def</span><span class="w"> </span><span class="nf">extract_last_content</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">TResponseOutputItem</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
</span><span id="__span-0-185"><span class="w"> </span><span class="sd">"""Extracts the last text content or refusal from a message."""</span>
|
|
</span><span id="__span-0-186"> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ResponseOutputMessage</span><span class="p">):</span>
|
|
</span><span id="__span-0-187"> <span class="k">return</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-188">
|
|
</span><span id="__span-0-189"> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
|
|
</span><span id="__span-0-190"> <span class="k">return</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-191">
|
|
</span><span id="__span-0-192"> <span class="n">last_content</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
|
</span><span id="__span-0-193"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">last_content</span><span class="p">,</span> <span class="n">ResponseOutputText</span><span class="p">):</span>
|
|
</span><span id="__span-0-194"> <span class="k">return</span> <span class="n">last_content</span><span class="o">.</span><span class="n">text</span>
|
|
</span><span id="__span-0-195"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">last_content</span><span class="p">,</span> <span class="n">ResponseOutputRefusal</span><span class="p">):</span>
|
|
</span><span id="__span-0-196"> <span class="k">return</span> <span class="n">last_content</span><span class="o">.</span><span class="n">refusal</span>
|
|
</span><span id="__span-0-197"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-198"> <span class="k">raise</span> <span class="n">ModelBehaviorError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected content type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">last_content</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-0-199">
|
|
</span><span id="__span-0-200"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-201"> <span class="k">def</span><span class="w"> </span><span class="nf">extract_last_text</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">TResponseOutputItem</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-202"><span class="w"> </span><span class="sd">"""Extracts the last text content from a message, if any. Ignores refusals."""</span>
|
|
</span><span id="__span-0-203"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ResponseOutputMessage</span><span class="p">):</span>
|
|
</span><span id="__span-0-204"> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
|
|
</span><span id="__span-0-205"> <span class="k">return</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-206"> <span class="n">last_content</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
|
</span><span id="__span-0-207"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">last_content</span><span class="p">,</span> <span class="n">ResponseOutputText</span><span class="p">):</span>
|
|
</span><span id="__span-0-208"> <span class="k">return</span> <span class="n">last_content</span><span class="o">.</span><span class="n">text</span>
|
|
</span><span id="__span-0-209">
|
|
</span><span id="__span-0-210"> <span class="k">return</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-211">
|
|
</span><span id="__span-0-212"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-213"> <span class="k">def</span><span class="w"> </span><span class="nf">input_to_new_input_list</span><span class="p">(</span>
|
|
</span><span id="__span-0-214"> <span class="bp">cls</span><span class="p">,</span> <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-215"> <span class="p">)</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-216"><span class="w"> </span><span class="sd">"""Converts a string or list of input items into a list of input items."""</span>
|
|
</span><span id="__span-0-217"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">input</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
</span><span id="__span-0-218"> <span class="k">return</span> <span class="p">[</span>
|
|
</span><span id="__span-0-219"> <span class="p">{</span>
|
|
</span><span id="__span-0-220"> <span class="s2">"content"</span><span class="p">:</span> <span class="nb">input</span><span class="p">,</span>
|
|
</span><span id="__span-0-221"> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span>
|
|
</span><span id="__span-0-222"> <span class="p">}</span>
|
|
</span><span id="__span-0-223"> <span class="p">]</span>
|
|
</span><span id="__span-0-224"> <span class="k">return</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span>
|
|
</span><span id="__span-0-225">
|
|
</span><span id="__span-0-226"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-227"> <span class="k">def</span><span class="w"> </span><span class="nf">text_message_outputs</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">items</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">RunItem</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
</span><span id="__span-0-228"><span class="w"> </span><span class="sd">"""Concatenates all the text content from a list of message output items."""</span>
|
|
</span><span id="__span-0-229"> <span class="n">text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-230"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
|
|
</span><span id="__span-0-231"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">MessageOutputItem</span><span class="p">):</span>
|
|
</span><span id="__span-0-232"> <span class="n">text</span> <span class="o">+=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">text_message_output</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
|
|
</span><span id="__span-0-233"> <span class="k">return</span> <span class="n">text</span>
|
|
</span><span id="__span-0-234">
|
|
</span><span id="__span-0-235"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-236"> <span class="k">def</span><span class="w"> </span><span class="nf">text_message_output</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">MessageOutputItem</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
</span><span id="__span-0-237"><span class="w"> </span><span class="sd">"""Extracts all the text content from a single message output item."""</span>
|
|
</span><span id="__span-0-238"> <span class="n">text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-239"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
|
|
</span><span id="__span-0-240"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">ResponseOutputText</span><span class="p">):</span>
|
|
</span><span id="__span-0-241"> <span class="n">text</span> <span class="o">+=</span> <span class="n">item</span><span class="o">.</span><span class="n">text</span>
|
|
</span><span id="__span-0-242"> <span class="k">return</span> <span class="n">text</span>
|
|
</span><span id="__span-0-243">
|
|
</span><span id="__span-0-244"> <span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-245"> <span class="k">def</span><span class="w"> </span><span class="nf">tool_call_output_item</span><span class="p">(</span>
|
|
</span><span id="__span-0-246"> <span class="bp">cls</span><span class="p">,</span> <span class="n">tool_call</span><span class="p">:</span> <span class="n">ResponseFunctionToolCall</span><span class="p">,</span> <span class="n">output</span><span class="p">:</span> <span class="nb">str</span>
|
|
</span><span id="__span-0-247"> <span class="p">)</span> <span class="o">-></span> <span class="n">FunctionCallOutput</span><span class="p">:</span>
|
|
</span><span id="__span-0-248"><span class="w"> </span><span class="sd">"""Creates a tool call output item from a tool call and its output."""</span>
|
|
</span><span id="__span-0-249"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-250"> <span class="s2">"call_id"</span><span class="p">:</span> <span class="n">tool_call</span><span class="o">.</span><span class="n">call_id</span><span class="p">,</span>
|
|
</span><span id="__span-0-251"> <span class="s2">"output"</span><span class="p">:</span> <span class="n">output</span><span class="p">,</span>
|
|
</span><span id="__span-0-252"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"function_call_output"</span><span class="p">,</span>
|
|
</span><span id="__span-0-253"> <span class="p">}</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.items.ItemHelpers.extract_last_content" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">extract_last_content</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">extract_last_content</span><span class="p">(</span><span class="n">message</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseOutputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseOutputItem)" href="#cai.sdk.agents.items.TResponseOutputItem">TResponseOutputItem</a></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="str">str</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Extracts the last text content or refusal from a message.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-183"><span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-184"><span class="k">def</span><span class="w"> </span><span class="nf">extract_last_content</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">TResponseOutputItem</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
</span><span id="__span-0-185"><span class="w"> </span><span class="sd">"""Extracts the last text content or refusal from a message."""</span>
|
|
</span><span id="__span-0-186"> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ResponseOutputMessage</span><span class="p">):</span>
|
|
</span><span id="__span-0-187"> <span class="k">return</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-188">
|
|
</span><span id="__span-0-189"> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
|
|
</span><span id="__span-0-190"> <span class="k">return</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-191">
|
|
</span><span id="__span-0-192"> <span class="n">last_content</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
|
</span><span id="__span-0-193"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">last_content</span><span class="p">,</span> <span class="n">ResponseOutputText</span><span class="p">):</span>
|
|
</span><span id="__span-0-194"> <span class="k">return</span> <span class="n">last_content</span><span class="o">.</span><span class="n">text</span>
|
|
</span><span id="__span-0-195"> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">last_content</span><span class="p">,</span> <span class="n">ResponseOutputRefusal</span><span class="p">):</span>
|
|
</span><span id="__span-0-196"> <span class="k">return</span> <span class="n">last_content</span><span class="o">.</span><span class="n">refusal</span>
|
|
</span><span id="__span-0-197"> <span class="k">else</span><span class="p">:</span>
|
|
</span><span id="__span-0-198"> <span class="k">raise</span> <span class="n">ModelBehaviorError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unexpected content type: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">last_content</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ItemHelpers.extract_last_text" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">extract_last_text</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">extract_last_text</span><span class="p">(</span>
|
|
</span><span id="__span-0-2"> <span class="n">message</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="TResponseOutputItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.TResponseOutputItem)" href="#cai.sdk.agents.items.TResponseOutputItem">TResponseOutputItem</a></span><span class="p">,</span>
|
|
</span><span id="__span-0-3"><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Extracts the last text content from a message, if any. Ignores refusals.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-200"><span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-201"><span class="k">def</span><span class="w"> </span><span class="nf">extract_last_text</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">TResponseOutputItem</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
</span><span id="__span-0-202"><span class="w"> </span><span class="sd">"""Extracts the last text content from a message, if any. Ignores refusals."""</span>
|
|
</span><span id="__span-0-203"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ResponseOutputMessage</span><span class="p">):</span>
|
|
</span><span id="__span-0-204"> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
|
|
</span><span id="__span-0-205"> <span class="k">return</span> <span class="kc">None</span>
|
|
</span><span id="__span-0-206"> <span class="n">last_content</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
|
</span><span id="__span-0-207"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">last_content</span><span class="p">,</span> <span class="n">ResponseOutputText</span><span class="p">):</span>
|
|
</span><span id="__span-0-208"> <span class="k">return</span> <span class="n">last_content</span><span class="o">.</span><span class="n">text</span>
|
|
</span><span id="__span-0-209">
|
|
</span><span id="__span-0-210"> <span class="k">return</span> <span class="kc">None</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ItemHelpers.input_to_new_input_list" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">input_to_new_input_list</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">input_to_new_input_list</span><span class="p">(</span>
|
|
</span><span id="__span-0-2"> <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="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span><span class="p">],</span>
|
|
</span><span id="__span-0-3"><span class="p">)</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="#cai.sdk.agents.items.TResponseInputItem">TResponseInputItem</a></span><span class="p">]</span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Converts a string or list of input items into a list of input items.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-212"><span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-213"><span class="k">def</span><span class="w"> </span><span class="nf">input_to_new_input_list</span><span class="p">(</span>
|
|
</span><span id="__span-0-214"> <span class="bp">cls</span><span class="p">,</span> <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-215"><span class="p">)</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-216"><span class="w"> </span><span class="sd">"""Converts a string or list of input items into a list of input items."""</span>
|
|
</span><span id="__span-0-217"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">input</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
</span><span id="__span-0-218"> <span class="k">return</span> <span class="p">[</span>
|
|
</span><span id="__span-0-219"> <span class="p">{</span>
|
|
</span><span id="__span-0-220"> <span class="s2">"content"</span><span class="p">:</span> <span class="nb">input</span><span class="p">,</span>
|
|
</span><span id="__span-0-221"> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span>
|
|
</span><span id="__span-0-222"> <span class="p">}</span>
|
|
</span><span id="__span-0-223"> <span class="p">]</span>
|
|
</span><span id="__span-0-224"> <span class="k">return</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ItemHelpers.text_message_outputs" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">text_message_outputs</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">text_message_outputs</span><span class="p">(</span><span class="n">items</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="RunItem
|
|
|
|
|
|
|
|
module-attribute
|
|
(cai.sdk.agents.items.RunItem)" href="#cai.sdk.agents.items.RunItem">RunItem</a></span><span class="p">])</span> <span class="o">-></span> <span class="n"><span title="str">str</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Concatenates all the text content from a list of message output items.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-226"><span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-227"><span class="k">def</span><span class="w"> </span><span class="nf">text_message_outputs</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">items</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">RunItem</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
</span><span id="__span-0-228"><span class="w"> </span><span class="sd">"""Concatenates all the text content from a list of message output items."""</span>
|
|
</span><span id="__span-0-229"> <span class="n">text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-230"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
|
|
</span><span id="__span-0-231"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">MessageOutputItem</span><span class="p">):</span>
|
|
</span><span id="__span-0-232"> <span class="n">text</span> <span class="o">+=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">text_message_output</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
|
|
</span><span id="__span-0-233"> <span class="k">return</span> <span class="n">text</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ItemHelpers.text_message_output" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">text_message_output</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">text_message_output</span><span class="p">(</span><span class="n">message</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title="MessageOutputItem
|
|
|
|
|
|
|
|
dataclass
|
|
(cai.sdk.agents.items.MessageOutputItem)" href="#cai.sdk.agents.items.MessageOutputItem">MessageOutputItem</a></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="str">str</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Extracts all the text content from a single message output item.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-235"><span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-236"><span class="k">def</span><span class="w"> </span><span class="nf">text_message_output</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">MessageOutputItem</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
</span><span id="__span-0-237"><span class="w"> </span><span class="sd">"""Extracts all the text content from a single message output item."""</span>
|
|
</span><span id="__span-0-238"> <span class="n">text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
</span><span id="__span-0-239"> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">message</span><span class="o">.</span><span class="n">raw_item</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
|
|
</span><span id="__span-0-240"> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">ResponseOutputText</span><span class="p">):</span>
|
|
</span><span id="__span-0-241"> <span class="n">text</span> <span class="o">+=</span> <span class="n">item</span><span class="o">.</span><span class="n">text</span>
|
|
</span><span id="__span-0-242"> <span class="k">return</span> <span class="n">text</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h4 id="cai.sdk.agents.items.ItemHelpers.tool_call_output_item" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">tool_call_output_item</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
</h4>
|
|
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><span class="nf">tool_call_output_item</span><span class="p">(</span>
|
|
</span><span id="__span-0-2"> <span class="n">tool_call</span><span class="p">:</span> <span class="n"><span title="openai.types.responses.ResponseFunctionToolCall">ResponseFunctionToolCall</span></span><span class="p">,</span> <span class="n">output</span><span class="p">:</span> <span class="n"><span title="str">str</span></span>
|
|
</span><span id="__span-0-3"><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="openai.types.responses.response_input_item_param.FunctionCallOutput">FunctionCallOutput</span></span>
|
|
</span></code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Creates a tool call output item from a tool call and its output.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>src/cai/sdk/agents/items.py</code></summary>
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></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></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-244"><span class="nd">@classmethod</span>
|
|
</span><span id="__span-0-245"><span class="k">def</span><span class="w"> </span><span class="nf">tool_call_output_item</span><span class="p">(</span>
|
|
</span><span id="__span-0-246"> <span class="bp">cls</span><span class="p">,</span> <span class="n">tool_call</span><span class="p">:</span> <span class="n">ResponseFunctionToolCall</span><span class="p">,</span> <span class="n">output</span><span class="p">:</span> <span class="nb">str</span>
|
|
</span><span id="__span-0-247"><span class="p">)</span> <span class="o">-></span> <span class="n">FunctionCallOutput</span><span class="p">:</span>
|
|
</span><span id="__span-0-248"><span class="w"> </span><span class="sd">"""Creates a tool call output item from a tool call and its output."""</span>
|
|
</span><span id="__span-0-249"> <span class="k">return</span> <span class="p">{</span>
|
|
</span><span id="__span-0-250"> <span class="s2">"call_id"</span><span class="p">:</span> <span class="n">tool_call</span><span class="o">.</span><span class="n">call_id</span><span class="p">,</span>
|
|
</span><span id="__span-0-251"> <span class="s2">"output"</span><span class="p">:</span> <span class="n">output</span><span class="p">,</span>
|
|
</span><span id="__span-0-252"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"function_call_output"</span><span class="p">,</span>
|
|
</span><span id="__span-0-253"> <span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</div>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "navigation.path", "navigation.sections", "navigation.expand", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |