Rahyana AI API - TypeScript Examples

🚀 Quick Start

# Install dependencies
npm install
# Run interactive examples
npm run dev
# Run specific example
npm run test:individual chat-completions/basic-chat.ts
# Build all examples
npm run build

✨ Key Features

🔒 Type Safety

🛠️ Modern Development

🎯 Production Ready

📚 Available Examples

1. Chat Completions (chat-completions/)

2. Real-world Projects (real-world-projects/)

3. AI-Powered Tools (ai-testing/, ai-monitoring/, etc.)

🛠️ TypeScript Configuration

tsconfig.json

{
 "compilerOptions": {
 "target": "ES2022",
 "module": "ESNext",
 "moduleResolution": "node",
 "strict": true,
 "noImplicitAny": true,
 "strictNullChecks": true,
 "exactOptionalPropertyTypes": true
 }
}

Package.json

{
 "type": "module",
 "scripts": {
 "build": "tsc",
 "dev": "tsx index.ts",
 "test": "tsx test-all-examples.ts"
 }
}

🎯 Usage Examples

Basic Chat Completions

import { createRahyanaClient } from './lib/rahyana-client.js';
import { ChatMessage } from './types/rahyana-api.js';
const client = createRahyanaClient({
 apiKey: 'YOUR_API_KEY',
 baseUrl: 'https://rahyana.ir/api/v1'
});
const messages: ChatMessage[] = [
 { role: 'user', content: 'Hello, TypeScript!' }
];
const response = await client.chatCompletions({
 model: 'openai/gpt-4o',
 messages,
 max_tokens: 100
});
console.log(response.choices[0].message.content);

Streaming Responses

for await (const chunk of client.streamChatCompletions({
 model: 'openai/gpt-4o',
 messages,
 max_tokens: 200
})) {
 if (chunk.choices[0]?.message?.content) {
 process.stdout.write(chunk.choices[0].message.content);
 }
}

AI Content Generator

import { AIContentGenerator } from './real-world-projects/ai-content-generator.js';
const generator = new AIContentGenerator({
 apiKey: 'YOUR_API_KEY',
 baseUrl: 'https://rahyana.ir/api/v1'
});
const blogPost = await generator.generateBlogPost(
 'TypeScript Best Practices',
 {
 language: 'en',
 tone: 'technical',
 seoOptimized: true
 }
);
console.log(blogPost.title);
console.log(blogPost.content);

🔧 Development

Prerequisites

Installation

# Clone the repository
git clone https://github.com/rahyana/examples.git
cd examples/typescript
# Install dependencies
npm install
# Set up environment
cp .env.example .env
# Edit .env with your API key

Running Examples

# Interactive mode
npm run dev
# Run specific example
npx tsx chat-completions/basic-chat.ts
# Run all examples
npm test
# Build for production
npm run build

📊 Type Definitions

Core Types

interface ChatMessage {
 role: 'system' | 'user' | 'assistant';
 content: string | ChatContent[];
}
interface ChatCompletionRequest {
 model: string;
 messages: ChatMessage[];
 max_tokens?: number;
 temperature?: number;
 stream?: boolean;
}
interface ChatCompletionResponse {
 id: string;
 choices: ChatChoice[];
 usage: Usage;
}

Client Configuration

interface ClientConfig {
 apiKey: string;
 baseUrl: string;
 timeout?: number;
 retries?: number;
 headers?: Record<string, string>;
}

🚀 Advanced Features

Error Handling

try {
 const response = await client.chatCompletions(request);
} catch (error) {
 if (error instanceof RahyanaError) {
 console.error('API Error:', error.message);
 } else {
 console.error('Network Error:', error);
 }
}

Retry Logic

const client = createRahyanaClient({
 apiKey: 'YOUR_API_KEY',
 baseUrl: 'https://rahyana.ir/api/v1',
 retries: 3,
 timeout: 30000
});

Custom Headers

const client = createRahyanaClient({
 apiKey: 'YOUR_API_KEY',
 baseUrl: 'https://rahyana.ir/api/v1',
 headers: {
 'X-Custom-Header': 'TypeScript-Client',
 'User-Agent': 'MyApp/1.0.0'
 }
});

🧪 Testing

Run Tests

# Run all tests
npm test
# Run specific test
npm run test:individual ai-testing/ai-test-generator.ts
# Run with coverage
npm run test:coverage

Test Structure

describe('Chat Completions', () => {
 it('should generate valid responses', async () => {
 const response = await client.chatCompletions({
 model: 'openai/gpt-4o',
 messages: [{ role: 'user', content: 'Hello' }],
 max_tokens: 10
 });
 
 expect(response.choices).toHaveLength(1);
 expect(response.choices[0].message.content).toBeDefined();
 });
});

📈 Performance

Benchmarks

Optimization Tips

// Use specific types instead of 'any'
const response: ChatCompletionResponse = await client.chatCompletions(request);
// Enable strict mode
// tsconfig.json: "strict": true
// Use const assertions
const config = {
 model: 'openai/gpt-4o',
 temperature: 0.7
} as const;

🔒 Security

Best Practices

Environment Setup

# .env
RAHYANA_API_KEY=your_api_key_here
RAHYANA_BASE_URL=https://rahyana.ir/api/v1

📚 Documentation

API Reference

Examples

🤝 Contributing

Code Style

📄 License

🆘 Support