New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

polyfact

Package Overview
Dependencies
Maintainers
3
Versions
78
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

polyfact - npm Package Compare versions

Comparing version 0.1.19 to 0.1.20

demo.gif
examples/repl.ts

4

dist/generate.d.ts

@@ -0,5 +1,7 @@

import { Memory } from "./memory";
export type GenerationOptions = {
provider?: "openai" | "cohere";
chatId?: string;
memory?: Memory;
memoryId?: string;
chatId?: string;
};

@@ -6,0 +8,0 @@ declare function generateWithTokenUsage(task: string, options?: GenerationOptions): Promise<{

2

dist/generate.js

@@ -62,3 +62,3 @@ "use strict";

provider: options?.provider || "openai",
memory_id: options?.memoryId || "",
memory_id: (await options?.memory?.memoryId) || options?.memoryId || "",
chat_id: options?.chatId || "",

@@ -65,0 +65,0 @@ };

6

dist/index.d.ts

@@ -0,8 +1,8 @@

import * as t from "polyfact-io-ts";
import { generate, generateWithTokenUsage, GenerationOptions } from "./generate";
import { generateWithType, generateWithTypeWithTokenUsage } from "./probabilistic_helpers/generateWithType";
import { transcribe } from "./transcribe";
import * as t from "polyfact-io-ts";
import { splitString } from "./split";
import { createMemory, updateMemory, getAllMemories } from "./memory";
import { Memory, createMemory, updateMemory, getAllMemories } from "./memory";
import { Chat } from "./chats";
export { generate, generateWithTokenUsage, generateWithType, generateWithTypeWithTokenUsage, splitString, t, GenerationOptions, transcribe, createMemory, updateMemory, getAllMemories, Chat, };
export { generate, generateWithTokenUsage, generateWithType, generateWithTypeWithTokenUsage, splitString, t, GenerationOptions, transcribe, createMemory, updateMemory, getAllMemories, Chat, Memory, };

7

dist/index.js

@@ -26,3 +26,5 @@ "use strict";

Object.defineProperty(exports, "__esModule", { value: true });
exports.Chat = exports.getAllMemories = exports.updateMemory = exports.createMemory = exports.transcribe = exports.t = exports.splitString = exports.generateWithTypeWithTokenUsage = exports.generateWithType = exports.generateWithTokenUsage = exports.generate = void 0;
exports.Memory = exports.Chat = exports.getAllMemories = exports.updateMemory = exports.createMemory = exports.transcribe = exports.t = exports.splitString = exports.generateWithTypeWithTokenUsage = exports.generateWithType = exports.generateWithTokenUsage = exports.generate = void 0;
const t = __importStar(require("polyfact-io-ts"));
exports.t = t;
const generate_1 = require("./generate");

@@ -36,7 +38,6 @@ Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return generate_1.generate; } });

Object.defineProperty(exports, "transcribe", { enumerable: true, get: function () { return transcribe_1.transcribe; } });
const t = __importStar(require("polyfact-io-ts"));
exports.t = t;
const split_1 = require("./split");
Object.defineProperty(exports, "splitString", { enumerable: true, get: function () { return split_1.splitString; } });
const memory_1 = require("./memory");
Object.defineProperty(exports, "Memory", { enumerable: true, get: function () { return memory_1.Memory; } });
Object.defineProperty(exports, "createMemory", { enumerable: true, get: function () { return memory_1.createMemory; } });

@@ -43,0 +44,0 @@ Object.defineProperty(exports, "updateMemory", { enumerable: true, get: function () { return memory_1.updateMemory; } });

10

dist/memory.d.ts

@@ -10,2 +10,10 @@ declare function createMemory(): Promise<{

}>;
export { createMemory, updateMemory, getAllMemories };
type MemoryAddOptions = {
maxToken?: number;
};
declare class Memory {
memoryId: Promise<string>;
constructor();
add(input: string, { maxToken }?: MemoryAddOptions): Promise<void>;
}
export { createMemory, updateMemory, getAllMemories, Memory };

12

dist/memory.js

@@ -6,3 +6,3 @@ "use strict";

Object.defineProperty(exports, "__esModule", { value: true });
exports.getAllMemories = exports.updateMemory = exports.createMemory = void 0;
exports.Memory = exports.getAllMemories = exports.updateMemory = exports.createMemory = void 0;
const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));

@@ -87,1 +87,11 @@ const ensurePolyfactToken_1 = require("./helpers/ensurePolyfactToken");

