Skip to content

Commit

Permalink
fixing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ardan-bkennedy
ardan-bkennedy committed Jun 3, 2024
1 parent 0345da1 commit a6af0e5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ To access the API, contact us [here](https://www.predictionguard.com/getting-sta
```js
import * as pg from 'predictionguard';

const client = new pg.chat.Client('https://api.predictionguard.com', process.env.PGKEY);
const client = new pg.Client('https://api.predictionguard.com', process.env.PGKEY);

async function Chat() {
const input = [
{
role: pg.chat.Role.User,
role: pg.Roles.User,
content: 'How do you feel about the world in general',
},
];

var [result, err] = await client.Chat(pg.chat.Model.NeuralChat7B, input, 1000, 1.1);
var [result, err] = await client.Chat(pg.Models.NeuralChat7B, input, 1000, 1.1);
if (err != null) {
console.log('ERROR:' + err.error);
return;
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<pre><code><span class="hl-0"> </span><span class="hl-1">$</span><span class="hl-0"> </span><span class="hl-1">npm</span><span class="hl-0"> </span><span class="hl-1">i</span><span class="hl-0"> </span><span class="hl-1">predictionguard</span>
</code><button>Copy</button></pre>
<p><strong>Code Example</strong></p>
<pre><code class="language-js"><span class="hl-2">import</span><span class="hl-0"> </span><span class="hl-3">*</span><span class="hl-0"> </span><span class="hl-2">as</span><span class="hl-0"> </span><span class="hl-1">pg</span><span class="hl-0"> </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-4">&#39;predictionguard&#39;</span><span class="hl-0">;</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">client</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-1">pg</span><span class="hl-0">.</span><span class="hl-1">chat</span><span class="hl-0">.</span><span class="hl-6">Client</span><span class="hl-0">(</span><span class="hl-4">&#39;https://api.predictionguard.com&#39;</span><span class="hl-0">, </span><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-1">env</span><span class="hl-0">.</span><span class="hl-5">PGKEY</span><span class="hl-0">);</span><br/><br/><span class="hl-3">async</span><span class="hl-0"> </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-6">Chat</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">input</span><span class="hl-0"> = [</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">role:</span><span class="hl-0"> </span><span class="hl-1">pg</span><span class="hl-0">.</span><span class="hl-1">chat</span><span class="hl-0">.</span><span class="hl-1">Role</span><span class="hl-0">.</span><span class="hl-1">User</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-1">content:</span><span class="hl-0"> </span><span class="hl-4">&#39;How do you feel about the world in general&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> ];</span><br/><br/><span class="hl-0"> </span><span class="hl-3">var</span><span class="hl-0"> [</span><span class="hl-1">result</span><span class="hl-0">, </span><span class="hl-1">err</span><span class="hl-0">] = </span><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-1">client</span><span class="hl-0">.</span><span class="hl-6">Chat</span><span class="hl-0">(</span><span class="hl-1">pg</span><span class="hl-0">.</span><span class="hl-1">chat</span><span class="hl-0">.</span><span class="hl-1">Model</span><span class="hl-0">.</span><span class="hl-1">NeuralChat7B</span><span class="hl-0">, </span><span class="hl-1">input</span><span class="hl-0">, </span><span class="hl-7">1000</span><span class="hl-0">, </span><span class="hl-7">1.1</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">if</span><span class="hl-0"> (</span><span class="hl-1">err</span><span class="hl-0"> != </span><span class="hl-3">null</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-4">&#39;ERROR:&#39;</span><span class="hl-0"> + </span><span class="hl-1">err</span><span class="hl-0">.</span><span class="hl-1">error</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">return</span><span class="hl-0">;</span><br/><span class="hl-0"> }</span><br/><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-4">&#39;RESULT:&#39;</span><span class="hl-0"> + </span><span class="hl-1">result</span><span class="hl-0">.</span><span class="hl-1">model</span><span class="hl-0"> + </span><span class="hl-4">&#39;: &#39;</span><span class="hl-0"> + </span><span class="hl-1">result</span><span class="hl-0">.</span><span class="hl-1">choices</span><span class="hl-0">[</span><span class="hl-7">0</span><span class="hl-0">].</span><span class="hl-1">message</span><span class="hl-0">.</span><span class="hl-1">content</span><span class="hl-0">);</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-6">Chat</span><span class="hl-0">();</span>
<pre><code class="language-js"><span class="hl-2">import</span><span class="hl-0"> </span><span class="hl-3">*</span><span class="hl-0"> </span><span class="hl-2">as</span><span class="hl-0"> </span><span class="hl-1">pg</span><span class="hl-0"> </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-4">&#39;predictionguard&#39;</span><span class="hl-0">;</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">client</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-1">pg</span><span class="hl-0">.</span><span class="hl-6">Client</span><span class="hl-0">(</span><span class="hl-4">&#39;https://api.predictionguard.com&#39;</span><span class="hl-0">, </span><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-1">env</span><span class="hl-0">.</span><span class="hl-5">PGKEY</span><span class="hl-0">);</span><br/><br/><span class="hl-3">async</span><span class="hl-0"> </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-6">Chat</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">input</span><span class="hl-0"> = [</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">role:</span><span class="hl-0"> </span><span class="hl-1">pg</span><span class="hl-0">.</span><span class="hl-1">Roles</span><span class="hl-0">.</span><span class="hl-1">User</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-1">content:</span><span class="hl-0"> </span><span class="hl-4">&#39;How do you feel about the world in general&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> ];</span><br/><br/><span class="hl-0"> </span><span class="hl-3">var</span><span class="hl-0"> [</span><span class="hl-1">result</span><span class="hl-0">, </span><span class="hl-1">err</span><span class="hl-0">] = </span><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-1">client</span><span class="hl-0">.</span><span class="hl-6">Chat</span><span class="hl-0">(</span><span class="hl-1">pg</span><span class="hl-0">.</span><span class="hl-1">Models</span><span class="hl-0">.</span><span class="hl-1">NeuralChat7B</span><span class="hl-0">, </span><span class="hl-1">input</span><span class="hl-0">, </span><span class="hl-7">1000</span><span class="hl-0">, </span><span class="hl-7">1.1</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">if</span><span class="hl-0"> (</span><span class="hl-1">err</span><span class="hl-0"> != </span><span class="hl-3">null</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-4">&#39;ERROR:&#39;</span><span class="hl-0"> + </span><span class="hl-1">err</span><span class="hl-0">.</span><span class="hl-1">error</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">return</span><span class="hl-0">;</span><br/><span class="hl-0"> }</span><br/><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-4">&#39;RESULT:&#39;</span><span class="hl-0"> + </span><span class="hl-1">result</span><span class="hl-0">.</span><span class="hl-1">model</span><span class="hl-0"> + </span><span class="hl-4">&#39;: &#39;</span><span class="hl-0"> + </span><span class="hl-1">result</span><span class="hl-0">.</span><span class="hl-1">choices</span><span class="hl-0">[</span><span class="hl-7">0</span><span class="hl-0">].</span><span class="hl-1">message</span><span class="hl-0">.</span><span class="hl-1">content</span><span class="hl-0">);</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-6">Chat</span><span class="hl-0">();</span>
</code><button>Copy</button></pre>
<p>Take a look at the <a href="https://github.com/predictionguard/js-client/tree/main/examples">examples</a> directory for more examples.</p>
<a id="md:docs" class="tsd-anchor"></a><h3><a href="#md:docs">Docs</a></h3><p>You can find the SDK and Prediction Guard docs using these links.</p>
Expand Down

0 comments on commit a6af0e5

Please sign in to comment.