smart_prompt 0.5.0 → 0.5.1

data/docs/VIDEO_GENERATION_README.md

@@ -0,0 +1,246 @@
+# SmartPrompt Video Generation Guide
+
+This guide explains how to use the new Video Generation capabilities in SmartPrompt.
+
+## Overview
+
+The Video Generation feature adds support for:
+- **Text-to-Video Generation**: Generate videos from text prompts
+- **Image-to-Video Generation**: Create videos from existing images
+- **Asynchronous Processing**: Handle long-running video generation jobs
+- **Status Monitoring**: Check progress and download completed videos
+
+## Installation
+
+Make sure you have the required dependencies:
+
+```bash
+gem install openai
+```
+
+## Configuration
+
+Add the Video Generation adapter to your configuration:
+
+```yaml
+# config.yml
+adapters:
+  multimodal: "MultimodalAdapter"
+  image_generation: "ImageGenerationAdapter"
+  video_generation: "VideoGenerationAdapter"
+
+llms:
+  video_gen:
+    adapter: "video_generation"
+    url: "https://api.siliconflow.cn/v1/"
+    api_key: "ENV[SILICONFLOW_API_KEY]"
+    model: "Wan-AI/Wan2.2-T2V-A14B"
+
+default_llm: "video_gen"
+template_path: "./templates"
+worker_path: "./workers"
+logger_file: "./logs/smart_prompt.log"
+```
+
+## Available Workers
+
+### 1. Video Generator Worker
+Generate videos from text prompts.
+
+```ruby
+result = engine.call_worker(:video_generator, {
+  prompt: "A beautiful sunset over ocean waves",
+  duration: 4,                    # Optional: Video duration in seconds (1-10)
+  resolution: "720p",            # Optional: "480p", "720p", "1080p"
+  fps: 24,                       # Optional: Frames per second
+  seed: 12345,                   # Optional: Random seed for reproducibility
+  wait_for_completion: false,    # Optional: Wait for job completion
+  download_to_file: false,       # Optional: Download video when completed
+  output_dir: "./videos",        # Optional: Output directory
+  filename_prefix: "video"       # Optional: Filename prefix
+})
+```
+
+### 2. Image-to-Video Generator Worker
+Create videos from existing images.
+
+```ruby
+result = engine.call_worker(:image_to_video_generator, {
+  image_file: "./input.jpg",
+  prompt: "Make the image come to life with animation",
+  duration: 4,
+  resolution: "720p",
+  wait_for_completion: false,
+  download_to_file: true
+})
+```
+
+### 3. Video Status Checker Worker
+Check the status of a video generation job.
+
+```ruby
+result = engine.call_worker(:video_status_checker, {
+  job_id: "job_123456789",
+  download_to_file: true,        # Optional: Download if completed
+  output_dir: "./videos",
+  filename_prefix: "completed_video"
+})
+```
+
+### 4. Creative Video Generator Worker
+Generate artistic videos with style control.
+
+```ruby
+result = engine.call_worker(:creative_video_generator, {
+  prompt: "A magical forest with glowing fairies",
+  video_style: "fantasy animation, Studio Ghibli style",
+  duration: 4,
+  resolution: "720p",
+  wait_for_completion: true,
+  download_to_file: true
+})
+```
+
+### 5. Product Video Generator Worker
+Generate professional product videos.
+
+```ruby
+result = engine.call_worker(:product_video_generator, {
+  prompt: "Modern smartphone rotating on marble surface",
+  duration: 4,
+  resolution: "720p",
+  wait_for_completion: true,
+  download_to_file: true
+})
+```
+
+### 6. Batch Video Generator Worker
+Generate multiple videos from multiple prompts.
+
+```ruby
+result = engine.call_worker(:batch_video_generator, {
+  prompts: [
+    "A cat playing with yarn",
+    "A dog running in a field",
+    "A bird flying in the sky"
+  ],
+  duration: 3,
+  resolution: "720p",
+  wait_for_completion: false
+})
+```
+
+## Direct Adapter Usage
+
+You can also use the adapter directly without workers:
+
+```ruby
+# Get the adapter
+adapter = engine.llms["video_gen"]
+
+# Generate video
+video_data = adapter.generate_video(
+  "A butterfly flying through a garden",
+  duration: 4,
+  resolution: "720p",
+  fps: 24
+)
+
+# Check status
+status = adapter.check_video_status(video_data[:job_id])
+
+# Wait for completion
+completed_video = adapter.wait_for_video_completion(
+  video_data[:job_id],
+  check_interval: 10,    # Check every 10 seconds
+  timeout: 600           # Timeout after 10 minutes
+)
+
+# Download video
+if completed_video[:video_url]
+  downloaded_file = adapter.download_video(
+    completed_video[:video_url],
+    "./videos/my_video.mp4"
+  )
+end
+```
+
+## Response Format
+
+Video generation responses return video data objects:
+
+```ruby
+{
+  job_id: "job_123456789",       # Unique job identifier
+  status: "processing",          # "queued", "processing", "completed", "failed"
+  video_url: "https://...",      # Video URL when completed
+  progress: 50,                  # Progress percentage
+  created_at: "2024-01-01...",   # Job creation timestamp
+  updated_at: "2024-01-01..."    # Last update timestamp
+}
+```
+
+## Supported Models
+
+SiliconFlow supports various video generation models:
+- `Wan-AI/Wan2.2-T2V-A14B` - Text-to-video generation
+- `Wan-AI/Wan2.2-I2V-A14B` - Image-to-video generation
+
+## Video Specifications
+
+- **Duration**: 1-10 seconds
+- **Resolution**: 480p, 720p, 1080p
+- **FPS**: 24, 30, 60 frames per second
+- **Format**: MP4
+
+## Asynchronous Processing
+
+Video generation is an asynchronous process:
+
+1. **Submit Job**: Returns immediately with job ID
+2. **Check Status**: Monitor progress periodically
+3. **Wait for Completion**: Optionally wait for job to finish
+4. **Download Result**: Download video when completed
+
+## Error Handling
+
+```ruby
+begin
+  result = engine.call_worker(:video_generator, params)
+rescue SmartPrompt::LLMAPIError => e
+  puts "API Error: #{e.message}"
+rescue SmartPrompt::Error => e
+  puts "General Error: #{e.message}"
+rescue => e
+  puts "Unexpected Error: #{e.message}"
+end
+```
+
+## Best Practices
+
+1. **Prompt Engineering**: Use detailed, time-sequential descriptions
+2. **Video Length**: Keep videos under 10 seconds for best results
+3. **Resolution**: Use 720p for good quality and reasonable processing time
+4. **Batch Processing**: Use batch generation for multiple videos
+5. **Status Monitoring**: Check status periodically for long-running jobs
+6. **Error Recovery**: Implement retry logic for failed jobs
+
+## Example
+
+See `examples/video_generation_example.rb` for complete working examples.
+
+## Troubleshooting
+
+**Common Issues:**
+- **API Key Error**: Ensure `SILICONFLOW_API_KEY` environment variable is set
+- **Model Not Found**: Check that the specified model is available on SiliconFlow
+- **Timeout Errors**: Video generation can take several minutes
+- **Network Issues**: Check internet connectivity and API endpoint availability
+- **File Permissions**: Ensure write permissions for output directories
+
+**Job Status Meanings:**
+- `queued`: Job is waiting to be processed
+- `processing`: Job is currently being processed
+- `completed`: Job finished successfully, video is available
+- `failed`: Job failed, check error message
+- `cancelled`: Job was cancelled by user or system

