Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@synw
synw committed Apr 9, 2024
1 parent 23ab614 commit 9e64181
Show file tree
Hide file tree
Showing 11 changed files with 73 additions and 67 deletions.
76 changes: 41 additions & 35 deletions docs/classes/cls.PromptTemplate.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/interfaces/interfaces.HistoryTurn.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">HistoryTurn</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L170">interfaces.ts:170</a></li></ul></aside>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L170">interfaces.ts:170</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -44,17 +44,17 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><span>assistant</span><a href="#assistant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">assistant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L172">interfaces.ts:172</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L172">interfaces.ts:172</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="images" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>images</span><a href="#images" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">images</span><span class="tsd-signature-symbol">?:</span> <a href="interfaces.ImgData.html" class="tsd-signature-type tsd-kind-interface">ImgData</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L173">interfaces.ts:173</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L173">interfaces.ts:173</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="user" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L171">interfaces.ts:171</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L171">interfaces.ts:171</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/interfaces.ImgData.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ImgData</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L159">interfaces.ts:159</a></li></ul></aside>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L159">interfaces.ts:159</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -43,12 +43,12 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L161">interfaces.ts:161</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L161">interfaces.ts:161</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L160">interfaces.ts:160</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L160">interfaces.ts:160</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
22 changes: 11 additions & 11 deletions docs/interfaces/interfaces.LmTemplate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">LmTemplate</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L96">interfaces.ts:96</a></li></ul></aside>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L96">interfaces.ts:96</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -56,23 +56,23 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L146">interfaces.ts:146</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L146">interfaces.ts:146</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="assistant" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>assistant</span><a href="#assistant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">assistant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The default message template for the assistant.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L116">interfaces.ts:116</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L116">interfaces.ts:116</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The id slug of the template.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L100">interfaces.ts:100</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L100">interfaces.ts:100</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="linebreaks" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>linebreaks</span><a href="#linebreaks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">linebreaks</span><span class="tsd-signature-symbol">?:</span> <a href="interfaces.SpacingSlots.html" class="tsd-signature-type tsd-kind-interface">SpacingSlots</a></div>
Expand All @@ -81,23 +81,23 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L142">interfaces.ts:142</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L142">interfaces.ts:142</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The name of the template.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L104">interfaces.ts:104</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L104">interfaces.ts:104</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="prefix" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>prefix</span><a href="#prefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>A prefix like a bos token to insert before content</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L150">interfaces.ts:150</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L150">interfaces.ts:150</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="shots" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>shots</span><a href="#shots" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">shots</span><span class="tsd-signature-symbol">?:</span> <a href="interfaces.TurnBlock.html" class="tsd-signature-type tsd-kind-interface">TurnBlock</a><span class="tsd-signature-symbol">[]</span></div>
Expand All @@ -106,7 +106,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L128">interfaces.ts:128</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L128">interfaces.ts:128</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="stop" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">stop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
Expand All @@ -115,15 +115,15 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L135">interfaces.ts:135</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L135">interfaces.ts:135</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="system" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>system</span><a href="#system" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">system</span><span class="tsd-signature-symbol">?:</span> <a href="interfaces.PromptBlock.html" class="tsd-signature-type tsd-kind-interface">PromptBlock</a></div>
<div class="tsd-comment tsd-typography"><p>Optional prompt block that represents system-level messages or instructions.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L121">interfaces.ts:121</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L121">interfaces.ts:121</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="user" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
Expand All @@ -132,7 +132,7 @@ <h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permali
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L111">interfaces.ts:111</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L111">interfaces.ts:111</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/interfaces.PromptBlock.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">PromptBlock</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L40">interfaces.ts:40</a></li></ul></aside>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L40">interfaces.ts:40</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -49,7 +49,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L53">interfaces.ts:53</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L53">interfaces.ts:53</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="schema" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>schema</span><a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">schema</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
Expand All @@ -58,7 +58,7 @@ <h3 class="tsd-anchor-link"><span>schema</span><a href="#schema" aria-label="Per
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/df4cccb/src/interfaces.ts#L46">interfaces.ts:46</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/synw/modprompt/blob/80cd3fb/src/interfaces.ts#L46">interfaces.ts:46</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 9e64181

Please sign in to comment.