init
This commit is contained in:
106
README.md
Normal file
106
README.md
Normal file
@@ -0,0 +1,106 @@
|
||||
<!-- Header -->
|
||||
<div id="top" align="center">
|
||||
<br />
|
||||
|
||||
<!-- Logo -->
|
||||
<img src="https://git.zakscode.com/repo-avatars/a90851ca730480ec37a5c0c2c4f1b4609eee5eadf806eaf16c83ac4cb7493aa9" alt="Logo" width="200" height="200">
|
||||
|
||||
<!-- Title -->
|
||||
### @ztimson/ai-utils
|
||||
|
||||
<!-- Description -->
|
||||
AI Utility Library - Unified interface for multiple AI providers
|
||||
|
||||
<!-- Repo badges -->
|
||||
[](https://git.zakscode.com/ztimson/ai-utils/tags)
|
||||
[](https://git.zakscode.com/ztimson/ai-utils/pulls)
|
||||
[](https://git.zakscode.com/ztimson/ai-utils/issues)
|
||||
|
||||
<!-- Links -->
|
||||
|
||||
---
|
||||
<div>
|
||||
<a href="https://ai-utils.docs.zakscode.com" target="_blank">Documentation</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/ai-utils/releases" target="_blank">Release Notes</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/ai-utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/ai-utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||
</div>
|
||||
|
||||
---
|
||||
</div>
|
||||
|
||||
## Table of Contents
|
||||
- [@ztimson/ai-utils](#top)
|
||||
- [About](#about)
|
||||
- [Features](#features)
|
||||
- [Built With](#built-with)
|
||||
- [Setup](#setup)
|
||||
- [Production](#production)
|
||||
- [Development](#development)
|
||||
- [Documentation](https://ai-utils.docs.zakscode.com/)
|
||||
- [License](#license)
|
||||
|
||||
## About
|
||||
|
||||
A TypeScript library that provides a unified interface for working with multiple AI providers, making it easy to integrate various AI capabilities into your applications.
|
||||
|
||||
### Features
|
||||
|
||||
- **Multi-Provider LLM Support**: Seamlessly work with OpenAI, Anthropic (Claude), and Self-hosted (Ollama) models
|
||||
- **Audio Speech Recognition (ASR)**: Convert audio to text using Whisper models
|
||||
- **Optical Character Recognition (OCR)**: Extract text from images using Tesseract
|
||||
- **Semantic Similarity**: Compare text similarity using tensor-based cosine similarity
|
||||
- **Provider Abstraction**: Switch between AI providers without changing your code
|
||||
|
||||
### Built With
|
||||
[](https://anthropic.com/)
|
||||
[](https://openai.com/)
|
||||
[](https://ollama.com/)
|
||||
[](https://tensorflow.org/)
|
||||
[](https://tesseract-ocr.github.io/)
|
||||
[](https://typescriptlang.org/)
|
||||
[](https://github.com/ggerganov/whisper.cpp)
|
||||
|
||||
## Setup
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3 id="production" style="display: inline">
|
||||
Production
|
||||
</h3>
|
||||
</summary>
|
||||
|
||||
#### Prerequisites
|
||||
- [Node.js](https://nodejs.org/en/download)
|
||||
|
||||
#### Instructions
|
||||
1. Install the package: `npm i @ztimson/ai-utils`
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3 id="development" style="display: inline">
|
||||
Development
|
||||
</h3>
|
||||
</summary>
|
||||
|
||||
#### Prerequisites
|
||||
- [Node.js](https://nodejs.org/en/download)
|
||||
|
||||
#### Instructions
|
||||
1. Install the dependencies: `npm i`
|
||||
2. Build library: `npm build`
|
||||
3. Run unit tests: `npm test`
|
||||
|
||||
</details>
|
||||
|
||||
## Documentation
|
||||
|
||||
[Available Here](https://ai-utils.docs.zakscode.com/)
|
||||
|
||||
## License
|
||||
|
||||
Copyright © 2023 Zakary Timson | Available under MIT Licensing
|
||||
|
||||
See the [license](_media/LICENSE) for more information.
|
||||
Reference in New Issue
Block a user