From 9a3d3e89e66091057e3d42efe949521a9acf6279 Mon Sep 17 00:00:00 2001 From: Jonas Helming Date: Mon, 21 Oct 2024 09:43:07 +0200 Subject: [PATCH] Add documentations for custom agents fixed #625 --- src/docs/user_ai.md | 26 ++++++++++++++++++++++++++ static/add-custom-agents.png | Bin 0 -> 4642 bytes 2 files changed, 26 insertions(+) create mode 100644 static/add-custom-agents.png diff --git a/src/docs/user_ai.md b/src/docs/user_ai.md index 21bd1e6e..f5b7df6d 100644 --- a/src/docs/user_ai.md +++ b/src/docs/user_ai.md @@ -25,6 +25,7 @@ Theia AI features within the Theia IDE are currently disabled by default. See th - [Chat](#chat) - [AI Configuration](#ai-configuration) - [View and Modify Prompts](#view-and-modify-prompts) +- [Custom Agents](#custom-agents) - [AI History](#ai-history) - [Learn more](#learn-more) @@ -132,6 +133,31 @@ Tool functions are used with the following syntax: ``` ~{functionName} ``` +## Custom Agents + +Custom agents enable users to define new chat agents with custom prompts on the fly, allowing the creation of custom workflows and extending the Theia IDE with new capabilities. These agents are immediately available in the default chat. + +To define a new custom agent, navigate to the AI Configuration View and click on "Add Custom Agent". + +Add a custom Agents in the Theia IDE + +This action opens a YAML file where all available custom agents are defined. Below is an example configuration: + +```yaml +- id: obfuscator + name: Obfuscator + description: This is an example agent. Please adapt the properties to fit your needs. + prompt: Obfuscate the following code so that no human can understand it anymore. Preserve the functionality. + defaultLLM: openai/gpt-4o +``` + +- id: A unique identifier for the agent. +- name: The display name of the agent. +- description: A brief explanation of what the agent does. +- prompt: The default prompt that the agent will use for processing requests. +- defaultLLM: The language model used by default. + +Custom agents can be configured in the AI Configuration View just like other chat agents. You can enable/disable them, modify their prompt templates, and integrate variables and functions within these templates to enhance functionality. ## AI History diff --git a/static/add-custom-agents.png b/static/add-custom-agents.png new file mode 100644 index 0000000000000000000000000000000000000000..42de897d8d11044750f34c013bb527d815bdd634 GIT binary patch literal 4642 zcmcJTS2P^nx5p(ybb=rPM)%DEiF4hY=rIHP~UyugE*#Qan@fI|LdpT1mfUEj} z1sJa{g=QIc?+P>vY_Q>BUPAteL7|W0HEcn3i3;!Hf&b@CW|J8FrqFy*EL)=c0!oF0 ztr@&HTv(7?PKRt$RO5B0~{mh(U*bkYaR6{jXzyAR*(8{;T^vke5@~xMt)dN_JCqhs!v*NjK_wfw|c8b4_|G9E$T?>ZF8?0 z^R5(>MHPP(vhLpI|>HYg%pTY7URo*H(I@(pO zAYG);&Ai9S9z&8#*EX{aIE+&AJ0cQtVJ@qEE`ez(>!DIDlfXt58Vo^XgxkHaSn^X0 zkN4nK@F{|6p9W_knImqQ{;t_5#S!|Jp!ydwR&o0(kDy`O%&&6$kd-tu*qp6lre76r z+WOvQZTH-HkQ)# zChJ$4&+rY#;DLtp^d!%JK!P$dKX*(s_xt@~FiDROR2&xlOu3F~&3({rJ+NU9O=D=&?Jx=&m7eYehYpS? zUi#GaE&qLUwj4~V@0QNh9OKk`2??*t_-%zvfyRUrqNPF|QSq4Ngry87TZ@$&Sjm1_ zZ|j|B(#SsKUxQf zYa)_Ln}z!U7pj&W{^rqse>j_>3?TOqw}bS5uiH$bMf#C7v>2muqEel5&qr*B zQ&d}lE(u6Szp8e*`#^M{QC3UkG-6Ik}Eg zIhH5Dz-xn5Uc~*0e$F4l$k34IFthmD$xg;lgDA5$zJhi4o>FZ@#DfHZ39nuqw=jxi ze|S5|2;076E~X>rdS6vq*W*}#-q5{@i~D!!w5E9^*YTjrew;0~NDE4VVJA~w!9{DnLt|3PGScLXU6fWqxbCmIT{fO?KrC9s~hgLv|#ol)d z;iKV)2Yl|i!)gIz@XD_jSz%08Boi}ihjHK`_etm@8G^ARx&XcNW z;dtQsPA9umeRNLy!;RuwfZisVIl!1}ZdcvBK^jBIJqkXZDrT6tDOTAPSGGI)zP2HG z`qDUXZOXD#2szbXr_DMiH=Qe0=jUi7?tJ@=RXmKOy$a<$nsxQ#-^BV9mphB{W-l0Q zj6>ItQTnS#O5nF-pP9-1-m?sFZvLj9t=b)|XEV*r%tpNqNwr)57rr8v5r|9m-XEDS zN(OX~Ef%=4BgUffA z-s6!J>Q!sX_$5K`eGqhb*%bzTMILid%qPKbwfU5HK0b32m-%${=uEyd4m&Z##uuJ$ zq(r!q8!Jr))$AQP1$p%und->j*E(6WY#8~S*ANH{fCxwXCT0y~5)n7vSLj~-j@*xO zZBf1-S0Z=0Sh9yPImixnrQFEot--v!g?th(3tqDzthM8MUbxI~toCUbn)P{4hm)-p1MjW*Qt8;Sl z;|ZP?IG<`KogtNktiGE*1raRIH>cVJSVU}Ze9##UP;d%L#8qiG7jF(CA8A#jB^Puf&cUL45sVM8~ zaR3I9ZWFw@BUhBoO%mzI1>^Xz=NqNieJq#z$HNgM-_IdOV`_pxetBp?TztWa-61`Y z_Ie^bFQnJY`>NX*Iavu4e6p!F&R$(8G+uF^Fhnh^QPU!4BRx{}fn;L#EWfTkIm8Fh zg})MsVFFsG?(jDsJpA2pv-JnPHoI`OkR79D{)h2TnIw%Hs#}668)nWY(8=1qr1Xl$Oocb$p;;qN|GC(z3^q*D3l26>;>Q-ntT5x?Vcy7IbthQi6i zyXIoiu4*SvanCr7;X|&s-|TZ~M03S(V1$4sNAKxpc9q@b zTt;yq3>_RWq#EN;rwFd$(Y5B#Q8Tcm-f9#-jwKCbc zgN2+c4>TxpS;R`<+w^!*mf%o&JNhB8cg~%K7?lovk6k8X=Vt*9juHw#f<$y9JSB${EkSJhf1&>BnU_?$jxpPg{|M#~CqVEIFfz zB`=Lf?i3I98=wrp3w>ds{6{5ER|i=*m}&fKulm)7%9H0_x_*rX>9d4HyWV4^;>lfe z=do}$ap-?}m>=&7pPKAnk-m{f3WrH9nR}g<-U#K5n%`JTOF>oF$+`9>Bf~`!Kp8a0 z85{MVJCOF&IxX-1dEvHK@KFjZ#_y4NWHwyVu^*>la>fAYRR%+*kUy|8rTSvHncnt; z1|MdLDSTOM{M{mPi;mz30$=sT^VeQ`u7-+enN{xxJ;M#YE2kqv*U!I*!>QHdDOI&N zXed!}b!VrGjjXyycmAc_*8^wjY|^|pI!QVXURsitY8lrU%;TLo=!Vb3KT8TXMDVWh z-Yg3cu`>4yvE_!RTaU&^H9#&caT}Yaa;7i4oUK&BZ{BlSth6aS#=94%V8`v>XGU_- z#Yg!ZD7_2D%Xai@*#Zv#cIH2u;+B|#Jz^=Mo#DP)*!!A%G4M|JPS%4ooSi0It0U>W zyw3rAELRj?VEAd`SWRupBY!!dgP5*e`~qj5JbE&6m6HrDKSZ{y&K-5V&welW73iuYno>C?U(|IPq6+oVtgP+05X9wVm0eJ-LxLI>i zKri8nc3R!y{jZ7L{pB$0^j62NmHXOveFb^Wxh2zb+!&TWVDin;>(aNFI z#PI?5s_TM{oOc5hJ$zUopZewb=8RG$D>Gu7+k1Mx^{2m>e{g^eKl8#l`%Gi`h%7@x z{^eqW6|(xPb)|8I!OXvnxpyJeD%?CPq+mX$k3kO`F2MesVAOC)GO7#BwqSGNJHPJ%L(kKo{eZ*995VKOCIWr9)3W)=6%DstD#!IAv-W5&7^)PA1wFh?$BQm-Yf$0*23{|Wq(`D@;g zfo#}})Qdl&roDBiB)ww$okiYXpB(Mz0}|5wN+Ze--YWZVGeIYkR=om7X9XgSTwq{l znB7OWg2v_B=I3GWi1YGVSeMmxm-RGQ{lGWBvpt(pZij{c#MZ-}H3oiVdv&@A?9w{Bt&XO+a0n>$(Wd`xOE*J8%ylclF^}h+fQ( zB#u=@ov|Fj<1FdD26LCyo-t|uT%R^0f=4FcWW)CB#F^s1D9-JWNdiSO5X|{-{C_F_ z%`A