evals 0.0.6 → 1.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This is the Javascript SDK for Umbrage Evals. It will have both TypeScript and JavaScript support.
+This is the Javascript SDK for Umbrage Evals. It also supports TypeScript.
 
 ## Installation
 
@@ -16,6 +16,52 @@ npm install evals
 
 -   Node.js (or another JavaScript runtime environment like Bun)
 
+## Example usage
+
+```typescript
+import Evals from 'evals';
+
+const evals = new Evals('your-umbrage-evals-api-key-goes-here'); // Get your API key from the Umbrage Evals Dashboard
+
+// Get the timestamp for the request so we can log the response time from the model
+const request_timestamp = new Date();
+
+// Setting model in a variable since it's going to be passed in two places, one for the model and one for Umbrage Evals
+const model = 'gpt-3.5-turbo';
+
+// Call the model
+const chatResponse = await openai.createChatCompletion({
+  model,
+  messages,
+  max_tokens: reservedTokensForResponse,
+  temperature: 0.2,
+});
+
+// Get the timestamp for the response so we can log the response time from the model
+const response_timestamp = new Date();
+
+// Log the prompt and response data to Umbrage Evals
+const logResponse = await evals.logPrompt({
+  prompt_name: 'unique_prompt_name', // A unique name specific to this prompt. This is what will show up in the Dashboard under your Project.
+  environment: 'development', // Which environment you're using, e.g. development, test, staging, production
+  model,
+  model_settings: {   // Optional, but recommended if you want to track model settings
+    temperature: 0.2,
+    max_tokens: 512,
+  },
+  prompts: messages.map((message) => ({
+    prompt_type: message.role,    // Make sure you have an array with prompt_type and prompt_text
+    prompt_text: message.content,
+  })),
+  response: chatResponse.data.choices[0].message.content, // Map the final text response from the model to the response field
+  request_timestamp,
+  response_timestamp, // Pass the JavaScript Date objects for the request and response timestamps
+})
+
+console.log(logResponse) // { status: 200, body: 'Prompt and response logged successfully' }
+
+```
+
 ## LICENSE
 Copyright (c) 2023 Umbrage Studios, LLC
 

package/package.json

@@ -4,7 +4,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
-  "version": "0.0.6",
+  "version": "1.0.0",
   "description": "Umbrage Evals SDK",
   "scripts": {
     "build": "bun build --target=node ./src/index.ts --outfile=dist/index.js && bun run build:declaration",