Open-Source AI Docs, VSCode Extension, And Polyfact SDK
We are excited to announce the start of a new chapter for us: the open sourcing of our AI Docs library and the development of a Polyfact API SDK!
We made our AI Docs tool available with the polyfact npm package. This package lets you generate reference-based documentation for your code and automatically deploys it on a static website.
We are also launching a VSCode Extension. With it, developers can easily inject references into their code as comments using a quick shortcut.
Both those packages use our Polyfact API. The API abstracts all the LLMOps: contextualization with embeddings, prompt optimization, memory management, and task retry calls. To make it possible for anybody to build on top of the Polyfact API - apps or open-source packages - we are making a new SDK. With this SDK at your disposal, you will have access to an out-of-the-box infrastructure, and build with unprecedented speed.
Exploring the Polyfact NPM Package and How to Use It
The polyfact NPM package can generate reference-based documentation for your code, and will automatically deploy a hosting website.
To use the NPM package:
- Install globally with
npm install -g polyfact - Get an API token here.
- Run
polyfact [path] [options] -t [api_token]
The software will automatically generate refs for each file in your repo and deploy a static docs website for you. The NPM package is built on top of the Polyfact API and uses it to schedule generations, make sure they go through, store results in a DB, and embed results.
Please note that we still have some libraries to unbundle, but we will be releasing them soon.
The VSCode Extension and How to Use It
The VSCode extension can help you add references to your code. Simply press CMD + SHIFT + D and the extension will create function references and insert them as comments in your code. The extension uses the Polyfact API to generate the references.
To use the extension, you need to follow these steps:
- Download the extension on the Visual Studio Code marketplace, or search "Polyfact Extension" on VSCode.
- Connect via GitHub & Get a Polyfact API token here.
- Add the token in the extension settings.
- On a specific file, press cmd + shift + D.
- Don't leave the tab or edit anything (that will crash the extension).
- After a few seconds, the extension will inject a function references through comments in the file.
This is a very simple example of something you can do with the Polyfact API, our goal is to make it possible to compose tools like the extension with modules like the AI Docs NPM package.
The Polyfact SDK and What It Will Look Like
The Polyfact SDK is an NPM package that allows you to build other packages on top of the Polyfact API. It offers key functions for launching generations without needing to worry about retries, choosing a model, or optimizing prompts. The SDK comes with a basic database to store execution results, memory to access contextual embeddings, and a context to control higher-level instructions. It also includes a plugin system to combine with other packages built on top of the API.
Are you a developer looking to save time on AI application development? Look no further. With our SDK, developers can easily access the infrastructure that was previously built for the AI Docs tool we made. By abstracting the layers of logic around LLMs, retries, token management, and embeddings, using this API eliminates the need for developers to worry about LLM ops. With everything taken care of, building your AI application or open-source package is a breeze. Don't waste any more time on development - use the Polyfact LLMOps API and streamline your workflow.
What We Plan For the Future We will soon introduce a GitHub sponsor program that supports developers who wish to create open-source packages based on our SDK. We are in the process of transitioning the API to Go and will make it as stable as we can. Additionally, we will develop several exciting packages for you to experiment with.
Looking forward to sharing this journey with you!