exports.getAllMemories = getAllMemories;
class Memory {
constructor() {
this.memoryId = createMemory().then((res) => res.id);
}
async add(input, { maxToken = 0 } = {}) {
const id = await this.memoryId;
await updateMemory(id, input, maxToken);
}
}
exports.Memory = Memory;

6

examples/counter.ts

@@ -7,2 +7,8 @@ import { generateWithType, t } from "../lib/index";

args: t.array(t.string).description("The names of the arguments"),
type: t
.keyof({
function: null,
method: null,
})
.description("Whether the function is a function or a method"),
returnType: t.string,

@@ -9,0 +15,0 @@ });

11

examples/createMemory.ts

@@ -1,6 +0,11 @@

import { createMemory } from "../lib/index";
import { Memory, generate } from "../lib/index";
(async () => {
const memory = await createMemory();
console.log(memory); // Outputs: { id: '...' }
const memory = new Memory();
memory.add("The secret word is: banana42");
const result = await generate("What is the secret word?", { memory });
console.log(result);
})();

6

lib/generate.ts
import fetch from "isomorphic-fetch";
import * as t from "polyfact-io-ts";
import { ensurePolyfactToken } from "./helpers/ensurePolyfactToken";
import { Memory } from "./memory";

@@ -36,4 +37,5 @@ const { POLYFACT_ENDPOINT = "https://api2.polyfact.com", POLYFACT_TOKEN = "" } = process.env;

provider?: "openai" | "cohere";
chatId?: string;
memory?: Memory;
memoryId?: string;
chatId?: string;
};

@@ -56,3 +58,3 @@

provider: options?.provider || "openai",
memory_id: options?.memoryId || "",
memory_id: (await options?.memory?.memoryId) || options?.memoryId || "",
chat_id: options?.chatId || "",

@@ -59,0 +61,0 @@ };

5

lib/index.ts

@@ -0,1 +1,2 @@

import * as t from "polyfact-io-ts";
import { generate, generateWithTokenUsage, GenerationOptions } from "./generate";

@@ -7,5 +8,4 @@ import {

import { transcribe } from "./transcribe";
import * as t from "polyfact-io-ts";
import { splitString } from "./split";
import { createMemory, updateMemory, getAllMemories } from "./memory";
import { Memory, createMemory, updateMemory, getAllMemories } from "./memory";
import { Chat } from "./chats";

@@ -26,2 +26,3 @@

Chat,
Memory,
};

19

lib/memory.ts

@@ -93,2 +93,19 @@ import fetch from "isomorphic-fetch";

export { createMemory, updateMemory, getAllMemories };
type MemoryAddOptions = {
maxToken?: number;
};
class Memory {
memoryId: Promise<string>;
constructor() {
this.memoryId = createMemory().then((res) => res.id);
}
async add(input: string, { maxToken = 0 }: MemoryAddOptions = {}): Promise<void> {
const id = await this.memoryId;
await updateMemory(id, input, maxToken);
}
}
export { createMemory, updateMemory, getAllMemories, Memory };

4

