mirror of https://github.com/aliasrobotics/cai.git
3826 lines
84 KiB
HTML
3826 lines
84 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="../overview/">
|
|
|
|
|
|
<link rel="next" href="../attack_defense/">
|
|
|
|
|
|
<link rel="icon" href="../../assets/imago.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
|
|
|
|
|
|
|
|
<title>Running Benchmarks - 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="#running-benchmarks" 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">
|
|
|
|
Running Benchmarks
|
|
|
|
</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--active md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
|
|
|
|
|
<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="true">
|
|
<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="../overview/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</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">
|
|
Running Benchmarks
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Running Benchmarks
|
|
|
|
</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="#prerequisites" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🔧 Prerequisites
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🔧 Prerequisites">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system-requirements" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
System Requirements
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#required-packages" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Required Packages
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#setup" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📦 Setup
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📦 Setup">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#1-clone-repository-with-submodules" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
1. Clone Repository with Submodules
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#2-configure-api-keys" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
2. Configure API Keys
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#3-verify-setup" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
3. Verify Setup
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#running-benchmarks_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🚀 Running Benchmarks
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🚀 Running Benchmarks">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#basic-command-structure" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Basic Command Structure
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#parameters" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Parameters
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#benchmark-types" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📊 Benchmark Types
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📊 Benchmark Types">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#knowledge-benchmarks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Knowledge Benchmarks
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Knowledge Benchmarks">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cybermetric" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CyberMetric
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#seceval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
SecEval
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cti-bench" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CTI Bench
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#privacy-benchmarks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Privacy Benchmarks
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Privacy Benchmarks">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cyberpii-bench" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CyberPII-Bench
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#output-structure" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📁 Output Structure
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📁 Output Structure">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#example-output-files" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Example Output Files
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#best-practices" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🎯 Best Practices
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🎯 Best Practices">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#1-model-selection" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
1. Model Selection
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#2-save-intervals" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
2. Save Intervals
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#3-parallel-execution" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
3. Parallel Execution
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#4-docker-benchmarks-cai-pro" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
4. Docker Benchmarks (CAI PRO)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#interpreting-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📊 Interpreting Results
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📊 Interpreting Results">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#accuracy-metrics" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Accuracy Metrics
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#comparing-models" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Comparing Models
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#troubleshooting" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🔍 Troubleshooting
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🔍 Troubleshooting">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#common-issues" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Common Issues
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#additional-resources" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📚 Additional Resources
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#next-steps" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🚀 Next Steps
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../attack_defense/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Attack & Defense CTFs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../jeopardy_ctfs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Jeopardy CTFs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../cyber_ranges/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Cyber Ranges
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../knowledge_benchmarks/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Knowledge Benchmarks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../privacy_benchmarks/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Privacy Benchmarks
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guides
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Guides
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../running_agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Running Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../continue_mode/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Continue Mode
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../results/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Working with Results
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../streaming/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Streaming
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tracing/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tracing & Debugging
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../context/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Context Management
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../guardrails/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guardrails & Security
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../environment_variables/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Environment Variables
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai/getting-started/packet_capture_wsl/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Packet Capture on WSL2
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Troubleshooting
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Troubleshooting
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai/troubleshooting/operator_feedback_reproduction/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Operator Feedback Reproduction
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai/troubleshooting/platform_limitations/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Platform Limitations
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Case Studies
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Case Studies
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cai/case-studies/operator-artifact-evidence/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Operator Artifact Evidence
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Mobile UI (iOS)
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Mobile UI (iOS)
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mui/mui_index/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mui/getting_started/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mui/user_interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
User Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mui/gestures_shortcuts/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Gestures & Shortcuts
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mui/chat_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Chat Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Terminal UI (TUI) - Deprecated
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_9">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Terminal UI (TUI) - Deprecated
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/tui_index/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/getting_started/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Getting Started
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/user_interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
User Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/terminals_management/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Terminals Management
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/teams_and_parallel_execution/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Teams & Parallel Execution
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/sidebar_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Sidebar Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/keyboard_shortcuts/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Keyboard Shortcuts
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/commands_reference/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Commands Reference
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/advanced_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Features
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../tui/troubleshooting/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Troubleshooting
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
API Reference
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
API Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_10_1" id="__nav_10_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_10_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_10_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/run/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Runner
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/tool/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tool
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/result/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Result
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/stream_events/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Stream Events
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/handoffs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoffs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/lifecycle/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Lifecycle
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/items/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Items
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/run_context/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Run Context
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/usage/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Usage
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/exceptions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Exceptions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/guardrail/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Guardrail
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/model_settings/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Model Settings
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/agent_output/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent Output
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/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="../../ref/models/interface/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/models/openai_chatcompletions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Chat Completions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/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="../../ref/extensions/handoff_filters/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Handoff Filters
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../ref/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="#prerequisites" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🔧 Prerequisites
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🔧 Prerequisites">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system-requirements" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
System Requirements
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#required-packages" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Required Packages
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#setup" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📦 Setup
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📦 Setup">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#1-clone-repository-with-submodules" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
1. Clone Repository with Submodules
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#2-configure-api-keys" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
2. Configure API Keys
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#3-verify-setup" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
3. Verify Setup
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#running-benchmarks_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🚀 Running Benchmarks
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🚀 Running Benchmarks">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#basic-command-structure" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Basic Command Structure
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#parameters" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Parameters
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#benchmark-types" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📊 Benchmark Types
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📊 Benchmark Types">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#knowledge-benchmarks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Knowledge Benchmarks
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Knowledge Benchmarks">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cybermetric" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CyberMetric
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#seceval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
SecEval
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cti-bench" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CTI Bench
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#privacy-benchmarks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Privacy Benchmarks
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Privacy Benchmarks">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cyberpii-bench" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
CyberPII-Bench
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#output-structure" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📁 Output Structure
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📁 Output Structure">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#example-output-files" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Example Output Files
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#best-practices" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🎯 Best Practices
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🎯 Best Practices">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#1-model-selection" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
1. Model Selection
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#2-save-intervals" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
2. Save Intervals
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#3-parallel-execution" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
3. Parallel Execution
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#4-docker-benchmarks-cai-pro" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
4. Docker Benchmarks (CAI PRO)
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#interpreting-results" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📊 Interpreting Results
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="📊 Interpreting Results">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#accuracy-metrics" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Accuracy Metrics
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#comparing-models" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Comparing Models
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#troubleshooting" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🔍 Troubleshooting
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="🔍 Troubleshooting">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#common-issues" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Common Issues
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#additional-resources" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
📚 Additional Resources
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#next-steps" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
🚀 Next Steps
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="running-benchmarks">Running Benchmarks</h1>
|
|
<p>This guide explains how to set up and run CAIBench evaluations to assess AI model performance across cybersecurity tasks.</p>
|
|
<hr />
|
|
<h2 id="prerequisites">🔧 Prerequisites</h2>
|
|
<h3 id="system-requirements">System Requirements</h3>
|
|
<ul>
|
|
<li>Python 3.8 or higher</li>
|
|
<li>Docker (for CTF and Cyber Range benchmarks)</li>
|
|
<li>Git with submodule support</li>
|
|
<li>At least 8GB RAM recommended</li>
|
|
<li>20GB free disk space for benchmark containers</li>
|
|
</ul>
|
|
<h3 id="required-packages">Required Packages</h3>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><span class="c1"># Install base dependencies</span>
|
|
</span><span id="__span-0-2">pip<span class="w"> </span>install<span class="w"> </span>cai-framework
|
|
</span><span id="__span-0-3">
|
|
</span><span id="__span-0-4"><span class="c1"># Install benchmark-specific requirements</span>
|
|
</span><span id="__span-0-5">pip<span class="w"> </span>install<span class="w"> </span>cvss
|
|
</span></code></pre></div>
|
|
<hr />
|
|
<h2 id="setup">📦 Setup</h2>
|
|
<h3 id="1-clone-repository-with-submodules">1. Clone Repository with Submodules</h3>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1">git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aliasrobotics/cai.git
|
|
</span><span id="__span-1-2"><span class="nb">cd</span><span class="w"> </span>cai
|
|
</span><span id="__span-1-3">git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init<span class="w"> </span>--recursive
|
|
</span></code></pre></div>
|
|
<h3 id="2-configure-api-keys">2. Configure API Keys</h3>
|
|
<p>Create a <code>.env</code> file in the project root:</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><span class="c1"># For alias1 (CAI PRO)</span>
|
|
</span><span id="__span-2-2"><span class="nv">ALIAS_API_KEY</span><span class="o">=</span><span class="s2">"sk-your-caipro-key"</span>
|
|
</span><span id="__span-2-3">
|
|
</span><span id="__span-2-4"><span class="c1"># For OpenAI models</span>
|
|
</span><span id="__span-2-5"><span class="nv">OPENAI_API_KEY</span><span class="o">=</span><span class="s2">"sk-..."</span>
|
|
</span><span id="__span-2-6">
|
|
</span><span id="__span-2-7"><span class="c1"># For Anthropic models</span>
|
|
</span><span id="__span-2-8"><span class="nv">ANTHROPIC_API_KEY</span><span class="o">=</span><span class="s2">"sk-ant-..."</span>
|
|
</span><span id="__span-2-9">
|
|
</span><span id="__span-2-10"><span class="c1"># For DeepSeek models</span>
|
|
</span><span id="__span-2-11"><span class="nv">DEEPSEEK_API_KEY</span><span class="o">=</span><span class="s2">"sk-..."</span>
|
|
</span><span id="__span-2-12">
|
|
</span><span id="__span-2-13"><span class="c1"># For OpenRouter (access to 200+ models)</span>
|
|
</span><span id="__span-2-14"><span class="nv">OPENROUTER_API_KEY</span><span class="o">=</span><span class="s2">"sk-or-..."</span>
|
|
</span><span id="__span-2-15"><span class="nv">OPENROUTER_API_BASE</span><span class="o">=</span><span class="s2">"https://openrouter.ai/api/v1"</span>
|
|
</span><span id="__span-2-16">
|
|
</span><span id="__span-2-17"><span class="c1"># For Ollama (local models)</span>
|
|
</span><span id="__span-2-18"><span class="nv">OLLAMA_API_BASE</span><span class="o">=</span><span class="s2">"http://localhost:11434/v1"</span>
|
|
</span></code></pre></div>
|
|
<h3 id="3-verify-setup">3. Verify Setup</h3>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><span class="c1"># Test basic functionality</span>
|
|
</span><span id="__span-3-2">python<span class="w"> </span>-c<span class="w"> </span><span class="s2">"from cai import cli; print('CAI installed successfully!')"</span>
|
|
</span><span id="__span-3-3">
|
|
</span><span id="__span-3-4"><span class="c1"># Check benchmarks directory</span>
|
|
</span><span id="__span-3-5">ls<span class="w"> </span>benchmarks/
|
|
</span></code></pre></div>
|
|
<hr />
|
|
<h2 id="running-benchmarks_1">🚀 Running Benchmarks</h2>
|
|
<h3 id="basic-command-structure">Basic Command Structure</h3>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-4-2"><span class="w"> </span>--model<span class="w"> </span>MODEL_NAME<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-4-3"><span class="w"> </span>--dataset_file<span class="w"> </span>INPUT_FILE<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-4-4"><span class="w"> </span>--eval<span class="w"> </span>EVAL_TYPE<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-4-5"><span class="w"> </span>--backend<span class="w"> </span>BACKEND<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-4-6"><span class="w"> </span><span class="o">[</span>--save_interval<span class="w"> </span>N<span class="o">]</span>
|
|
</span></code></pre></div>
|
|
<h3 id="parameters">Parameters</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
<th>Example</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--model</code> / <code>-m</code></td>
|
|
<td>Model identifier</td>
|
|
<td>✅ Yes</td>
|
|
<td><code>alias1</code>, <code>gpt-4o</code>, <code>ollama/qwen2.5:14b</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--dataset_file</code> / <code>-d</code></td>
|
|
<td>Path to benchmark dataset</td>
|
|
<td>✅ Yes</td>
|
|
<td><code>benchmarks/cybermetric/CyberMetric-2-v1.json</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--eval</code> / <code>-e</code></td>
|
|
<td>Benchmark type</td>
|
|
<td>✅ Yes</td>
|
|
<td><code>cybermetric</code>, <code>seceval</code>, <code>cti_bench</code>, <code>cyberpii-bench</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--backend</code> / <code>-B</code></td>
|
|
<td>API backend</td>
|
|
<td>✅ Yes</td>
|
|
<td><code>alias</code>, <code>openai</code>, <code>anthropic</code>, <code>ollama</code>, <code>openrouter</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--save_interval</code> / <code>-s</code></td>
|
|
<td>Save results every N questions</td>
|
|
<td>❌ No</td>
|
|
<td><code>10</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr />
|
|
<h2 id="benchmark-types">📊 Benchmark Types</h2>
|
|
<h3 id="knowledge-benchmarks">Knowledge Benchmarks</h3>
|
|
<h4 id="cybermetric">CyberMetric</h4>
|
|
<p>Measures performance on cybersecurity-specific question answering and contextual understanding.</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><span class="c1"># Using alias1 (CAI PRO)</span>
|
|
</span><span id="__span-5-2">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-3"><span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-4"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cybermetric/CyberMetric-2-v1.json<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-5"><span class="w"> </span>--eval<span class="w"> </span>cybermetric<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-6"><span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span><span id="__span-5-7">
|
|
</span><span id="__span-5-8"><span class="c1"># Using Ollama with Qwen</span>
|
|
</span><span id="__span-5-9">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-10"><span class="w"> </span>--model<span class="w"> </span>ollama/qwen2.5:14b<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-11"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cybermetric/CyberMetric-2-v1.json<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-12"><span class="w"> </span>--eval<span class="w"> </span>cybermetric<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-13"><span class="w"> </span>--backend<span class="w"> </span>ollama
|
|
</span><span id="__span-5-14">
|
|
</span><span id="__span-5-15"><span class="c1"># Using OpenAI GPT-4o</span>
|
|
</span><span id="__span-5-16">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-17"><span class="w"> </span>--model<span class="w"> </span>gpt-4o-mini<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-18"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cybermetric/CyberMetric-2-v1.json<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-19"><span class="w"> </span>--eval<span class="w"> </span>cybermetric<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-5-20"><span class="w"> </span>--backend<span class="w"> </span>openai
|
|
</span></code></pre></div>
|
|
<h4 id="seceval">SecEval</h4>
|
|
<p>Evaluates LLMs on security-related tasks like phishing analysis and vulnerability classification.</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-6-1"><span class="c1"># Using Anthropic Claude</span>
|
|
</span><span id="__span-6-2">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-3"><span class="w"> </span>--model<span class="w"> </span>claude-3-7-sonnet-20250219<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-4"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/seceval/eval/datasets/questions-2.json<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-5"><span class="w"> </span>--eval<span class="w"> </span>seceval<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-6"><span class="w"> </span>--backend<span class="w"> </span>anthropic
|
|
</span><span id="__span-6-7">
|
|
</span><span id="__span-6-8"><span class="c1"># Using alias1</span>
|
|
</span><span id="__span-6-9">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-10"><span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-11"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/seceval/eval/datasets/questions-2.json<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-12"><span class="w"> </span>--eval<span class="w"> </span>seceval<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-13"><span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span></code></pre></div>
|
|
<h4 id="cti-bench">CTI Bench</h4>
|
|
<p>Evaluates Cyber Threat Intelligence understanding and processing.</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><span class="c1"># Using OpenRouter with Qwen</span>
|
|
</span><span id="__span-7-2">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-3"><span class="w"> </span>--model<span class="w"> </span>qwen/qwen3-32b:free<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-4"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cti_bench/data/cti-mcq1.tsv<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-5"><span class="w"> </span>--eval<span class="w"> </span>cti_bench<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-6"><span class="w"> </span>--backend<span class="w"> </span>openrouter
|
|
</span><span id="__span-7-7">
|
|
</span><span id="__span-7-8"><span class="c1"># Multiple CTI Bench variants</span>
|
|
</span><span id="__span-7-9">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-10"><span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-11"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cti_bench/data/cti-ate2.tsv<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-12"><span class="w"> </span>--eval<span class="w"> </span>cti_bench<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-7-13"><span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span></code></pre></div>
|
|
<h3 id="privacy-benchmarks">Privacy Benchmarks</h3>
|
|
<h4 id="cyberpii-bench">CyberPII-Bench</h4>
|
|
<p>Evaluates ability to identify and sanitize Personally Identifiable Information.</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><span class="c1"># Using alias1 (recommended for best privacy protection)</span>
|
|
</span><span id="__span-8-2">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-8-3"><span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-8-4"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cyberPII-bench/memory01_gold.csv<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-8-5"><span class="w"> </span>--eval<span class="w"> </span>cyberpii-bench<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-8-6"><span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span></code></pre></div>
|
|
<p><strong><a href="../privacy_benchmarks/">Learn more about privacy benchmarks →</a></strong></p>
|
|
<hr />
|
|
<h2 id="output-structure">📁 Output Structure</h2>
|
|
<p>Results are automatically saved to structured directories:</p>
|
|
<div class="language-text highlight"><pre><span></span><code><span id="__span-9-1">outputs/
|
|
</span><span id="__span-9-2">└── benchmark_name/
|
|
</span><span id="__span-9-3"> └── model_YYYYMMDD_random-id/
|
|
</span><span id="__span-9-4"> ├── answers.json # Complete test with LLM responses
|
|
</span><span id="__span-9-5"> ├── information.txt # Performance metrics and metadata
|
|
</span><span id="__span-9-6"> ├── entity_performance.txt # (Privacy benchmarks only)
|
|
</span><span id="__span-9-7"> ├── metrics.txt # (Privacy benchmarks only)
|
|
</span><span id="__span-9-8"> ├── mistakes.txt # (Privacy benchmarks only)
|
|
</span><span id="__span-9-9"> └── overall_report.txt # (Privacy benchmarks only)
|
|
</span></code></pre></div>
|
|
<h3 id="example-output-files">Example Output Files</h3>
|
|
<p><strong>information.txt:</strong>
|
|
<div class="language-text highlight"><pre><span></span><code><span id="__span-10-1">Model: alias1
|
|
</span><span id="__span-10-2">Benchmark: cybermetric
|
|
</span><span id="__span-10-3">Accuracy: 87.5%
|
|
</span><span id="__span-10-4">Total Questions: 100
|
|
</span><span id="__span-10-5">Correct: 87
|
|
</span><span id="__span-10-6">Incorrect: 13
|
|
</span><span id="__span-10-7">Runtime: 245 seconds
|
|
</span><span id="__span-10-8">Date: 2025-01-15
|
|
</span></code></pre></div></p>
|
|
<p><strong>answers.json:</strong>
|
|
<div class="language-json highlight"><pre><span></span><code><span id="__span-11-1"><span class="p">{</span>
|
|
</span><span id="__span-11-2"><span class="w"> </span><span class="nt">"question_1"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-11-3"><span class="w"> </span><span class="nt">"prompt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"What is SQL injection?"</span><span class="p">,</span>
|
|
</span><span id="__span-11-4"><span class="w"> </span><span class="nt">"expected"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A code injection technique..."</span><span class="p">,</span>
|
|
</span><span id="__span-11-5"><span class="w"> </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SQL injection is..."</span><span class="p">,</span>
|
|
</span><span id="__span-11-6"><span class="w"> </span><span class="nt">"correct"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
|
|
</span><span id="__span-11-7"><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-11-8"><span class="p">}</span>
|
|
</span></code></pre></div></p>
|
|
<hr />
|
|
<h2 id="best-practices">🎯 Best Practices</h2>
|
|
<h3 id="1-model-selection">1. Model Selection</h3>
|
|
<div class="admonition success">
|
|
<p class="admonition-title">Recommended: Use alias1</p>
|
|
<p>For all cybersecurity benchmarks, <strong><code>alias1</code> consistently achieves the highest scores</strong>.</p>
|
|
<ul>
|
|
<li>🥇 Best performance across all benchmark categories</li>
|
|
<li>✅ Zero refusals for security-related questions</li>
|
|
<li>🚀 Optimized for cybersecurity tasks</li>
|
|
</ul>
|
|
<p><strong><a href="../../cai_pro/">Get alias1 with CAI PRO →</a></strong></p>
|
|
</div>
|
|
<h3 id="2-save-intervals">2. Save Intervals</h3>
|
|
<p>For long-running benchmarks, use <code>--save_interval</code> to save intermediate results:</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-12-1">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-2"><span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-3"><span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cybermetric/CyberMetric-2-v1.json<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-4"><span class="w"> </span>--eval<span class="w"> </span>cybermetric<span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-5"><span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-6"><span class="w"> </span>--save_interval<span class="w"> </span><span class="m">25</span><span class="w"> </span><span class="c1"># Save every 25 questions</span>
|
|
</span></code></pre></div>
|
|
<h3 id="3-parallel-execution">3. Parallel Execution</h3>
|
|
<p>Run multiple benchmarks in parallel (different terminals):</p>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-13-1"><span class="c1"># Terminal 1: CyberMetric</span>
|
|
</span><span id="__span-13-2">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cybermetric/CyberMetric-2-v1.json<span class="w"> </span>--eval<span class="w"> </span>cybermetric<span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span><span id="__span-13-3">
|
|
</span><span id="__span-13-4"><span class="c1"># Terminal 2: SecEval</span>
|
|
</span><span id="__span-13-5">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/seceval/eval/datasets/questions-2.json<span class="w"> </span>--eval<span class="w"> </span>seceval<span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span><span id="__span-13-6">
|
|
</span><span id="__span-13-7"><span class="c1"># Terminal 3: CTI Bench</span>
|
|
</span><span id="__span-13-8">python<span class="w"> </span>benchmarks/eval.py<span class="w"> </span>--model<span class="w"> </span>alias1<span class="w"> </span>--dataset_file<span class="w"> </span>benchmarks/cti_bench/data/cti-mcq1.tsv<span class="w"> </span>--eval<span class="w"> </span>cti_bench<span class="w"> </span>--backend<span class="w"> </span><span class="nb">alias</span>
|
|
</span></code></pre></div>
|
|
<h3 id="4-docker-benchmarks-cai-pro">4. Docker Benchmarks (CAI PRO)</h3>
|
|
<p>For Jeopardy CTF, Attack & Defense, and Cyber Range benchmarks:</p>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">CAI PRO Exclusive</p>
|
|
<p>Docker-based benchmarks (CTFs, A&D, Cyber Ranges) are available exclusively with <strong><a href="../../cai_pro/">CAI PRO</a></strong>.</p>
|
|
<p>Contact research@aliasrobotics.com for access.</p>
|
|
</div>
|
|
<hr />
|
|
<h2 id="interpreting-results">📊 Interpreting Results</h2>
|
|
<h3 id="accuracy-metrics">Accuracy Metrics</h3>
|
|
<p>Different benchmarks use different metrics:</p>
|
|
<ul>
|
|
<li><strong>Knowledge Benchmarks</strong>: Accuracy (% correct answers)</li>
|
|
<li><strong>Privacy Benchmarks</strong>: Precision, Recall, F1, F2 scores</li>
|
|
<li><strong>CTF Benchmarks</strong>: Success rate (% challenges solved)</li>
|
|
<li><strong>A&D Benchmarks</strong>: Points scored (offensive + defensive)</li>
|
|
</ul>
|
|
<h3 id="comparing-models">Comparing Models</h3>
|
|
<p>When comparing models, consider:</p>
|
|
<ol>
|
|
<li><strong>Overall Accuracy</strong> - Higher is better</li>
|
|
<li><strong>Response Quality</strong> - Check answers.json for reasoning</li>
|
|
<li><strong>Refusal Rate</strong> - How often the model refuses to answer</li>
|
|
<li><strong>Runtime</strong> - Time to complete benchmark</li>
|
|
<li><strong>Consistency</strong> - Run multiple times for statistical significance</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="troubleshooting">🔍 Troubleshooting</h2>
|
|
<h3 id="common-issues">Common Issues</h3>
|
|
<p><strong>Issue: "Module not found" errors</strong>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-14-1"><span class="c1"># Solution: Update submodules</span>
|
|
</span><span id="__span-14-2">git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init<span class="w"> </span>--recursive
|
|
</span><span id="__span-14-3">pip<span class="w"> </span>install<span class="w"> </span>cvss
|
|
</span></code></pre></div></p>
|
|
<p><strong>Issue: "API key not found"</strong>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-15-1"><span class="c1"># Solution: Verify .env file exists and has correct format</span>
|
|
</span><span id="__span-15-2">cat<span class="w"> </span>.env
|
|
</span><span id="__span-15-3"><span class="c1"># Should show: BACKEND_API_KEY="sk-..."</span>
|
|
</span></code></pre></div></p>
|
|
<p><strong>Issue: Docker containers fail to start</strong>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-16-1"><span class="c1"># Solution: Check Docker daemon</span>
|
|
</span><span id="__span-16-2">docker<span class="w"> </span>ps
|
|
</span><span id="__span-16-3">sudo<span class="w"> </span>systemctl<span class="w"> </span>start<span class="w"> </span>docker<span class="w"> </span><span class="c1"># Linux</span>
|
|
</span></code></pre></div></p>
|
|
<p><strong>Issue: Out of memory errors</strong>
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-17-1"><span class="c1"># Solution: Use smaller models or increase system RAM</span>
|
|
</span><span id="__span-17-2"><span class="c1"># Alternative: Run benchmarks with save intervals</span>
|
|
</span><span id="__span-17-3">--save_interval<span class="w"> </span><span class="m">10</span>
|
|
</span></code></pre></div></p>
|
|
<hr />
|
|
<h2 id="additional-resources">📚 Additional Resources</h2>
|
|
<ul>
|
|
<li>📊 <a href="https://arxiv.org/pdf/2510.24317">CAIBench Research Paper</a></li>
|
|
<li>🎯 <a href="https://arxiv.org/pdf/2510.17521">A&D CTF Evaluation Paper</a></li>
|
|
<li>💻 <a href="https://github.com/aliasrobotics/cai/tree/main/benchmarks">GitHub Repository</a></li>
|
|
<li>📖 <a href="../knowledge_benchmarks/">Knowledge Benchmarks Guide</a></li>
|
|
<li>🔒 <a href="../privacy_benchmarks/">Privacy Benchmarks Guide</a></li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="next-steps">🚀 Next Steps</h2>
|
|
<ol>
|
|
<li><strong><a href="../attack_defense/">View A&D Benchmark Results</a></strong> - See alias1's superior performance</li>
|
|
<li><strong><a href="../jeopardy_ctfs/">Explore Jeopardy CTFs</a></strong> - Learn about CTF benchmarks</li>
|
|
<li><strong><a href="../../cai_pro/">Upgrade to CAI PRO</a></strong> - Get unlimited alias1 access and exclusive benchmarks</li>
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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> |