data/docs/delete_files_list.md

@@ -0,0 +1,124 @@
+# 待删除文件列表
+
+## 高优先级删除（安全且推荐）
+
+### 构建产物
+```bash
+smart_prompt-0.3.4.gem
+```
+
+### 生成的媒体文件（占用空间较大）
+```bash
+generated_images/sunset_1.png
+art_images/fantasy_forest_1.png
+direct_images/cartoon_cat_1.png
+direct_images/cartoon_cat_2.png
+product_images/smartphone_1.png
+```
+
+### 日志文件
+```bash
+logs/smart_prompt.log
+```
+
+---
+
+## 中优先级删除（开发辅助文件）
+
+### 开发工具缓存和配置
+```bash
+.ruby-lsp/
+.claude/settings.local.json
+.vscode/launch.json
+.kiro/
+```
+
+### 重复的文档文件（主文档已涵盖相关内容）
+```bash
+ANTHROPIC_EXAMPLES.md
+IMAGE_GENERATION_README.md
+TTS_README.md
+STT_README.md
+VIDEO_GENERATION_README.md
+MULTIMODAL_README.md
+QUICK_START_ANTHROPIC.md
+HISTORY_MIGRATION_GUIDE.md
+```
+
+### 实现总结文档
+```bash
+examples/IMPLEMENTATION_SUMMARY.md
+```
+
+---
+
+## 低优先级删除（示例和工作进程文件）
+
+### 非核心示例文件（examples目录）
+```bash
+examples/anthropic_vision_example.rb
+examples/anthropic_example.rb
+examples/anthropic_tools_example.rb
+examples/automatic_cleanup_example.rb
+examples/chat_example.rb
+examples/examples.rb
+examples/fast_example.rb
+examples/inner_thoughts_example.rb
+examples/logging_example.rb
+examples/message_example.rb
+examples/monitoring_example.rb
+examples/multimodal_example.rb
+examples/structured_data_example.rb
+```
+
+### 非核心工作进程文件（workers目录）
+```bash
+workers/image_generation_workers.rb
+workers/multimodal_workers.rb
+workers/stt_workers.rb
+workers/tts_workers.rb
+workers/video_generation_workers.rb
+```
+
+---
+
+## 其他可考虑删除的文档（可选）
+
+### 实施细节文档（如果不再需要）
+```bash
+HISTORY_MANAGEMENT_GUIDE.md
+MONITORING_GUIDE.md
+RELEVANCE_BASED_STRATEGY_IMPLEMENTATION.md
+```
+
+---
+
+## 总计
+
+- **文件数量**: 41个文件/目录
+- **预计释放空间**: 3.5MB - 4.5MB（主要为媒体文件和日志）
+
+---
+
+## 删除方法
+
+可以使用以下命令批量删除：
+
+```bash
+# 删除生成的媒体文件和构建产物
+rm -f smart_prompt-0.3.4.gem generated_images/sunset_1.png art_images/fantasy_forest_1.png direct_images/cartoon_cat_*.png product_images/smartphone_1.png logs/smart_prompt.log
+
+# 删除示例文件（如果需要）
+rm -f examples/*_example.rb examples/example.rb examples/examples.rb
+
+# 删除工作进程文件（如果需要）
+rm -f workers/*_workers.rb
+
+# 删除docs文件（如果需要）
+rm -f IMAGE_GENERATION_README.md TTS_README.md STT_README.md VIDEO_GENERATION_README.md MULTIMODAL_README.md ANTHROPIC_EXAMPLES.md QUICK_START_ANTHROPIC.md HISTORY_MIGRATION_GUIDE.md examples/IMPLEMENTATION_SUMMARY.md
+
+# 删除开发工具配置文件（如果需要）
+rm -rf .ruby-lsp/ .claude/ .vscode/ .kiro/
+```
+
+**注意**: 在删除任何文件之前，建议先进行备份或确认这些文件确实不再需要。