package.json
{
"name": "polyfact",
"version": "0.1.19",
"version": "0.1.20",
"main": "dist/index.js",

@@ -19,3 +19,3 @@ "types": "dist/index.d.ts",

"@types/cli-progress": "^3.11.0",
"@types/node": "^14.14.31",
"@types/node": "^20.4.5",
"@types/isomorphic-fetch": "^0.0.36",

@@ -22,0 +22,0 @@ "@typescript-eslint/eslint-plugin": "^4.14.1",

279

README.md

@@ -1,13 +0,28 @@

# PolyFact
<h1 align="center">🏭 Polyfact</h1>
`polyfact` is a nodejs package aimed at assisting developers in creating project using AI.
The package is split into 2 parts:
<h4 align="center">
<a href="https://github.com/polyfact/polyfact-node/wiki">Documentation</a> |
<a href="https://github.com/polyfact/awesome-polyfact">Awesome list</a> |
<a href="https://discord.gg/8mkBfDXNTM">Discord</a>
</h4>
- The [**SDK**](#sdk) that can be imported in any nodejs project and provides the basic building blocks for AI tool developement
- The [**CLI**](#cli) which is a bundle of dev-tools currently under active development, with documentation autogeneration as its functional feature at this stage.
<p align="center">⚡ A lightweight and simple way to create tools using AI 🪶</p>
## SDK
Polyfact's goal is to make it possible to code every AI tool/Chatbot you could want in only a couple of lines of code without the need for complex abstractions and to have to deploy anything.
### Installation
<p align="center"><img src="demo.gif" /></p>
## ✨ Features
- **[Generate](https://github.com/polyfact/polyfact-node/wiki/generate)**: Answer to simple requests as text
- **[Chat](https://github.com/polyfact/polyfact-node/wiki/chat)**: Easily create chatbots
- **[Transcribe](https://github.com/polyfact/polyfact-node/wiki/transcribe)**: Transcribe audio files to text
- **[Memory](https://github.com/polyfact/polyfact-node/wiki/memory)**: Easily create a long term memory and simplify use of large amount of information
- **[Type checked generation](https://github.com/polyfact/polyfact-node/wiki/generateWithType)**: Answer simple requests with a type you defined *(🎲 probabilistic function)*
## 📚 Documentation
You can consult Polyfact's documentation at https://github.com/polyfact/polyfact-node/wiki
## 🚀 Getting started
To install polyfact into your repository:

@@ -19,3 +34,3 @@

Get your your polyfact token by signing up with github here: https://app.polyfact.com
Get your your polyfact token by signing up with github here: https://app.polyfact.com<br/>
Add your Polyfact Token in the `POLYFACT_TOKEN` environment variable:

@@ -27,244 +42,32 @@

### Usage
### 💡 Examples
### Generating a completion
There's more examples and tutorials in the [Documentation](https://github.com/polyfact/polyfact-node/wiki) but here's a simple chatbot to get you started:
Polyfact allows you to generate AI responses with or without structured data. This flexibility in the output format makes it easier to handle the AI responses according to the needs of your application.
#### With Structured Data
The `generateWithType` function generates a response that matches a certain format or "type". This "type" is defined using the `io-ts` package, which allows you to define the shape of the response you want.
To use `generateWithType`, you need to:
1. Import `generateWithType` from polyfact.
2. Import `t` from `io-ts` to define the shape of your response.
3. Create a type with `t.type()`.
4. Pass the prompt and the type to `generateWithType()`.
Here's an example:
```js
import { generateWithType } from "polyfact";
import * as t from "io-ts";
import * as readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";
import { Chat } from "polyfact";
(async () => {
const result = await generateWithType(
"Count from 1 to 5",
t.type({ result: t.array(t.number) }),
);
const rl = readline.createInterface({ input, output });
console.log(result);
})();
```
async function chatREPL() {
const chat = new Chat();
In this example, `t.type({ result: t.array(t.number) })` defines the shape of the response we want. We want a JSON object with a key `result` and an array of numbers as its value.
while (true) {
const userInput = await rl.question("> ");
The result will be a structured JSON data:
console.log(await chat.sendMessage(userInput));
}
}
```bash
{ result: [1, 2, 3, 4, 5] }
chatREPL()
```
#### Without Structured Data
## 📫 Contact us
If you do not need structured data, you can use the `generate` function, which will provide the generated response as a plain string. This function only requires the prompt as an argument.
We are striving for feedbacks and want to understand everyone's needs, you can hang out with us on [Discord](https://discord.gg/8mkBfDXNTM) !
Here's an example:
## 🧑‍💻 Contributing
```js
import { generate } from "polyfact";
(async () => {
const result = await generate("Count from 1 to 5");
console.log(result);
})();
```
#### With Token Usage
If you want to keep track of token consumption during the generation process, you can use the `generateWithTokenUsage` function. It generates the AI response and also returns the token consumption in the input and output.
Here's an example:
```js
import { generateWithTokenUsage } from "polyfact";
(async () => {
const { result, tokenUsage } = await generateWithTokenUsage("Count from 1 to 5");
console.log("Generated text:", result);
console.log("Token usage:", tokenUsage);
})();
```
In this example, the result will include the generated text and the number of tokens used for the input and output:
```bash
Generated text: 1, 2, 3, 4, 5
Token usage: { input: 4, output: 10 }
```
These functions provide a great deal of flexibility in how you generate and handle AI responses in your project. You can choose the one that best suits your needs.
### Creating a new memory
Creating a new memory involves generating a unique memory ID that will be used to store embedded data.
This process is abstracted by the SDK and requires no parameters.
```typescript
import { createMemory } from "polyfact";
(async () => {
const memory = await createMemory();
console.log(memory); // Outputs: { id: '...' }
})();
```
The resulting memory object contains a unique id that represents the new memory. This id will be used when updating the memory or referencing it in other operations.
### Updating an existing memory
Updating an existing memory involves adding embedded data to a previously created memory.
To do this, you'll need the unique memory ID that was generated when the memory was created.
The `updateMemory` function takes two parameters:
1. The unique memory id.
2. The data to be embedded into the memory.
```typescript
import { updateMemory } from "polyfact";
(async () => {
const result = await updateMemory("<memory-id>", "<input-data>");
console.log(result); // Outputs: { success: true }
})();
```
The `"<input-data>"` should be replaced with the actual data you want to embed into the memory.
The function returns an object that contains a `success` boolean property indicating whether the operation was successful.
### Getting all memories
The `getAllMemories` function retrieves the ids of all memories that have been created. This can be useful when you want to inspect all of your memories or perform operations on multiple memories.
```typescript
import { getAllMemories } from "polyfact";
(async () => {
const memories = await getAllMemories();
console.log(memories); // Outputs: { ids: ['...', '...', ...] }
})();
```
This function returns an object with an `ids` property, which is an array containing the ids of all created memories.
### Generate response using memory
The `generate` function uses the AI model to generate a response. You can optionally provide the id of a memory created using `createMemory`. The AI will match the prompt with the embedded data in the memory and include the most relevant embeddings in the context.
```typescript
import { generate } from "polyfact";
(async () => {
const response = await generate("<prompt>", "<memory-id>");
console.log(response); // Outputs: '...'
})();
```
The `"<prompt>"` should be replaced with the task or question you want to generate a response for. If a `"<memory-id>"` is provided, the AI will consider the embedded data in the specified memory when generating the response.
### Defining Types for Structured Responses
In order to structure the responses from the PolyFact AI, you can define a custom type using the `io-ts` package included in polyfact. This package provides a `t` object, from which you can access different functions to define your custom types. You can chain these functions with `.description()` method to provide an explanation to the AI about what information should be included in each field.
Below is a hypothetical example of a Book Review type:
```js
import { t } from "polyfact";
const AuthorType = t.type({
name: t.string.description("The name of the author of the book."),
nationality: t.string.description("The nationality of the author."),
});
const BookReviewType = t.type({
title: t.string.description("The title of the book being reviewed."),
author: AuthorType,
review: t.string.description("A brief review of the book."),
rating: t.number.description("A rating for the book from 1 to 5."),
recommend: t.boolean.description("Would you recommend this book to others?"),
});
const ResponseBookReview = BookReviewType;
```
In this example, `BookReviewType` is a custom type that represents a book review. It includes the title of the book, the author's information (which is another custom type `AuthorType`), a brief review of the book, a numerical rating, and a recommendation.
By defining a type with `t.type()`, you specify the shape of the response that you want from the AI. You then pass this type to `generateWithType()` function along with the prompt. The AI will then return a response that fits the format of the defined type.
This feature allows for more structure in the data that you receive from the AI, making it easier to handle and use in your application.
### Full Example
In this example, we'll demonstrate how to create a new memory, update it with some data, retrieve all memories, and generate a response using a memory.
```typescript
import { createMemory, updateMemory, getAllMemories, generate } from "polyfact";
(async () => {
const memory = await createMemory();
console.log("Created memory:", memory); // Outputs: { id: '...' }
const result = await updateMemory(memory.id, "<input-data>");
console.log("Updated memory:", result); // Outputs: { success: true }
const memories = await getAllMemories();
console.log("All memories:", memories); // Outputs: { ids: ['...', '...', ...] }
const response = await generate("<prompt>", memory.id);
console.log("Generated response:", response); // Outputs: '...'
})();
```
## CLI
`polyfact` uses the following command structure for documentation generation:
```bash
npx polyfact docs <folder> [options]
```
### Arguments
- `<folder>`: This is the path of the folder from which to generate the documentation. This argument is mandatory.
### Options
- `-n, --name <doc_name>`: This is the name of the documentation. If not provided, it defaults to 'id'.
- `-d, --deploy <subdomain>`: This option allows you to provide a subdomain to which the generated documentation will be deployed.
- `--doc_id <doc_id>`: If the doc_id has already been generated, you can send it as an argument here.
## Examples
```bash
# Generate documentation from the src folder with the default parameters
npx polyfact docs ./src
# Generate documentation with a specific name from the src folder and output to a specific folder
npx polyfact docs ./src --name "my-documentation"
# Generate documentation and deploy it to a specific subdomain
npx polyfact docs ./src --deploy my-subdomain
```
## Future Enhancements
`polyfact` is planned to support more dev-tools features in the near future. Stay tuned for more enhancements that would aid you with AI features.
Polyfact is opensource ! You can contribute to this package or to the [API](https://github.com/polyfact/polyfact-api-go) by opening an issue or a PR !
build/polyfact

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc