iudex - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

package.json

 {
   "name": "iudex",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Iudex client",
-  "scripts": {
-    "build": "tsup",
-    "test": "jest"
-  },
   "main": "./dist/index.js",
@@ -45,3 +41,7 @@ "module": "./dist/index.mjs",
     "zod": "^3.22.4"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "jest"
   }
-}
+}

README.md

 # Iudex JS client
 
+Iudex is an infrastructure that enables complex and accurate function calling apis. Our infrastructure provides a
+natural language interface that can accomplish complex or answer complex queries given the control of your own functions.
+We do this by indexing functions and dividing down queries into runnable parts before surfacing the right function
+at the right time.
+
+Check out [iudex.ai](iudex.ai) to sign up.
+
 ## Installation
@@ -13,1 +20,85 @@ ```bash
 ## Usage
+
+*Example where using Iudex replaces OpenAI
+
+Here, `fnMap` just needs to be defined to link all functions you want the function calling
+api to be able to call. For Iudex all parameters except `messages` is ignored.
+
+```typescript
+import dotenv from 'dotenv';
+dotenv.config();
+import OpenAI from 'openai';
+import { Iudex } from 'iudex';
+import _ from 'lodash';
+
+const iudex = new Iudex({ apiKey: process.env.IUDEX_API_KEY });
+
+// Message history
+const messagesHist: OpenAI.ChatCompletionMessageParam[] = [];
+
+// Log when messages are pushed
+const messages = {
+  push: (...items: OpenAI.ChatCompletionMessageParam[]) => {
+    console.log('new message:', items);
+    messagesHist.push(...items);
+  },
+  value: messagesHist,
+};
+
+// Initial request
+messages.push({
+  role: 'user',
+  content: `what is ubers revenue in yen, use edgar`,
+});
+
+// Push message to pick a tool
+messages.push(await iudex.chat.completions.create({
+  model: 'gpt-4-turbo-preview',
+  messages: messages.value,
+  tools: [],
+  tool_choice: 'auto',
+}).then(res => res.choices[0].message));
+
+
+let toolMessage = _.last(messages.value);
+while (toolMessage && messageHasToolCall(toolMessage)) {
+  const {
+    function: { name: fnName, arguments: fnArgs },
+    id: tool_call_id,
+  } = toolMessage.tool_calls[0];
+
+  // Call the function
+  // const fnReturn = await fnMap[fnName](JSON.parse(fnArgs));
+  const fnReturn = 'stubbed value';
+
+  // Push function return to message history
+  messages.push({
+    role: 'tool',
+    tool_call_id,
+    content: JSON.stringify(fnReturn),
+  });
+
+  // Push to ai response message history
+  messages.push(await iudex.chat.completions.create({
+    model: 'gpt-4-turbo-preview',
+    messages: messages.value,
+  }).then(res => res.choices[0].message));
+
+  // Update toolMessage
+  toolMessage = _.last(messages.value);
+}
+
+console.log('FINISHED');
+
+
+// Helpers
+
+type OpenAIToolCallMessage = OpenAI.ChatCompletionAssistantMessageParam
+& { tool_calls: OpenAI.ChatCompletionMessageToolCall[] };
+
+function messageHasToolCall(
+  message: OpenAI.ChatCompletionMessageParam,
+): message is OpenAIToolCallMessage {
+  return !!(message as OpenAI.ChatCompletionAssistantMessageParam).tool_calls;
+}
+```

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

62506

increased by18.03%

Number of package files

9

increased by12.5%

Lines of code

891

increased by34.19%

Number of lines in readme file

104

increased by700%

Worsened metrics

Number of medium supply chain risk alerts

9

increased by28.57%

No dependency changes