You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.html 58 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../llama.abstractions.itexttransform/">
  7. <link rel="next" href="../llama.common.authorrole/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.16">
  10. <title>llama.chatsession - LLamaSharp Documentation</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.26e3688c.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <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">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <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>
  16. </head>
  17. <body dir="ltr">
  18. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#chatsession" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  30. </div>
  31. <header class="md-header md-header--shadow" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="../.." title="LLamaSharp Documentation" class="md-header__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
  34. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  35. </a>
  36. <label class="md-header__button md-icon" for="__drawer">
  37. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  38. </label>
  39. <div class="md-header__title" data-md-component="header-title">
  40. <div class="md-header__ellipsis">
  41. <div class="md-header__topic">
  42. <span class="md-ellipsis">
  43. LLamaSharp Documentation
  44. </span>
  45. </div>
  46. <div class="md-header__topic" data-md-component="header-topic">
  47. <span class="md-ellipsis">
  48. llama.chatsession
  49. </span>
  50. </div>
  51. </div>
  52. </div>
  53. <label class="md-header__button md-icon" for="__search">
  54. <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.516 6.516 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 5Z"/></svg>
  55. </label>
  56. <div class="md-search" data-md-component="search" role="dialog">
  57. <label class="md-search__overlay" for="__search"></label>
  58. <div class="md-search__inner" role="search">
  59. <form class="md-search__form" name="search">
  60. <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>
  61. <label class="md-search__icon md-icon" for="__search">
  62. <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.516 6.516 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 5Z"/></svg>
  63. <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 11h12Z"/></svg>
  64. </label>
  65. <nav class="md-search__options" aria-label="Search">
  66. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  67. <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 12 19 6.41Z"/></svg>
  68. </button>
  69. </nav>
  70. </form>
  71. <div class="md-search__output">
  72. <div class="md-search__scrollwrap" data-md-scrollfix>
  73. <div class="md-search-result" data-md-component="search-result">
  74. <div class="md-search-result__meta">
  75. Initializing search
  76. </div>
  77. <ol class="md-search-result__list" role="presentation"></ol>
  78. </div>
  79. </div>
  80. </div>
  81. </div>
  82. </div>
  83. </nav>
  84. </header>
  85. <div class="md-container" data-md-component="container">
  86. <main class="md-main" data-md-component="main">
  87. <div class="md-main__inner md-grid">
  88. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  89. <div class="md-sidebar__scrollwrap">
  90. <div class="md-sidebar__inner">
  91. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  92. <label class="md-nav__title" for="__drawer">
  93. <a href="../.." title="LLamaSharp Documentation" class="md-nav__button md-logo" aria-label="LLamaSharp Documentation" data-md-component="logo">
  94. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  95. </a>
  96. LLamaSharp Documentation
  97. </label>
  98. <ul class="md-nav__list" data-md-scrollfix>
  99. <li class="md-nav__item">
  100. <a href="../.." class="md-nav__link">
  101. Overview
  102. </a>
  103. </li>
  104. <li class="md-nav__item">
  105. <a href="../../GetStarted/" class="md-nav__link">
  106. Get Started
  107. </a>
  108. </li>
  109. <li class="md-nav__item">
  110. <a href="../../Architecture/" class="md-nav__link">
  111. Architecture
  112. </a>
  113. </li>
  114. <li class="md-nav__item">
  115. <a href="../../Tricks/" class="md-nav__link">
  116. Tricks for FAQ
  117. </a>
  118. </li>
  119. <li class="md-nav__item">
  120. <a href="../../ContributingGuide/" class="md-nav__link">
  121. Contributing Guide
  122. </a>
  123. </li>
  124. <li class="md-nav__item md-nav__item--nested">
  125. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
  126. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  127. LLamaModel
  128. <span class="md-nav__icon md-icon"></span>
  129. </label>
  130. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  131. <label class="md-nav__title" for="__nav_6">
  132. <span class="md-nav__icon md-icon"></span>
  133. LLamaModel
  134. </label>
  135. <ul class="md-nav__list" data-md-scrollfix>
  136. <li class="md-nav__item">
  137. <a href="../../LLamaModel/parameters/" class="md-nav__link">
  138. Model Parameters
  139. </a>
  140. </li>
  141. <li class="md-nav__item">
  142. <a href="../../LLamaModel/tokenization/" class="md-nav__link">
  143. Tokenization
  144. </a>
  145. </li>
  146. <li class="md-nav__item">
  147. <a href="../../LLamaModel/embeddings/" class="md-nav__link">
  148. Get Embeddings
  149. </a>
  150. </li>
  151. <li class="md-nav__item">
  152. <a href="../../LLamaModel/quantization/" class="md-nav__link">
  153. Quantization
  154. </a>
  155. </li>
  156. <li class="md-nav__item">
  157. <a href="../../LLamaModel/save-load-state/" class="md-nav__link">
  158. Save/Load State
  159. </a>
  160. </li>
  161. </ul>
  162. </nav>
  163. </li>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
  166. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  167. LLamaExecutors
  168. <span class="md-nav__icon md-icon"></span>
  169. </label>
  170. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  171. <label class="md-nav__title" for="__nav_7">
  172. <span class="md-nav__icon md-icon"></span>
  173. LLamaExecutors
  174. </label>
  175. <ul class="md-nav__list" data-md-scrollfix>
  176. <li class="md-nav__item">
  177. <a href="../../LLamaExecutors/parameters/" class="md-nav__link">
  178. Inference Parameters
  179. </a>
  180. </li>
  181. <li class="md-nav__item">
  182. <a href="../../LLamaExecutors/text-to-text-apis/" class="md-nav__link">
  183. Text-to-Text APIs
  184. </a>
  185. </li>
  186. <li class="md-nav__item">
  187. <a href="../../LLamaExecutors/save-load-state/" class="md-nav__link">
  188. Save/Load State
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../../LLamaExecutors/differences/" class="md-nav__link">
  193. Differences of Executors
  194. </a>
  195. </li>
  196. </ul>
  197. </nav>
  198. </li>
  199. <li class="md-nav__item md-nav__item--nested">
  200. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
  201. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  202. ChatSession
  203. <span class="md-nav__icon md-icon"></span>
  204. </label>
  205. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  206. <label class="md-nav__title" for="__nav_8">
  207. <span class="md-nav__icon md-icon"></span>
  208. ChatSession
  209. </label>
  210. <ul class="md-nav__list" data-md-scrollfix>
  211. <li class="md-nav__item">
  212. <a href="../../ChatSession/basic-usages/" class="md-nav__link">
  213. Basic Usages
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../ChatSession/transforms/" class="md-nav__link">
  218. Transoforms
  219. </a>
  220. </li>
  221. <li class="md-nav__item">
  222. <a href="../../ChatSession/save-load-session/" class="md-nav__link">
  223. Save/Load Session
  224. </a>
  225. </li>
  226. </ul>
  227. </nav>
  228. </li>
  229. <li class="md-nav__item md-nav__item--nested">
  230. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
  231. <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
  232. Non-English Usages
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
  236. <label class="md-nav__title" for="__nav_9">
  237. <span class="md-nav__icon md-icon"></span>
  238. Non-English Usages
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../../NonEnglishUsage/Chinese/" class="md-nav__link">
  243. Chinese
  244. </a>
  245. </li>
  246. </ul>
  247. </nav>
  248. </li>
  249. <li class="md-nav__item md-nav__item--nested">
  250. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
  251. <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
  252. High-level Applications
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
  256. <label class="md-nav__title" for="__nav_10">
  257. <span class="md-nav__icon md-icon"></span>
  258. High-level Applications
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../../HighLevelApps/bot-sharp/" class="md-nav__link">
  263. BotSharp
  264. </a>
  265. </li>
  266. </ul>
  267. </nav>
  268. </li>
  269. <li class="md-nav__item md-nav__item--nested">
  270. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
  271. <label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
  272. More
  273. <span class="md-nav__icon md-icon"></span>
  274. </label>
  275. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
  276. <label class="md-nav__title" for="__nav_11">
  277. <span class="md-nav__icon md-icon"></span>
  278. More
  279. </label>
  280. <ul class="md-nav__list" data-md-scrollfix>
  281. <li class="md-nav__item">
  282. <a href="../../More/log/" class="md-nav__link">
  283. Logger
  284. </a>
  285. </li>
  286. </ul>
  287. </nav>
  288. </li>
  289. <li class="md-nav__item md-nav__item--nested">
  290. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
  291. <label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
  292. Examples
  293. <span class="md-nav__icon md-icon"></span>
  294. </label>
  295. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
  296. <label class="md-nav__title" for="__nav_12">
  297. <span class="md-nav__icon md-icon"></span>
  298. Examples
  299. </label>
  300. <ul class="md-nav__list" data-md-scrollfix>
  301. <li class="md-nav__item">
  302. <a href="../../Examples/ChatSessionStripRoleName/" class="md-nav__link">
  303. Chat session 1
  304. </a>
  305. </li>
  306. <li class="md-nav__item">
  307. <a href="../../Examples/ChatSessionWithRoleName/" class="md-nav__link">
  308. Chat session 2
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../../Examples/GetEmbeddings/" class="md-nav__link">
  313. Get embeddings
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../../Examples/InstructModeExecute/" class="md-nav__link">
  318. Instruct executor
  319. </a>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="../../Examples/InteractiveModeExecute/" class="md-nav__link">
  323. Interactive executor
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../../Examples/StatelessModeExecute/" class="md-nav__link">
  328. Stateless exeutor
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../Examples/LoadAndSaveSession/" class="md-nav__link">
  333. Load/Save session
  334. </a>
  335. </li>
  336. <li class="md-nav__item">
  337. <a href="../../Examples/LoadAndSaveState/" class="md-nav__link">
  338. Load/Save state
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="../../Examples/QuantizeModel/" class="md-nav__link">
  343. Quantize model
  344. </a>
  345. </li>
  346. </ul>
  347. </nav>
  348. </li>
  349. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  350. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" checked>
  351. <label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">
  352. API Reference
  353. <span class="md-nav__icon md-icon"></span>
  354. </label>
  355. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="true">
  356. <label class="md-nav__title" for="__nav_13">
  357. <span class="md-nav__icon md-icon"></span>
  358. API Reference
  359. </label>
  360. <ul class="md-nav__list" data-md-scrollfix>
  361. <li class="md-nav__item">
  362. <a href="../" class="md-nav__link">
  363. index
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../llama.abstractions.ihistorytransform/" class="md-nav__link">
  368. llama.abstractions.ihistorytransform
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="../llama.abstractions.illamaexecutor/" class="md-nav__link">
  373. llama.abstractions.illamaexecutor
  374. </a>
  375. </li>
  376. <li class="md-nav__item">
  377. <a href="../llama.abstractions.itextstreamtransform/" class="md-nav__link">
  378. llama.abstractions.itextstreamtransform
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../llama.abstractions.itexttransform/" class="md-nav__link">
  383. llama.abstractions.itexttransform
  384. </a>
  385. </li>
  386. <li class="md-nav__item md-nav__item--active">
  387. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  388. <label class="md-nav__link md-nav__link--active" for="__toc">
  389. llama.chatsession
  390. <span class="md-nav__icon md-icon"></span>
  391. </label>
  392. <a href="./" class="md-nav__link md-nav__link--active">
  393. llama.chatsession
  394. </a>
  395. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  396. <label class="md-nav__title" for="__toc">
  397. <span class="md-nav__icon md-icon"></span>
  398. Table of contents
  399. </label>
  400. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  401. <li class="md-nav__item">
  402. <a href="#fields" class="md-nav__link">
  403. Fields
  404. </a>
  405. <nav class="md-nav" aria-label="Fields">
  406. <ul class="md-nav__list">
  407. <li class="md-nav__item">
  408. <a href="#outputtransform" class="md-nav__link">
  409. OutputTransform
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="#properties" class="md-nav__link">
  417. Properties
  418. </a>
  419. <nav class="md-nav" aria-label="Properties">
  420. <ul class="md-nav__list">
  421. <li class="md-nav__item">
  422. <a href="#executor" class="md-nav__link">
  423. Executor
  424. </a>
  425. <nav class="md-nav" aria-label="Executor">
  426. <ul class="md-nav__list">
  427. <li class="md-nav__item">
  428. <a href="#property-value" class="md-nav__link">
  429. Property Value
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="#history" class="md-nav__link">
  437. History
  438. </a>
  439. <nav class="md-nav" aria-label="History">
  440. <ul class="md-nav__list">
  441. <li class="md-nav__item">
  442. <a href="#property-value_1" class="md-nav__link">
  443. Property Value
  444. </a>
  445. </li>
  446. </ul>
  447. </nav>
  448. </li>
  449. <li class="md-nav__item">
  450. <a href="#historytransform" class="md-nav__link">
  451. HistoryTransform
  452. </a>
  453. <nav class="md-nav" aria-label="HistoryTransform">
  454. <ul class="md-nav__list">
  455. <li class="md-nav__item">
  456. <a href="#property-value_2" class="md-nav__link">
  457. Property Value
  458. </a>
  459. </li>
  460. </ul>
  461. </nav>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="#inputtransformpipeline" class="md-nav__link">
  465. InputTransformPipeline
  466. </a>
  467. <nav class="md-nav" aria-label="InputTransformPipeline">
  468. <ul class="md-nav__list">
  469. <li class="md-nav__item">
  470. <a href="#property-value_3" class="md-nav__link">
  471. Property Value
  472. </a>
  473. </li>
  474. </ul>
  475. </nav>
  476. </li>
  477. </ul>
  478. </nav>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="#constructors" class="md-nav__link">
  482. Constructors
  483. </a>
  484. <nav class="md-nav" aria-label="Constructors">
  485. <ul class="md-nav__list">
  486. <li class="md-nav__item">
  487. <a href="#chatsessionillamaexecutor" class="md-nav__link">
  488. ChatSession(ILLamaExecutor)
  489. </a>
  490. <nav class="md-nav" aria-label="ChatSession(ILLamaExecutor)">
  491. <ul class="md-nav__list">
  492. <li class="md-nav__item">
  493. <a href="#parameters" class="md-nav__link">
  494. Parameters
  495. </a>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="#methods" class="md-nav__link">
  505. Methods
  506. </a>
  507. <nav class="md-nav" aria-label="Methods">
  508. <ul class="md-nav__list">
  509. <li class="md-nav__item">
  510. <a href="#withhistorytransformihistorytransform" class="md-nav__link">
  511. WithHistoryTransform(IHistoryTransform)
  512. </a>
  513. <nav class="md-nav" aria-label="WithHistoryTransform(IHistoryTransform)">
  514. <ul class="md-nav__list">
  515. <li class="md-nav__item">
  516. <a href="#parameters_1" class="md-nav__link">
  517. Parameters
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="#returns" class="md-nav__link">
  522. Returns
  523. </a>
  524. </li>
  525. </ul>
  526. </nav>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="#addinputtransformitexttransform" class="md-nav__link">
  530. AddInputTransform(ITextTransform)
  531. </a>
  532. <nav class="md-nav" aria-label="AddInputTransform(ITextTransform)">
  533. <ul class="md-nav__list">
  534. <li class="md-nav__item">
  535. <a href="#parameters_2" class="md-nav__link">
  536. Parameters
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="#returns_1" class="md-nav__link">
  541. Returns
  542. </a>
  543. </li>
  544. </ul>
  545. </nav>
  546. </li>
  547. <li class="md-nav__item">
  548. <a href="#withoutputtransformitextstreamtransform" class="md-nav__link">
  549. WithOutputTransform(ITextStreamTransform)
  550. </a>
  551. <nav class="md-nav" aria-label="WithOutputTransform(ITextStreamTransform)">
  552. <ul class="md-nav__list">
  553. <li class="md-nav__item">
  554. <a href="#parameters_3" class="md-nav__link">
  555. Parameters
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="#returns_2" class="md-nav__link">
  560. Returns
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="#savesessionstring" class="md-nav__link">
  568. SaveSession(String)
  569. </a>
  570. <nav class="md-nav" aria-label="SaveSession(String)">
  571. <ul class="md-nav__list">
  572. <li class="md-nav__item">
  573. <a href="#parameters_4" class="md-nav__link">
  574. Parameters
  575. </a>
  576. </li>
  577. </ul>
  578. </nav>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#loadsessionstring" class="md-nav__link">
  582. LoadSession(String)
  583. </a>
  584. <nav class="md-nav" aria-label="LoadSession(String)">
  585. <ul class="md-nav__list">
  586. <li class="md-nav__item">
  587. <a href="#parameters_5" class="md-nav__link">
  588. Parameters
  589. </a>
  590. </li>
  591. </ul>
  592. </nav>
  593. </li>
  594. <li class="md-nav__item">
  595. <a href="#chatchathistory-inferenceparams-cancellationtoken" class="md-nav__link">
  596. Chat(ChatHistory, InferenceParams, CancellationToken)
  597. </a>
  598. <nav class="md-nav" aria-label="Chat(ChatHistory, InferenceParams, CancellationToken)">
  599. <ul class="md-nav__list">
  600. <li class="md-nav__item">
  601. <a href="#parameters_6" class="md-nav__link">
  602. Parameters
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="#returns_3" class="md-nav__link">
  607. Returns
  608. </a>
  609. </li>
  610. </ul>
  611. </nav>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="#chatstring-inferenceparams-cancellationtoken" class="md-nav__link">
  615. Chat(String, InferenceParams, CancellationToken)
  616. </a>
  617. <nav class="md-nav" aria-label="Chat(String, InferenceParams, CancellationToken)">
  618. <ul class="md-nav__list">
  619. <li class="md-nav__item">
  620. <a href="#parameters_7" class="md-nav__link">
  621. Parameters
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="#returns_4" class="md-nav__link">
  626. Returns
  627. </a>
  628. </li>
  629. </ul>
  630. </nav>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="#chatasyncchathistory-inferenceparams-cancellationtoken" class="md-nav__link">
  634. ChatAsync(ChatHistory, InferenceParams, CancellationToken)
  635. </a>
  636. <nav class="md-nav" aria-label="ChatAsync(ChatHistory, InferenceParams, CancellationToken)">
  637. <ul class="md-nav__list">
  638. <li class="md-nav__item">
  639. <a href="#parameters_8" class="md-nav__link">
  640. Parameters
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="#returns_5" class="md-nav__link">
  645. Returns
  646. </a>
  647. </li>
  648. </ul>
  649. </nav>
  650. </li>
  651. <li class="md-nav__item">
  652. <a href="#chatasyncstring-inferenceparams-cancellationtoken" class="md-nav__link">
  653. ChatAsync(String, InferenceParams, CancellationToken)
  654. </a>
  655. <nav class="md-nav" aria-label="ChatAsync(String, InferenceParams, CancellationToken)">
  656. <ul class="md-nav__list">
  657. <li class="md-nav__item">
  658. <a href="#parameters_9" class="md-nav__link">
  659. Parameters
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="#returns_6" class="md-nav__link">
  664. Returns
  665. </a>
  666. </li>
  667. </ul>
  668. </nav>
  669. </li>
  670. </ul>
  671. </nav>
  672. </li>
  673. </ul>
  674. </nav>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../llama.common.authorrole/" class="md-nav__link">
  678. llama.common.authorrole
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../llama.common.chathistory/" class="md-nav__link">
  683. llama.common.chathistory
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="../llama.common.fixedsizequeue-1/" class="md-nav__link">
  688. llama.common.fixedsizequeue-1
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../llama.common.illamalogger/" class="md-nav__link">
  693. llama.common.illamalogger
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../llama.common.inferenceparams/" class="md-nav__link">
  698. llama.common.inferenceparams
  699. </a>
  700. </li>
  701. <li class="md-nav__item">
  702. <a href="../llama.common.llamadefaultlogger/" class="md-nav__link">
  703. llama.common.llamadefaultlogger
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../llama.common.mirostatetype/" class="md-nav__link">
  708. llama.common.mirostatetype
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../llama.common.modelparams/" class="md-nav__link">
  713. llama.common.modelparams
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../llama.exceptions.runtimeerror/" class="md-nav__link">
  718. llama.exceptions.runtimeerror
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../llama.extensions.dictionaryextension/" class="md-nav__link">
  723. llama.extensions.dictionaryextension
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../llama.instructexecutor/" class="md-nav__link">
  728. llama.instructexecutor
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../llama.interactiveexecutor/" class="md-nav__link">
  733. llama.interactiveexecutor
  734. </a>
  735. </li>
  736. <li class="md-nav__item">
  737. <a href="../llama.llamaembedder/" class="md-nav__link">
  738. llama.llamaembedder
  739. </a>
  740. </li>
  741. <li class="md-nav__item">
  742. <a href="../llama.llamamodel/" class="md-nav__link">
  743. llama.llamamodel
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../llama.llamaquantizer/" class="md-nav__link">
  748. llama.llamaquantizer
  749. </a>
  750. </li>
  751. <li class="md-nav__item">
  752. <a href="../llama.llamatransforms/" class="md-nav__link">
  753. llama.llamatransforms
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../llama.native.llamacontextparams/" class="md-nav__link">
  758. llama.native.llamacontextparams
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../llama.native.llamaftype/" class="md-nav__link">
  763. llama.native.llamaftype
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../llama.native.llamatokendata/" class="md-nav__link">
  768. llama.native.llamatokendata
  769. </a>
  770. </li>
  771. <li class="md-nav__item">
  772. <a href="../llama.native.llamatokendataarray/" class="md-nav__link">
  773. llama.native.llamatokendataarray
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="../llama.native.llamatokendataarraynative/" class="md-nav__link">
  778. llama.native.llamatokendataarraynative
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../llama.native.nativeapi/" class="md-nav__link">
  783. llama.native.nativeapi
  784. </a>
  785. </li>
  786. <li class="md-nav__item">
  787. <a href="../llama.native.safellamacontexthandle/" class="md-nav__link">
  788. llama.native.safellamacontexthandle
  789. </a>
  790. </li>
  791. <li class="md-nav__item">
  792. <a href="../llama.native.safellamahandlebase/" class="md-nav__link">
  793. llama.native.safellamahandlebase
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../llama.oldversion.chatcompletion/" class="md-nav__link">
  798. llama.oldversion.chatcompletion
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../llama.oldversion.chatcompletionchoice/" class="md-nav__link">
  803. llama.oldversion.chatcompletionchoice
  804. </a>
  805. </li>
  806. <li class="md-nav__item">
  807. <a href="../llama.oldversion.chatcompletionchunk/" class="md-nav__link">
  808. llama.oldversion.chatcompletionchunk
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="../llama.oldversion.chatcompletionchunkchoice/" class="md-nav__link">
  813. llama.oldversion.chatcompletionchunkchoice
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../llama.oldversion.chatcompletionchunkdelta/" class="md-nav__link">
  818. llama.oldversion.chatcompletionchunkdelta
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="../llama.oldversion.chatcompletionmessage/" class="md-nav__link">
  823. llama.oldversion.chatcompletionmessage
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../llama.oldversion.chatmessagerecord/" class="md-nav__link">
  828. llama.oldversion.chatmessagerecord
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../llama.oldversion.chatrole/" class="md-nav__link">
  833. llama.oldversion.chatrole
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../llama.oldversion.chatsession-1/" class="md-nav__link">
  838. llama.oldversion.chatsession-1
  839. </a>
  840. </li>
  841. <li class="md-nav__item">
  842. <a href="../llama.oldversion.completion/" class="md-nav__link">
  843. llama.oldversion.completion
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="../llama.oldversion.completionchoice/" class="md-nav__link">
  848. llama.oldversion.completionchoice
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../llama.oldversion.completionchunk/" class="md-nav__link">
  853. llama.oldversion.completionchunk
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../llama.oldversion.completionlogprobs/" class="md-nav__link">
  858. llama.oldversion.completionlogprobs
  859. </a>
  860. </li>
  861. <li class="md-nav__item">
  862. <a href="../llama.oldversion.completionusage/" class="md-nav__link">
  863. llama.oldversion.completionusage
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../llama.oldversion.embedding/" class="md-nav__link">
  868. llama.oldversion.embedding
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../llama.oldversion.embeddingdata/" class="md-nav__link">
  873. llama.oldversion.embeddingdata
  874. </a>
  875. </li>
  876. <li class="md-nav__item">
  877. <a href="../llama.oldversion.embeddingusage/" class="md-nav__link">
  878. llama.oldversion.embeddingusage
  879. </a>
  880. </li>
  881. <li class="md-nav__item">
  882. <a href="../llama.oldversion.ichatmodel/" class="md-nav__link">
  883. llama.oldversion.ichatmodel
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../llama.oldversion.llamaembedder/" class="md-nav__link">
  888. llama.oldversion.llamaembedder
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../llama.oldversion.llamamodel/" class="md-nav__link">
  893. llama.oldversion.llamamodel
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="../llama.oldversion.llamaparams/" class="md-nav__link">
  898. llama.oldversion.llamaparams
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../llama.resettablellamamodel/" class="md-nav__link">
  903. llama.resettablellamamodel
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../llama.statefulexecutorbase/" class="md-nav__link">
  908. llama.statefulexecutorbase
  909. </a>
  910. </li>
  911. <li class="md-nav__item">
  912. <a href="../llama.statelessexecutor/" class="md-nav__link">
  913. llama.statelessexecutor
  914. </a>
  915. </li>
  916. </ul>
  917. </nav>
  918. </li>
  919. </ul>
  920. </nav>
  921. </div>
  922. </div>
  923. </div>
  924. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  925. <div class="md-sidebar__scrollwrap">
  926. <div class="md-sidebar__inner">
  927. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  928. <label class="md-nav__title" for="__toc">
  929. <span class="md-nav__icon md-icon"></span>
  930. Table of contents
  931. </label>
  932. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  933. <li class="md-nav__item">
  934. <a href="#fields" class="md-nav__link">
  935. Fields
  936. </a>
  937. <nav class="md-nav" aria-label="Fields">
  938. <ul class="md-nav__list">
  939. <li class="md-nav__item">
  940. <a href="#outputtransform" class="md-nav__link">
  941. OutputTransform
  942. </a>
  943. </li>
  944. </ul>
  945. </nav>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="#properties" class="md-nav__link">
  949. Properties
  950. </a>
  951. <nav class="md-nav" aria-label="Properties">
  952. <ul class="md-nav__list">
  953. <li class="md-nav__item">
  954. <a href="#executor" class="md-nav__link">
  955. Executor
  956. </a>
  957. <nav class="md-nav" aria-label="Executor">
  958. <ul class="md-nav__list">
  959. <li class="md-nav__item">
  960. <a href="#property-value" class="md-nav__link">
  961. Property Value
  962. </a>
  963. </li>
  964. </ul>
  965. </nav>
  966. </li>
  967. <li class="md-nav__item">
  968. <a href="#history" class="md-nav__link">
  969. History
  970. </a>
  971. <nav class="md-nav" aria-label="History">
  972. <ul class="md-nav__list">
  973. <li class="md-nav__item">
  974. <a href="#property-value_1" class="md-nav__link">
  975. Property Value
  976. </a>
  977. </li>
  978. </ul>
  979. </nav>
  980. </li>
  981. <li class="md-nav__item">
  982. <a href="#historytransform" class="md-nav__link">
  983. HistoryTransform
  984. </a>
  985. <nav class="md-nav" aria-label="HistoryTransform">
  986. <ul class="md-nav__list">
  987. <li class="md-nav__item">
  988. <a href="#property-value_2" class="md-nav__link">
  989. Property Value
  990. </a>
  991. </li>
  992. </ul>
  993. </nav>
  994. </li>
  995. <li class="md-nav__item">
  996. <a href="#inputtransformpipeline" class="md-nav__link">
  997. InputTransformPipeline
  998. </a>
  999. <nav class="md-nav" aria-label="InputTransformPipeline">
  1000. <ul class="md-nav__list">
  1001. <li class="md-nav__item">
  1002. <a href="#property-value_3" class="md-nav__link">
  1003. Property Value
  1004. </a>
  1005. </li>
  1006. </ul>
  1007. </nav>
  1008. </li>
  1009. </ul>
  1010. </nav>
  1011. </li>
  1012. <li class="md-nav__item">
  1013. <a href="#constructors" class="md-nav__link">
  1014. Constructors
  1015. </a>
  1016. <nav class="md-nav" aria-label="Constructors">
  1017. <ul class="md-nav__list">
  1018. <li class="md-nav__item">
  1019. <a href="#chatsessionillamaexecutor" class="md-nav__link">
  1020. ChatSession(ILLamaExecutor)
  1021. </a>
  1022. <nav class="md-nav" aria-label="ChatSession(ILLamaExecutor)">
  1023. <ul class="md-nav__list">
  1024. <li class="md-nav__item">
  1025. <a href="#parameters" class="md-nav__link">
  1026. Parameters
  1027. </a>
  1028. </li>
  1029. </ul>
  1030. </nav>
  1031. </li>
  1032. </ul>
  1033. </nav>
  1034. </li>
  1035. <li class="md-nav__item">
  1036. <a href="#methods" class="md-nav__link">
  1037. Methods
  1038. </a>
  1039. <nav class="md-nav" aria-label="Methods">
  1040. <ul class="md-nav__list">
  1041. <li class="md-nav__item">
  1042. <a href="#withhistorytransformihistorytransform" class="md-nav__link">
  1043. WithHistoryTransform(IHistoryTransform)
  1044. </a>
  1045. <nav class="md-nav" aria-label="WithHistoryTransform(IHistoryTransform)">
  1046. <ul class="md-nav__list">
  1047. <li class="md-nav__item">
  1048. <a href="#parameters_1" class="md-nav__link">
  1049. Parameters
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="#returns" class="md-nav__link">
  1054. Returns
  1055. </a>
  1056. </li>
  1057. </ul>
  1058. </nav>
  1059. </li>
  1060. <li class="md-nav__item">
  1061. <a href="#addinputtransformitexttransform" class="md-nav__link">
  1062. AddInputTransform(ITextTransform)
  1063. </a>
  1064. <nav class="md-nav" aria-label="AddInputTransform(ITextTransform)">
  1065. <ul class="md-nav__list">
  1066. <li class="md-nav__item">
  1067. <a href="#parameters_2" class="md-nav__link">
  1068. Parameters
  1069. </a>
  1070. </li>
  1071. <li class="md-nav__item">
  1072. <a href="#returns_1" class="md-nav__link">
  1073. Returns
  1074. </a>
  1075. </li>
  1076. </ul>
  1077. </nav>
  1078. </li>
  1079. <li class="md-nav__item">
  1080. <a href="#withoutputtransformitextstreamtransform" class="md-nav__link">
  1081. WithOutputTransform(ITextStreamTransform)
  1082. </a>
  1083. <nav class="md-nav" aria-label="WithOutputTransform(ITextStreamTransform)">
  1084. <ul class="md-nav__list">
  1085. <li class="md-nav__item">
  1086. <a href="#parameters_3" class="md-nav__link">
  1087. Parameters
  1088. </a>
  1089. </li>
  1090. <li class="md-nav__item">
  1091. <a href="#returns_2" class="md-nav__link">
  1092. Returns
  1093. </a>
  1094. </li>
  1095. </ul>
  1096. </nav>
  1097. </li>
  1098. <li class="md-nav__item">
  1099. <a href="#savesessionstring" class="md-nav__link">
  1100. SaveSession(String)
  1101. </a>
  1102. <nav class="md-nav" aria-label="SaveSession(String)">
  1103. <ul class="md-nav__list">
  1104. <li class="md-nav__item">
  1105. <a href="#parameters_4" class="md-nav__link">
  1106. Parameters
  1107. </a>
  1108. </li>
  1109. </ul>
  1110. </nav>
  1111. </li>
  1112. <li class="md-nav__item">
  1113. <a href="#loadsessionstring" class="md-nav__link">
  1114. LoadSession(String)
  1115. </a>
  1116. <nav class="md-nav" aria-label="LoadSession(String)">
  1117. <ul class="md-nav__list">
  1118. <li class="md-nav__item">
  1119. <a href="#parameters_5" class="md-nav__link">
  1120. Parameters
  1121. </a>
  1122. </li>
  1123. </ul>
  1124. </nav>
  1125. </li>
  1126. <li class="md-nav__item">
  1127. <a href="#chatchathistory-inferenceparams-cancellationtoken" class="md-nav__link">
  1128. Chat(ChatHistory, InferenceParams, CancellationToken)
  1129. </a>
  1130. <nav class="md-nav" aria-label="Chat(ChatHistory, InferenceParams, CancellationToken)">
  1131. <ul class="md-nav__list">
  1132. <li class="md-nav__item">
  1133. <a href="#parameters_6" class="md-nav__link">
  1134. Parameters
  1135. </a>
  1136. </li>
  1137. <li class="md-nav__item">
  1138. <a href="#returns_3" class="md-nav__link">
  1139. Returns
  1140. </a>
  1141. </li>
  1142. </ul>
  1143. </nav>
  1144. </li>
  1145. <li class="md-nav__item">
  1146. <a href="#chatstring-inferenceparams-cancellationtoken" class="md-nav__link">
  1147. Chat(String, InferenceParams, CancellationToken)
  1148. </a>
  1149. <nav class="md-nav" aria-label="Chat(String, InferenceParams, CancellationToken)">
  1150. <ul class="md-nav__list">
  1151. <li class="md-nav__item">
  1152. <a href="#parameters_7" class="md-nav__link">
  1153. Parameters
  1154. </a>
  1155. </li>
  1156. <li class="md-nav__item">
  1157. <a href="#returns_4" class="md-nav__link">
  1158. Returns
  1159. </a>
  1160. </li>
  1161. </ul>
  1162. </nav>
  1163. </li>
  1164. <li class="md-nav__item">
  1165. <a href="#chatasyncchathistory-inferenceparams-cancellationtoken" class="md-nav__link">
  1166. ChatAsync(ChatHistory, InferenceParams, CancellationToken)
  1167. </a>
  1168. <nav class="md-nav" aria-label="ChatAsync(ChatHistory, InferenceParams, CancellationToken)">
  1169. <ul class="md-nav__list">
  1170. <li class="md-nav__item">
  1171. <a href="#parameters_8" class="md-nav__link">
  1172. Parameters
  1173. </a>
  1174. </li>
  1175. <li class="md-nav__item">
  1176. <a href="#returns_5" class="md-nav__link">
  1177. Returns
  1178. </a>
  1179. </li>
  1180. </ul>
  1181. </nav>
  1182. </li>
  1183. <li class="md-nav__item">
  1184. <a href="#chatasyncstring-inferenceparams-cancellationtoken" class="md-nav__link">
  1185. ChatAsync(String, InferenceParams, CancellationToken)
  1186. </a>
  1187. <nav class="md-nav" aria-label="ChatAsync(String, InferenceParams, CancellationToken)">
  1188. <ul class="md-nav__list">
  1189. <li class="md-nav__item">
  1190. <a href="#parameters_9" class="md-nav__link">
  1191. Parameters
  1192. </a>
  1193. </li>
  1194. <li class="md-nav__item">
  1195. <a href="#returns_6" class="md-nav__link">
  1196. Returns
  1197. </a>
  1198. </li>
  1199. </ul>
  1200. </nav>
  1201. </li>
  1202. </ul>
  1203. </nav>
  1204. </li>
  1205. </ul>
  1206. </nav>
  1207. </div>
  1208. </div>
  1209. </div>
  1210. <div class="md-content" data-md-component="content">
  1211. <article class="md-content__inner md-typeset">
  1212. <h1 id="chatsession">ChatSession</h1>
  1213. <p>Namespace: LLama</p>
  1214. <p>The main chat session class.</p>
  1215. <pre><code class="language-csharp">public class ChatSession
  1216. </code></pre>
  1217. <p>Inheritance <a href="https://docs.microsoft.com/en-us/dotnet/api/system.object">Object</a> → <a href="./">ChatSession</a></p>
  1218. <h2 id="fields">Fields</h2>
  1219. <h3 id="outputtransform"><strong>OutputTransform</strong></h3>
  1220. <p>The output transform used in this session.</p>
  1221. <pre><code class="language-csharp">public ITextStreamTransform OutputTransform;
  1222. </code></pre>
  1223. <h2 id="properties">Properties</h2>
  1224. <h3 id="executor"><strong>Executor</strong></h3>
  1225. <p>The executor for this session.</p>
  1226. <pre><code class="language-csharp">public ILLamaExecutor Executor { get; }
  1227. </code></pre>
  1228. <h4 id="property-value">Property Value</h4>
  1229. <p><a href="../llama.abstractions.illamaexecutor/">ILLamaExecutor</a><br></p>
  1230. <h3 id="history"><strong>History</strong></h3>
  1231. <p>The chat history for this session.</p>
  1232. <pre><code class="language-csharp">public ChatHistory History { get; }
  1233. </code></pre>
  1234. <h4 id="property-value_1">Property Value</h4>
  1235. <p><a href="../llama.common.chathistory/">ChatHistory</a><br></p>
  1236. <h3 id="historytransform"><strong>HistoryTransform</strong></h3>
  1237. <p>The history transform used in this session.</p>
  1238. <pre><code class="language-csharp">public IHistoryTransform HistoryTransform { get; set; }
  1239. </code></pre>
  1240. <h4 id="property-value_2">Property Value</h4>
  1241. <p><a href="../llama.abstractions.ihistorytransform/">IHistoryTransform</a><br></p>
  1242. <h3 id="inputtransformpipeline"><strong>InputTransformPipeline</strong></h3>
  1243. <p>The input transform pipeline used in this session.</p>
  1244. <pre><code class="language-csharp">public List&lt;ITextTransform&gt; InputTransformPipeline { get; set; }
  1245. </code></pre>
  1246. <h4 id="property-value_3">Property Value</h4>
  1247. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1">List&lt;ITextTransform&gt;</a><br></p>
  1248. <h2 id="constructors">Constructors</h2>
  1249. <h3 id="chatsessionillamaexecutor"><strong>ChatSession(ILLamaExecutor)</strong></h3>
  1250. <pre><code class="language-csharp">public ChatSession(ILLamaExecutor executor)
  1251. </code></pre>
  1252. <h4 id="parameters">Parameters</h4>
  1253. <p><code>executor</code> <a href="../llama.abstractions.illamaexecutor/">ILLamaExecutor</a><br>
  1254. The executor for this session</p>
  1255. <h2 id="methods">Methods</h2>
  1256. <h3 id="withhistorytransformihistorytransform"><strong>WithHistoryTransform(IHistoryTransform)</strong></h3>
  1257. <p>Use a custom history transform.</p>
  1258. <pre><code class="language-csharp">public ChatSession WithHistoryTransform(IHistoryTransform transform)
  1259. </code></pre>
  1260. <h4 id="parameters_1">Parameters</h4>
  1261. <p><code>transform</code> <a href="../llama.abstractions.ihistorytransform/">IHistoryTransform</a><br></p>
  1262. <h4 id="returns">Returns</h4>
  1263. <p><a href="./">ChatSession</a><br></p>
  1264. <h3 id="addinputtransformitexttransform"><strong>AddInputTransform(ITextTransform)</strong></h3>
  1265. <p>Add a text transform to the input transform pipeline.</p>
  1266. <pre><code class="language-csharp">public ChatSession AddInputTransform(ITextTransform transform)
  1267. </code></pre>
  1268. <h4 id="parameters_2">Parameters</h4>
  1269. <p><code>transform</code> <a href="../llama.abstractions.itexttransform/">ITextTransform</a><br></p>
  1270. <h4 id="returns_1">Returns</h4>
  1271. <p><a href="./">ChatSession</a><br></p>
  1272. <h3 id="withoutputtransformitextstreamtransform"><strong>WithOutputTransform(ITextStreamTransform)</strong></h3>
  1273. <p>Use a custom output transform.</p>
  1274. <pre><code class="language-csharp">public ChatSession WithOutputTransform(ITextStreamTransform transform)
  1275. </code></pre>
  1276. <h4 id="parameters_3">Parameters</h4>
  1277. <p><code>transform</code> <a href="../llama.abstractions.itextstreamtransform/">ITextStreamTransform</a><br></p>
  1278. <h4 id="returns_2">Returns</h4>
  1279. <p><a href="./">ChatSession</a><br></p>
  1280. <h3 id="savesessionstring"><strong>SaveSession(String)</strong></h3>
  1281. <pre><code class="language-csharp">public void SaveSession(string path)
  1282. </code></pre>
  1283. <h4 id="parameters_4">Parameters</h4>
  1284. <p><code>path</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.string">String</a><br>
  1285. The directory name to save the session. If the directory does not exist, a new directory will be created.</p>
  1286. <h3 id="loadsessionstring"><strong>LoadSession(String)</strong></h3>
  1287. <pre><code class="language-csharp">public void LoadSession(string path)
  1288. </code></pre>
  1289. <h4 id="parameters_5">Parameters</h4>
  1290. <p><code>path</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.string">String</a><br>
  1291. The directory name to load the session.</p>
  1292. <h3 id="chatchathistory-inferenceparams-cancellationtoken"><strong>Chat(ChatHistory, InferenceParams, CancellationToken)</strong></h3>
  1293. <p>Get the response from the LLama model with chat histories.</p>
  1294. <pre><code class="language-csharp">public IEnumerable&lt;string&gt; Chat(ChatHistory history, InferenceParams inferenceParams, CancellationToken cancellationToken)
  1295. </code></pre>
  1296. <h4 id="parameters_6">Parameters</h4>
  1297. <p><code>history</code> <a href="../llama.common.chathistory/">ChatHistory</a><br></p>
  1298. <p><code>inferenceParams</code> <a href="../llama.common.inferenceparams/">InferenceParams</a><br></p>
  1299. <p><code>cancellationToken</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken">CancellationToken</a><br></p>
  1300. <h4 id="returns_3">Returns</h4>
  1301. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable&lt;String&gt;</a><br></p>
  1302. <h3 id="chatstring-inferenceparams-cancellationtoken"><strong>Chat(String, InferenceParams, CancellationToken)</strong></h3>
  1303. <p>Get the response from the LLama model. Note that prompt could not only be the preset words,
  1304. but also the question you want to ask.</p>
  1305. <pre><code class="language-csharp">public IEnumerable&lt;string&gt; Chat(string prompt, InferenceParams inferenceParams, CancellationToken cancellationToken)
  1306. </code></pre>
  1307. <h4 id="parameters_7">Parameters</h4>
  1308. <p><code>prompt</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.string">String</a><br></p>
  1309. <p><code>inferenceParams</code> <a href="../llama.common.inferenceparams/">InferenceParams</a><br></p>
  1310. <p><code>cancellationToken</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken">CancellationToken</a><br></p>
  1311. <h4 id="returns_4">Returns</h4>
  1312. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable&lt;String&gt;</a><br></p>
  1313. <h3 id="chatasyncchathistory-inferenceparams-cancellationtoken"><strong>ChatAsync(ChatHistory, InferenceParams, CancellationToken)</strong></h3>
  1314. <p>Get the response from the LLama model with chat histories.</p>
  1315. <pre><code class="language-csharp">public IAsyncEnumerable&lt;string&gt; ChatAsync(ChatHistory history, InferenceParams inferenceParams, CancellationToken cancellationToken)
  1316. </code></pre>
  1317. <h4 id="parameters_8">Parameters</h4>
  1318. <p><code>history</code> <a href="../llama.common.chathistory/">ChatHistory</a><br></p>
  1319. <p><code>inferenceParams</code> <a href="../llama.common.inferenceparams/">InferenceParams</a><br></p>
  1320. <p><code>cancellationToken</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken">CancellationToken</a><br></p>
  1321. <h4 id="returns_5">Returns</h4>
  1322. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iasyncenumerable-1">IAsyncEnumerable&lt;String&gt;</a><br></p>
  1323. <h3 id="chatasyncstring-inferenceparams-cancellationtoken"><strong>ChatAsync(String, InferenceParams, CancellationToken)</strong></h3>
  1324. <p>Get the response from the LLama model with chat histories asynchronously.</p>
  1325. <pre><code class="language-csharp">public IAsyncEnumerable&lt;string&gt; ChatAsync(string prompt, InferenceParams inferenceParams, CancellationToken cancellationToken)
  1326. </code></pre>
  1327. <h4 id="parameters_9">Parameters</h4>
  1328. <p><code>prompt</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.string">String</a><br></p>
  1329. <p><code>inferenceParams</code> <a href="../llama.common.inferenceparams/">InferenceParams</a><br></p>
  1330. <p><code>cancellationToken</code> <a href="https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken">CancellationToken</a><br></p>
  1331. <h4 id="returns_6">Returns</h4>
  1332. <p><a href="https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.iasyncenumerable-1">IAsyncEnumerable&lt;String&gt;</a><br></p>
  1333. </article>
  1334. </div>
  1335. </div>
  1336. </main>
  1337. <footer class="md-footer">
  1338. <div class="md-footer-meta md-typeset">
  1339. <div class="md-footer-meta__inner md-grid">
  1340. <div class="md-copyright">
  1341. Made with
  1342. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1343. Material for MkDocs
  1344. </a>
  1345. </div>
  1346. </div>
  1347. </div>
  1348. </footer>
  1349. </div>
  1350. <div class="md-dialog" data-md-component="dialog">
  1351. <div class="md-dialog__inner md-typeset"></div>
  1352. </div>
  1353. <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "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": {"provider": "mike"}}</script>
  1354. <script src="../../assets/javascripts/bundle.a51614de.min.js"></script>
  1355. </body>
  1356. </html>

C#/.NET上易用的LLM高性能推理框架,支持LLaMA和LLaVA系列模型。

Contributors (1)