Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
4bf7113334 | ||
| 6bdbeae144 | |||
| 09c27379cb | |||
| 2bc6f7ee5e | |||
| 0ac50d647d | |||
| 5f9ffc7356 | |||
| 502b665224 | |||
| bda0d7ed7e | |||
| de2a60d12f | |||
| 5b3a93a43a | |||
| 6b241f8889 | |||
| 0a80ac0a8a | |||
| 6ce442354e |
47
changelog.md
47
changelog.md
@@ -1,5 +1,52 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-07-25 - 0.5.5 - feat(documentation)
|
||||
Comprehensive documentation enhancement and test improvements
|
||||
|
||||
- Completely rewrote readme.md with detailed provider comparisons, advanced usage examples, and performance tips
|
||||
- Added comprehensive examples for all supported providers (OpenAI, Anthropic, Perplexity, Groq, XAI, Ollama, Exo)
|
||||
- Included detailed sections on chat interactions, streaming, TTS, vision processing, and document analysis
|
||||
- Added verbose flag to test script for better debugging
|
||||
|
||||
## 2025-05-13 - 0.5.4 - fix(provider.openai)
|
||||
Update dependency versions, clean test imports, and adjust default OpenAI model configurations
|
||||
|
||||
- Bump dependency versions in package.json (@git.zone/tsbuild, @push.rocks/tapbundle, openai, etc.)
|
||||
- Change default chatModel from 'gpt-4o' to 'o4-mini' and visionModel from 'gpt-4o' to '04-mini' in provider.openai.ts
|
||||
- Remove unused 'expectAsync' import from test file
|
||||
|
||||
## 2025-04-03 - 0.5.3 - fix(package.json)
|
||||
Add explicit packageManager field to package.json
|
||||
|
||||
- Include the packageManager property to specify the pnpm version and checksum.
|
||||
- Align package metadata with current standards.
|
||||
|
||||
## 2025-04-03 - 0.5.2 - fix(readme)
|
||||
Remove redundant conclusion section from README to streamline documentation.
|
||||
|
||||
- Eliminated the conclusion block describing SmartAi's capabilities and documentation pointers.
|
||||
|
||||
## 2025-02-25 - 0.5.1 - fix(OpenAiProvider)
|
||||
Corrected audio model ID in OpenAiProvider
|
||||
|
||||
- Fixed audio model identifier from 'o3-mini' to 'tts-1-hd' in the OpenAiProvider's audio method.
|
||||
- Addressed minor code formatting issues in test suite for better readability.
|
||||
- Corrected spelling errors in test documentation and comments.
|
||||
|
||||
## 2025-02-25 - 0.5.0 - feat(documentation and configuration)
|
||||
Enhanced package and README documentation
|
||||
|
||||
- Expanded the package description to better reflect the library's capabilities.
|
||||
- Improved README with detailed usage examples for initialization, chat interactions, streaming chat, audio generation, document analysis, and vision processing.
|
||||
- Provided error handling strategies and advanced streaming customization examples.
|
||||
|
||||
## 2025-02-25 - 0.4.2 - fix(core)
|
||||
Fix OpenAI chat streaming and PDF document processing logic.
|
||||
|
||||
- Updated OpenAI chat streaming to handle new async iterable format.
|
||||
- Improved PDF document processing by filtering out empty image buffers.
|
||||
- Removed unsupported temperature options from OpenAI requests.
|
||||
|
||||
## 2025-02-25 - 0.4.1 - fix(provider)
|
||||
Fix provider modules for consistency
|
||||
|
||||
|
||||
@@ -5,20 +5,33 @@
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartai",
|
||||
"description": "A TypeScript library for integrating and interacting with multiple AI models, offering capabilities for chat and potentially audio responses.",
|
||||
"description": "SmartAi is a versatile TypeScript library designed to facilitate integration and interaction with various AI models, offering functionalities for chat, audio generation, document processing, and vision tasks.",
|
||||
"npmPackagename": "@push.rocks/smartai",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"AI integration",
|
||||
"chatbot",
|
||||
"TypeScript",
|
||||
"chatbot",
|
||||
"OpenAI",
|
||||
"Anthropic",
|
||||
"multi-model support",
|
||||
"audio responses",
|
||||
"multi-model",
|
||||
"audio generation",
|
||||
"text-to-speech",
|
||||
"streaming chat"
|
||||
"document processing",
|
||||
"vision processing",
|
||||
"streaming chat",
|
||||
"API",
|
||||
"multiple providers",
|
||||
"AI models",
|
||||
"synchronous chat",
|
||||
"asynchronous chat",
|
||||
"real-time interaction",
|
||||
"content analysis",
|
||||
"image description",
|
||||
"document classification",
|
||||
"AI toolkit",
|
||||
"provider switching"
|
||||
]
|
||||
}
|
||||
},
|
||||
|
||||
54
package.json
54
package.json
@@ -1,37 +1,37 @@
|
||||
{
|
||||
"name": "@push.rocks/smartai",
|
||||
"version": "0.4.1",
|
||||
"version": "0.5.5",
|
||||
"private": false,
|
||||
"description": "A TypeScript library for integrating and interacting with multiple AI models, offering capabilities for chat and potentially audio responses.",
|
||||
"description": "SmartAi is a versatile TypeScript library designed to facilitate integration and interaction with various AI models, offering functionalities for chat, audio generation, document processing, and vision tasks.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Task Venture Capital GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"test": "(tstest test/ --web --verbose)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "(tsdoc)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.2.1",
|
||||
"@git.zone/tsbundle": "^2.2.5",
|
||||
"@git.zone/tsbuild": "^2.6.4",
|
||||
"@git.zone/tsbundle": "^2.5.1",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^1.0.96",
|
||||
"@git.zone/tstest": "^2.3.2",
|
||||
"@push.rocks/qenv": "^6.1.0",
|
||||
"@push.rocks/tapbundle": "^5.5.6",
|
||||
"@types/node": "^22.13.5"
|
||||
"@push.rocks/tapbundle": "^6.0.3",
|
||||
"@types/node": "^22.15.17"
|
||||
},
|
||||
"dependencies": {
|
||||
"@anthropic-ai/sdk": "^0.37.0",
|
||||
"@anthropic-ai/sdk": "^0.57.0",
|
||||
"@push.rocks/smartarray": "^1.1.0",
|
||||
"@push.rocks/smartfile": "^11.2.0",
|
||||
"@push.rocks/smartfile": "^11.2.5",
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartpdf": "^3.1.8",
|
||||
"@push.rocks/smartpdf": "^3.2.2",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrequest": "^2.0.23",
|
||||
"@push.rocks/smartrequest": "^2.1.0",
|
||||
"@push.rocks/webstream": "^1.0.10",
|
||||
"openai": "^4.85.4"
|
||||
"openai": "^5.10.2"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -58,13 +58,33 @@
|
||||
],
|
||||
"keywords": [
|
||||
"AI integration",
|
||||
"chatbot",
|
||||
"TypeScript",
|
||||
"chatbot",
|
||||
"OpenAI",
|
||||
"Anthropic",
|
||||
"multi-model support",
|
||||
"audio responses",
|
||||
"multi-model",
|
||||
"audio generation",
|
||||
"text-to-speech",
|
||||
"streaming chat"
|
||||
"document processing",
|
||||
"vision processing",
|
||||
"streaming chat",
|
||||
"API",
|
||||
"multiple providers",
|
||||
"AI models",
|
||||
"synchronous chat",
|
||||
"asynchronous chat",
|
||||
"real-time interaction",
|
||||
"content analysis",
|
||||
"image description",
|
||||
"document classification",
|
||||
"AI toolkit",
|
||||
"provider switching"
|
||||
],
|
||||
"pnpm": {
|
||||
"onlyBuiltDependencies": [
|
||||
"esbuild",
|
||||
"puppeteer"
|
||||
]
|
||||
},
|
||||
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
|
||||
}
|
||||
|
||||
3532
pnpm-lock.yaml
generated
3532
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
507
readme.md
507
readme.md
@@ -1,329 +1,392 @@
|
||||
# @push.rocks/smartai
|
||||
|
||||
[](https://www.npmjs.com/package/@push.rocks/smartai)
|
||||
SmartAi is a powerful TypeScript library that provides a unified interface for integrating with multiple AI providers including OpenAI, Anthropic, Perplexity, Ollama, Groq, XAI, and Exo. It offers comprehensive support for chat interactions, streaming conversations, text-to-speech, document analysis, and vision processing.
|
||||
|
||||
SmartAi is a comprehensive TypeScript library that provides a standardized interface for integrating and interacting with multiple AI models. It supports a range of operations from synchronous and streaming chat to audio generation, document processing, and vision tasks.
|
||||
## Install
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [Supported AI Providers](#supported-ai-providers)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Usage Examples](#usage-examples)
|
||||
- [Chat Interactions](#chat-interactions)
|
||||
- [Streaming Chat](#streaming-chat)
|
||||
- [Audio Generation](#audio-generation)
|
||||
- [Document Processing](#document-processing)
|
||||
- [Vision Processing](#vision-processing)
|
||||
- [Error Handling](#error-handling)
|
||||
- [Development](#development)
|
||||
- [Running Tests](#running-tests)
|
||||
- [Building the Project](#building-the-project)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Legal Information](#legal-information)
|
||||
|
||||
## Features
|
||||
|
||||
- **Unified API:** Seamlessly integrate multiple AI providers with a consistent interface.
|
||||
- **Chat & Streaming:** Support for both synchronous and real-time streaming chat interactions.
|
||||
- **Audio & Vision:** Generate audio responses and perform detailed image analysis.
|
||||
- **Document Processing:** Analyze PDFs and other documents using vision models.
|
||||
- **Extensible:** Easily extend the library to support additional AI providers.
|
||||
|
||||
## Installation
|
||||
|
||||
To install SmartAi, run the following command:
|
||||
To install SmartAi into your project, use pnpm:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartai
|
||||
pnpm install @push.rocks/smartai
|
||||
```
|
||||
|
||||
This will add the package to your project’s dependencies.
|
||||
## Usage
|
||||
|
||||
## Supported AI Providers
|
||||
SmartAi provides a clean, consistent API across all supported AI providers. This documentation covers all features with practical examples for each provider and capability.
|
||||
|
||||
SmartAi supports multiple AI providers. Configure each provider with its corresponding token or settings:
|
||||
### Initialization
|
||||
|
||||
### OpenAI
|
||||
|
||||
- **Models:** GPT-4, GPT-3.5-turbo, GPT-4-vision-preview
|
||||
- **Features:** Chat, Streaming, Audio Generation, Vision, Document Processing
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
openaiToken: 'your-openai-token'
|
||||
```
|
||||
|
||||
### X.AI
|
||||
|
||||
- **Models:** Grok-2-latest
|
||||
- **Features:** Chat, Streaming, Document Processing
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
xaiToken: 'your-xai-token'
|
||||
```
|
||||
|
||||
### Anthropic
|
||||
|
||||
- **Models:** Claude-3-opus-20240229
|
||||
- **Features:** Chat, Streaming, Vision, Document Processing
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
anthropicToken: 'your-anthropic-token'
|
||||
```
|
||||
|
||||
### Perplexity
|
||||
|
||||
- **Models:** Mixtral-8x7b-instruct
|
||||
- **Features:** Chat, Streaming
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
perplexityToken: 'your-perplexity-token'
|
||||
```
|
||||
|
||||
### Groq
|
||||
|
||||
- **Models:** Llama-3.3-70b-versatile
|
||||
- **Features:** Chat, Streaming
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
groqToken: 'your-groq-token'
|
||||
```
|
||||
|
||||
### Ollama
|
||||
|
||||
- **Models:** Configurable (default: llama2; use llava for vision/document tasks)
|
||||
- **Features:** Chat, Streaming, Vision, Document Processing
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
ollama: {
|
||||
baseUrl: 'http://localhost:11434', // Optional
|
||||
model: 'llama2', // Optional
|
||||
visionModel: 'llava' // Optional for vision and document tasks
|
||||
}
|
||||
```
|
||||
|
||||
### Exo
|
||||
|
||||
- **Models:** Configurable (supports LLaMA, Mistral, LlaVA, Qwen, and Deepseek)
|
||||
- **Features:** Chat, Streaming
|
||||
- **Configuration Example:**
|
||||
|
||||
```typescript
|
||||
exo: {
|
||||
baseUrl: 'http://localhost:8080/v1', // Optional
|
||||
apiKey: 'your-api-key' // Optional for local deployments
|
||||
}
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
Initialize SmartAi with the provider configurations you plan to use:
|
||||
First, initialize SmartAi with the API tokens and configuration for the providers you want to use:
|
||||
|
||||
```typescript
|
||||
import { SmartAi } from '@push.rocks/smartai';
|
||||
|
||||
const smartAi = new SmartAi({
|
||||
openaiToken: 'your-openai-token',
|
||||
xaiToken: 'your-xai-token',
|
||||
anthropicToken: 'your-anthropic-token',
|
||||
perplexityToken: 'your-perplexity-token',
|
||||
groqToken: 'your-groq-token',
|
||||
// OpenAI - for GPT models, DALL-E, and TTS
|
||||
openaiToken: 'your-openai-api-key',
|
||||
|
||||
// Anthropic - for Claude models
|
||||
anthropicToken: 'your-anthropic-api-key',
|
||||
|
||||
// Perplexity - for research-focused AI
|
||||
perplexityToken: 'your-perplexity-api-key',
|
||||
|
||||
// Groq - for fast inference
|
||||
groqToken: 'your-groq-api-key',
|
||||
|
||||
// XAI - for Grok models
|
||||
xaiToken: 'your-xai-api-key',
|
||||
|
||||
// Ollama - for local models
|
||||
ollama: {
|
||||
baseUrl: 'http://localhost:11434',
|
||||
model: 'llama2'
|
||||
model: 'llama2', // default model for chat
|
||||
visionModel: 'llava' // default model for vision
|
||||
},
|
||||
|
||||
// Exo - for distributed inference
|
||||
exo: {
|
||||
baseUrl: 'http://localhost:8080/v1',
|
||||
apiKey: 'your-api-key'
|
||||
apiKey: 'your-exo-api-key'
|
||||
}
|
||||
});
|
||||
|
||||
// Start the SmartAi instance
|
||||
await smartAi.start();
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
## Supported Providers
|
||||
|
||||
### Chat Interactions
|
||||
SmartAi supports the following AI providers:
|
||||
|
||||
**Synchronous Chat:**
|
||||
| Provider | Use Case | Key Features |
|
||||
|----------|----------|--------------|
|
||||
| **OpenAI** | General purpose, GPT models | Chat, streaming, TTS, vision, documents |
|
||||
| **Anthropic** | Claude models, safety-focused | Chat, streaming, vision, documents |
|
||||
| **Perplexity** | Research and factual queries | Chat, streaming, documents |
|
||||
| **Groq** | Fast inference | Chat, streaming |
|
||||
| **XAI** | Grok models | Chat, streaming |
|
||||
| **Ollama** | Local models | Chat, streaming, vision |
|
||||
| **Exo** | Distributed inference | Chat, streaming |
|
||||
|
||||
## Core Features
|
||||
|
||||
### 1. Chat Interactions
|
||||
|
||||
SmartAi provides both synchronous and streaming chat capabilities across all supported providers.
|
||||
|
||||
#### Synchronous Chat
|
||||
|
||||
Simple request-response interactions with any provider:
|
||||
|
||||
```typescript
|
||||
const response = await smartAi.openaiProvider.chat({
|
||||
// OpenAI Example
|
||||
const openAiResponse = await smartAi.openaiProvider.chat({
|
||||
systemMessage: 'You are a helpful assistant.',
|
||||
userMessage: 'What is the capital of France?',
|
||||
messageHistory: [] // Include previous conversation messages if applicable
|
||||
messageHistory: []
|
||||
});
|
||||
console.log(openAiResponse.message); // "The capital of France is Paris."
|
||||
|
||||
console.log(response.message);
|
||||
// Anthropic Example
|
||||
const anthropicResponse = await smartAi.anthropicProvider.chat({
|
||||
systemMessage: 'You are a knowledgeable historian.',
|
||||
userMessage: 'Tell me about the French Revolution',
|
||||
messageHistory: []
|
||||
});
|
||||
console.log(anthropicResponse.message);
|
||||
|
||||
// Using message history for context
|
||||
const contextualResponse = await smartAi.openaiProvider.chat({
|
||||
systemMessage: 'You are a math tutor.',
|
||||
userMessage: 'What about multiplication?',
|
||||
messageHistory: [
|
||||
{ role: 'user', content: 'Can you teach me math?' },
|
||||
{ role: 'assistant', content: 'Of course! What would you like to learn?' }
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
### Streaming Chat
|
||||
#### Streaming Chat
|
||||
|
||||
**Real-Time Streaming:**
|
||||
For real-time, token-by-token responses:
|
||||
|
||||
```typescript
|
||||
const textEncoder = new TextEncoder();
|
||||
const textDecoder = new TextDecoder();
|
||||
|
||||
// Create a transform stream for sending and receiving data
|
||||
const { writable, readable } = new TransformStream();
|
||||
// Create a readable stream for input
|
||||
const { readable, writable } = new TransformStream();
|
||||
const writer = writable.getWriter();
|
||||
|
||||
const message = {
|
||||
// Send a message
|
||||
const encoder = new TextEncoder();
|
||||
await writer.write(encoder.encode(JSON.stringify({
|
||||
role: 'user',
|
||||
content: 'Tell me a story about a brave knight'
|
||||
};
|
||||
content: 'Write a haiku about programming'
|
||||
})));
|
||||
await writer.close();
|
||||
|
||||
writer.write(textEncoder.encode(JSON.stringify(message) + '\n'));
|
||||
|
||||
// Start streaming the response
|
||||
const stream = await smartAi.openaiProvider.chatStream(readable);
|
||||
const reader = stream.getReader();
|
||||
// Get streaming response
|
||||
const responseStream = await smartAi.openaiProvider.chatStream(readable);
|
||||
const reader = responseStream.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
|
||||
// Read the stream
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
console.log('AI:', value);
|
||||
process.stdout.write(value); // Print each chunk as it arrives
|
||||
}
|
||||
```
|
||||
|
||||
### Audio Generation
|
||||
### 2. Text-to-Speech (Audio Generation)
|
||||
|
||||
Generate audio (supported by providers like OpenAI):
|
||||
Convert text to natural-sounding speech (currently supported by OpenAI):
|
||||
|
||||
```typescript
|
||||
import * as fs from 'fs';
|
||||
|
||||
// Generate speech from text
|
||||
const audioStream = await smartAi.openaiProvider.audio({
|
||||
message: 'Hello, this is a test of text-to-speech'
|
||||
message: 'Hello world! This is a test of the text-to-speech system.'
|
||||
});
|
||||
|
||||
// Process the audio stream, for example, play it or save to a file.
|
||||
```
|
||||
// Save to file
|
||||
const writeStream = fs.createWriteStream('output.mp3');
|
||||
audioStream.pipe(writeStream);
|
||||
|
||||
### Document Processing
|
||||
|
||||
Analyze and extract key information from documents:
|
||||
|
||||
```typescript
|
||||
// Example using OpenAI
|
||||
const documentResult = await smartAi.openaiProvider.document({
|
||||
systemMessage: 'Classify the document type',
|
||||
userMessage: 'What type of document is this?',
|
||||
messageHistory: [],
|
||||
pdfDocuments: [pdfBuffer] // Uint8Array containing the PDF content
|
||||
// Or use in your application directly
|
||||
audioStream.on('data', (chunk) => {
|
||||
// Process audio chunks
|
||||
});
|
||||
```
|
||||
|
||||
Other providers (e.g., Ollama and Anthropic) follow a similar pattern:
|
||||
### 3. Vision Processing
|
||||
|
||||
Analyze images and get detailed descriptions:
|
||||
|
||||
```typescript
|
||||
// Using Ollama for document processing
|
||||
const ollamaResult = await smartAi.ollamaProvider.document({
|
||||
systemMessage: 'You are a document analysis assistant',
|
||||
userMessage: 'Extract key information from this document',
|
||||
import * as fs from 'fs';
|
||||
|
||||
// Read an image file
|
||||
const imageBuffer = fs.readFileSync('image.jpg');
|
||||
|
||||
// OpenAI Vision
|
||||
const openAiVision = await smartAi.openaiProvider.vision({
|
||||
image: imageBuffer,
|
||||
prompt: 'What is in this image? Describe in detail.'
|
||||
});
|
||||
console.log('OpenAI:', openAiVision);
|
||||
|
||||
// Anthropic Vision
|
||||
const anthropicVision = await smartAi.anthropicProvider.vision({
|
||||
image: imageBuffer,
|
||||
prompt: 'Analyze this image and identify any text or objects.'
|
||||
});
|
||||
console.log('Anthropic:', anthropicVision);
|
||||
|
||||
// Ollama Vision (using local model)
|
||||
const ollamaVision = await smartAi.ollamaProvider.vision({
|
||||
image: imageBuffer,
|
||||
prompt: 'Describe the colors and composition of this image.'
|
||||
});
|
||||
console.log('Ollama:', ollamaVision);
|
||||
```
|
||||
|
||||
### 4. Document Analysis
|
||||
|
||||
Process and analyze PDF documents with AI:
|
||||
|
||||
```typescript
|
||||
import * as fs from 'fs';
|
||||
|
||||
// Read PDF documents
|
||||
const pdfBuffer = fs.readFileSync('document.pdf');
|
||||
|
||||
// Analyze with OpenAI
|
||||
const openAiAnalysis = await smartAi.openaiProvider.document({
|
||||
systemMessage: 'You are a document analyst. Extract key information.',
|
||||
userMessage: 'Summarize this document and list the main points.',
|
||||
messageHistory: [],
|
||||
pdfDocuments: [pdfBuffer]
|
||||
});
|
||||
```
|
||||
console.log('OpenAI Analysis:', openAiAnalysis.message);
|
||||
|
||||
```typescript
|
||||
// Using Anthropic for document processing
|
||||
const anthropicResult = await smartAi.anthropicProvider.document({
|
||||
systemMessage: 'Analyze the document',
|
||||
userMessage: 'Please extract the main points',
|
||||
// Analyze with Anthropic
|
||||
const anthropicAnalysis = await smartAi.anthropicProvider.document({
|
||||
systemMessage: 'You are a legal expert.',
|
||||
userMessage: 'Identify any legal terms or implications in this document.',
|
||||
messageHistory: [],
|
||||
pdfDocuments: [pdfBuffer]
|
||||
});
|
||||
console.log('Anthropic Analysis:', anthropicAnalysis.message);
|
||||
|
||||
// Process multiple documents
|
||||
const doc1 = fs.readFileSync('contract1.pdf');
|
||||
const doc2 = fs.readFileSync('contract2.pdf');
|
||||
|
||||
const comparison = await smartAi.openaiProvider.document({
|
||||
systemMessage: 'You are a contract analyst.',
|
||||
userMessage: 'Compare these two contracts and highlight the differences.',
|
||||
messageHistory: [],
|
||||
pdfDocuments: [doc1, doc2]
|
||||
});
|
||||
console.log('Comparison:', comparison.message);
|
||||
```
|
||||
|
||||
### Vision Processing
|
||||
### 5. Conversation Management
|
||||
|
||||
Analyze images with vision capabilities:
|
||||
Create persistent conversation sessions with any provider:
|
||||
|
||||
```typescript
|
||||
// Using OpenAI GPT-4 Vision
|
||||
const imageDescription = await smartAi.openaiProvider.vision({
|
||||
image: imageBuffer, // Uint8Array containing image data
|
||||
prompt: 'What do you see in this image?'
|
||||
});
|
||||
// Create a conversation with OpenAI
|
||||
const conversation = smartAi.createConversation('openai');
|
||||
|
||||
// Using Ollama for vision tasks
|
||||
const ollamaImageAnalysis = await smartAi.ollamaProvider.vision({
|
||||
image: imageBuffer,
|
||||
prompt: 'Analyze this image in detail'
|
||||
});
|
||||
// Set the system message
|
||||
await conversation.setSystemMessage('You are a helpful coding assistant.');
|
||||
|
||||
// Using Anthropic for vision analysis
|
||||
const anthropicImageAnalysis = await smartAi.anthropicProvider.vision({
|
||||
image: imageBuffer,
|
||||
prompt: 'Describe the contents of this image'
|
||||
});
|
||||
// Get input and output streams
|
||||
const inputWriter = conversation.getInputStreamWriter();
|
||||
const outputStream = conversation.getOutputStream();
|
||||
|
||||
// Set up output reader
|
||||
const reader = outputStream.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
|
||||
// Send messages
|
||||
await inputWriter.write('How do I create a REST API in Node.js?');
|
||||
|
||||
// Read responses
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
console.log('Assistant:', decoder.decode(value));
|
||||
}
|
||||
|
||||
// Continue the conversation
|
||||
await inputWriter.write('Can you show me an example with Express?');
|
||||
|
||||
// Create conversations with different providers
|
||||
const anthropicConversation = smartAi.createConversation('anthropic');
|
||||
const groqConversation = smartAi.createConversation('groq');
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
## Advanced Usage
|
||||
|
||||
Always wrap API calls in try-catch blocks to manage errors effectively:
|
||||
### Error Handling
|
||||
|
||||
Always wrap AI operations in try-catch blocks for robust error handling:
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const response = await smartAi.openaiProvider.chat({
|
||||
systemMessage: 'You are a helpful assistant.',
|
||||
systemMessage: 'You are an assistant.',
|
||||
userMessage: 'Hello!',
|
||||
messageHistory: []
|
||||
});
|
||||
console.log(response.message);
|
||||
} catch (error: any) {
|
||||
console.error('AI provider error:', error.message);
|
||||
} catch (error) {
|
||||
if (error.code === 'rate_limit_exceeded') {
|
||||
console.error('Rate limit hit, please retry later');
|
||||
} else if (error.code === 'invalid_api_key') {
|
||||
console.error('Invalid API key provided');
|
||||
} else {
|
||||
console.error('Unexpected error:', error.message);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Development
|
||||
### Streaming with Custom Processing
|
||||
|
||||
### Running Tests
|
||||
Implement custom transformations on streaming responses:
|
||||
|
||||
To run the test suite, use the following command:
|
||||
```typescript
|
||||
// Create a custom transform stream
|
||||
const customTransform = new TransformStream({
|
||||
transform(chunk, controller) {
|
||||
// Example: Add timestamps to each chunk
|
||||
const timestamp = new Date().toISOString();
|
||||
controller.enqueue(`[${timestamp}] ${chunk}`);
|
||||
}
|
||||
});
|
||||
|
||||
```bash
|
||||
npm run test
|
||||
// Apply to streaming chat
|
||||
const inputStream = new ReadableStream({
|
||||
start(controller) {
|
||||
controller.enqueue(new TextEncoder().encode(JSON.stringify({
|
||||
role: 'user',
|
||||
content: 'Tell me a story'
|
||||
})));
|
||||
controller.close();
|
||||
}
|
||||
});
|
||||
|
||||
const responseStream = await smartAi.openaiProvider.chatStream(inputStream);
|
||||
const processedStream = responseStream.pipeThrough(customTransform);
|
||||
|
||||
// Read processed stream
|
||||
const reader = processedStream.getReader();
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
console.log(value);
|
||||
}
|
||||
```
|
||||
|
||||
Ensure your environment is configured with the appropriate tokens and settings for the providers you are testing.
|
||||
### Provider-Specific Features
|
||||
|
||||
### Building the Project
|
||||
Each provider may have unique capabilities. Here's how to leverage them:
|
||||
|
||||
Compile the TypeScript code and build the package using:
|
||||
```typescript
|
||||
// OpenAI - Use specific models
|
||||
const gpt4Response = await smartAi.openaiProvider.chat({
|
||||
systemMessage: 'You are a helpful assistant.',
|
||||
userMessage: 'Explain quantum computing',
|
||||
messageHistory: []
|
||||
});
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
// Anthropic - Use Claude's strength in analysis
|
||||
const codeReview = await smartAi.anthropicProvider.chat({
|
||||
systemMessage: 'You are a code reviewer.',
|
||||
userMessage: 'Review this code for security issues: ...',
|
||||
messageHistory: []
|
||||
});
|
||||
|
||||
// Perplexity - Best for research and current events
|
||||
const research = await smartAi.perplexityProvider.chat({
|
||||
systemMessage: 'You are a research assistant.',
|
||||
userMessage: 'What are the latest developments in renewable energy?',
|
||||
messageHistory: []
|
||||
});
|
||||
|
||||
// Groq - Optimized for speed
|
||||
const quickResponse = await smartAi.groqProvider.chat({
|
||||
systemMessage: 'You are a quick helper.',
|
||||
userMessage: 'Give me a one-line summary of photosynthesis',
|
||||
messageHistory: []
|
||||
});
|
||||
```
|
||||
|
||||
This command prepares the library for distribution.
|
||||
### Performance Optimization
|
||||
|
||||
## Contributing
|
||||
Tips for optimal performance:
|
||||
|
||||
Contributions are welcome! Please follow these steps:
|
||||
```typescript
|
||||
// 1. Reuse providers instead of creating new instances
|
||||
const smartAi = new SmartAi({ /* config */ });
|
||||
await smartAi.start(); // Initialize once
|
||||
|
||||
1. Fork the repository.
|
||||
2. Create a feature branch:
|
||||
```bash
|
||||
git checkout -b feature/my-feature
|
||||
```
|
||||
3. Commit your changes with clear messages:
|
||||
```bash
|
||||
git commit -m 'Add new feature'
|
||||
```
|
||||
4. Push your branch to your fork:
|
||||
```bash
|
||||
git push origin feature/my-feature
|
||||
```
|
||||
5. Open a Pull Request with a detailed description of your changes.
|
||||
// 2. Use streaming for long responses
|
||||
// Streaming reduces time-to-first-token and memory usage
|
||||
|
||||
// 3. Batch operations when possible
|
||||
const promises = [
|
||||
smartAi.openaiProvider.chat({ /* ... */ }),
|
||||
smartAi.anthropicProvider.chat({ /* ... */ })
|
||||
];
|
||||
const results = await Promise.all(promises);
|
||||
|
||||
// 4. Clean up resources
|
||||
await smartAi.stop(); // When done
|
||||
```
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
|
||||
28
test/test.ts
28
test/test.ts
@@ -1,4 +1,4 @@
|
||||
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as qenv from '@push.rocks/qenv';
|
||||
import * as smartrequest from '@push.rocks/smartrequest';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
@@ -21,8 +21,7 @@ tap.test('should create chat response with openai', async () => {
|
||||
const response = await testSmartai.openaiProvider.chat({
|
||||
systemMessage: 'Hello',
|
||||
userMessage: userMessage,
|
||||
messageHistory: [
|
||||
],
|
||||
messageHistory: [],
|
||||
});
|
||||
console.log(`userMessage: ${userMessage}`);
|
||||
console.log(response.message);
|
||||
@@ -55,7 +54,7 @@ tap.test('should recognize companies in a pdf', async () => {
|
||||
address: string;
|
||||
city: string;
|
||||
country: string;
|
||||
EU: boolean; // wether the entity is within EU
|
||||
EU: boolean; // whether the entity is within EU
|
||||
};
|
||||
entityReceiver: {
|
||||
type: 'official state entity' | 'company' | 'person';
|
||||
@@ -63,7 +62,7 @@ tap.test('should recognize companies in a pdf', async () => {
|
||||
address: string;
|
||||
city: string;
|
||||
country: string;
|
||||
EU: boolean; // wether the entity is within EU
|
||||
EU: boolean; // whether the entity is within EU
|
||||
};
|
||||
date: string; // the date of the document as YYYY-MM-DD
|
||||
title: string; // a short title, suitable for a filename
|
||||
@@ -75,7 +74,24 @@ tap.test('should recognize companies in a pdf', async () => {
|
||||
pdfDocuments: [pdfBuffer],
|
||||
});
|
||||
console.log(result);
|
||||
})
|
||||
});
|
||||
|
||||
tap.test('should create audio response with openai', async () => {
|
||||
// Call the audio method with a sample message.
|
||||
const audioStream = await testSmartai.openaiProvider.audio({
|
||||
message: 'This is a test of audio generation.',
|
||||
});
|
||||
// Read all chunks from the stream.
|
||||
const chunks: Uint8Array[] = [];
|
||||
for await (const chunk of audioStream) {
|
||||
chunks.push(chunk as Uint8Array);
|
||||
}
|
||||
const audioBuffer = Buffer.concat(chunks);
|
||||
await smartfile.fs.toFs(audioBuffer, './.nogit/testoutput.mp3');
|
||||
console.log(`Audio Buffer length: ${audioBuffer.length}`);
|
||||
// Assert that the resulting buffer is not empty.
|
||||
expect(audioBuffer.length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
tap.test('should stop the smartai instance', async () => {
|
||||
await testSmartai.stop();
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartai',
|
||||
version: '0.4.1',
|
||||
description: 'A TypeScript library for integrating and interacting with multiple AI models, offering capabilities for chat and potentially audio responses.'
|
||||
version: '0.5.4',
|
||||
description: 'SmartAi is a versatile TypeScript library designed to facilitate integration and interaction with various AI models, offering functionalities for chat, audio generation, document processing, and vision tasks.'
|
||||
}
|
||||
|
||||
@@ -75,21 +75,23 @@ export class OpenAiProvider extends MultiModalModel {
|
||||
// If we have a complete message, send it to OpenAI
|
||||
if (currentMessage) {
|
||||
const messageToSend = { role: "user" as const, content: currentMessage.content };
|
||||
const stream = await this.openAiApiClient.chat.completions.create({
|
||||
model: this.options.chatModel ?? 'o3-mini',
|
||||
temperature: 0,
|
||||
const chatModel = this.options.chatModel ?? 'o3-mini';
|
||||
const requestParams: any = {
|
||||
model: chatModel,
|
||||
messages: [messageToSend],
|
||||
stream: true,
|
||||
});
|
||||
|
||||
};
|
||||
// Temperature is omitted since the model does not support it.
|
||||
const stream = await this.openAiApiClient.chat.completions.create(requestParams);
|
||||
// Explicitly cast the stream as an async iterable to satisfy TypeScript.
|
||||
const streamAsyncIterable = stream as unknown as AsyncIterableIterator<any>;
|
||||
// Process each chunk from OpenAI
|
||||
for await (const chunk of stream) {
|
||||
for await (const chunk of streamAsyncIterable) {
|
||||
const content = chunk.choices[0]?.delta?.content;
|
||||
if (content) {
|
||||
controller.enqueue(content);
|
||||
}
|
||||
}
|
||||
|
||||
currentMessage = null;
|
||||
}
|
||||
},
|
||||
@@ -119,15 +121,17 @@ export class OpenAiProvider extends MultiModalModel {
|
||||
content: string;
|
||||
}[];
|
||||
}) {
|
||||
const result = await this.openAiApiClient.chat.completions.create({
|
||||
model: this.options.chatModel ?? 'o3-mini',
|
||||
temperature: 0,
|
||||
const chatModel = this.options.chatModel ?? 'o3-mini';
|
||||
const requestParams: any = {
|
||||
model: chatModel,
|
||||
messages: [
|
||||
{ role: 'system', content: optionsArg.systemMessage },
|
||||
...optionsArg.messageHistory,
|
||||
{ role: 'user', content: optionsArg.userMessage },
|
||||
],
|
||||
});
|
||||
};
|
||||
// Temperature parameter removed to avoid unsupported error.
|
||||
const result = await this.openAiApiClient.chat.completions.create(requestParams);
|
||||
return {
|
||||
role: result.choices[0].message.role as 'assistant',
|
||||
message: result.choices[0].message.content,
|
||||
@@ -137,7 +141,7 @@ export class OpenAiProvider extends MultiModalModel {
|
||||
public async audio(optionsArg: { message: string }): Promise<NodeJS.ReadableStream> {
|
||||
const done = plugins.smartpromise.defer<NodeJS.ReadableStream>();
|
||||
const result = await this.openAiApiClient.audio.speech.create({
|
||||
model: this.options.audioModel ?? 'o3-mini',
|
||||
model: this.options.audioModel ?? 'tts-1-hd',
|
||||
input: optionsArg.message,
|
||||
voice: 'nova',
|
||||
response_format: 'mp3',
|
||||
@@ -159,27 +163,30 @@ export class OpenAiProvider extends MultiModalModel {
|
||||
}) {
|
||||
let pdfDocumentImageBytesArray: Uint8Array[] = [];
|
||||
|
||||
// Convert each PDF into one or more image byte arrays.
|
||||
const smartpdfInstance = new plugins.smartpdf.SmartPdf();
|
||||
await smartpdfInstance.start();
|
||||
for (const pdfDocument of optionsArg.pdfDocuments) {
|
||||
const documentImageArray = await this.smartpdfInstance.convertPDFToPngBytes(pdfDocument);
|
||||
const documentImageArray = await smartpdfInstance.convertPDFToPngBytes(pdfDocument);
|
||||
pdfDocumentImageBytesArray = pdfDocumentImageBytesArray.concat(documentImageArray);
|
||||
}
|
||||
await smartpdfInstance.stop();
|
||||
|
||||
console.log(`image smartfile array`);
|
||||
console.log(pdfDocumentImageBytesArray.map((smartfile) => smartfile.length));
|
||||
|
||||
const smartfileArray = await plugins.smartarray.map(
|
||||
pdfDocumentImageBytesArray,
|
||||
async (pdfDocumentImageBytes) => {
|
||||
return plugins.smartfile.SmartFile.fromBuffer(
|
||||
'pdfDocumentImage.jpg',
|
||||
Buffer.from(pdfDocumentImageBytes)
|
||||
);
|
||||
}
|
||||
);
|
||||
// Filter out any empty buffers to avoid sending invalid image URLs.
|
||||
const validImageBytesArray = pdfDocumentImageBytesArray.filter(imageBytes => imageBytes && imageBytes.length > 0);
|
||||
const imageAttachments = validImageBytesArray.map(imageBytes => ({
|
||||
type: 'image_url',
|
||||
image_url: {
|
||||
url: 'data:image/png;base64,' + Buffer.from(imageBytes).toString('base64'),
|
||||
},
|
||||
}));
|
||||
|
||||
const result = await this.openAiApiClient.chat.completions.create({
|
||||
model: this.options.chatModel ?? 'o3-mini',
|
||||
temperature: 0,
|
||||
const chatModel = this.options.chatModel ?? 'o4-mini';
|
||||
const requestParams: any = {
|
||||
model: chatModel,
|
||||
messages: [
|
||||
{ role: 'system', content: optionsArg.systemMessage },
|
||||
...optionsArg.messageHistory,
|
||||
@@ -187,31 +194,22 @@ export class OpenAiProvider extends MultiModalModel {
|
||||
role: 'user',
|
||||
content: [
|
||||
{ type: 'text', text: optionsArg.userMessage },
|
||||
...(() => {
|
||||
const returnArray = [];
|
||||
for (const imageBytes of pdfDocumentImageBytesArray) {
|
||||
returnArray.push({
|
||||
type: 'image_url',
|
||||
image_url: {
|
||||
url: 'data:image/png;base64,' + Buffer.from(imageBytes).toString('base64'),
|
||||
},
|
||||
});
|
||||
}
|
||||
return returnArray;
|
||||
})(),
|
||||
...imageAttachments,
|
||||
],
|
||||
},
|
||||
],
|
||||
});
|
||||
};
|
||||
// Temperature parameter removed.
|
||||
const result = await this.openAiApiClient.chat.completions.create(requestParams);
|
||||
return {
|
||||
message: result.choices[0].message,
|
||||
};
|
||||
}
|
||||
|
||||
public async vision(optionsArg: { image: Buffer; prompt: string }): Promise<string> {
|
||||
const result = await this.openAiApiClient.chat.completions.create({
|
||||
model: this.options.visionModel ?? 'o3-mini',
|
||||
temperature: 0,
|
||||
const visionModel = this.options.visionModel ?? '04-mini';
|
||||
const requestParams: any = {
|
||||
model: visionModel,
|
||||
messages: [
|
||||
{
|
||||
role: 'user',
|
||||
@@ -227,8 +225,8 @@ export class OpenAiProvider extends MultiModalModel {
|
||||
}
|
||||
],
|
||||
max_tokens: 300
|
||||
});
|
||||
|
||||
};
|
||||
const result = await this.openAiApiClient.chat.completions.create(requestParams);
|
||||
return result.choices[0].message.content || '';
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user