MIT License

项目介绍

vercel-labs/vectr 是一个托管在 GitHub 上的开源项目,主要使用 TypeScript 编写,采用 MIT License 许可证,目前获得 101 个 Star、18 次 Fork。

仓库全名
vercel-labs/vectr
开源许可证
MIT License
Star 数
101
Fork 数
18
未关闭 Issue
4

README 摘要

Vectr Vectr is an AI-powered image search application template that automatically generates descriptions for uploaded images and indexes them for semantic search. ✨ Features 📤 Drag-and-drop image uploads with Vercel Blob Storage 🤖 AI-powered image descriptions using Grok 2 Vision 🔍 Semantic search with Upstash Vector Search (stores metadata too!) 🔄 Resilient processing with Vercel Workflow automatic retries 🎨…

完整内容见 GitHub 原始 README 或本页 。

常见问题

vectr 用什么语言开发?

主要使用 TypeScript 编写,采用 MIT License 许可证,目前有 101 个 Star。

vectr 可以免费商用吗?

仓库采用 MIT License 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 vectr 的源码?

可以直接克隆仓库:git clone https://github.com/vercel-labs/vectr.git;安装与运行步骤见仓库 README。

vectr 最近还在维护吗?

仓库最近一次更新为 2月21日,当前有 4 个未关闭 Issue;Star 数为 101,可作为社区活跃度的参考。

关于

A free, open-source template for building natural language image search on the AI Cloud.

描述取自 GitHub 官方 API,中文内容由 GitRead 中文社区 编辑团队整理。

简要分析

热度分
238
价值分
75
活跃状态
活跃

README

Vectr

Vectr is an AI-powered image search application template that automatically generates descriptions for uploaded images and indexes them for semantic search.

✨ Features

  • 📤 Drag-and-drop image uploads with Vercel Blob Storage
  • 🤖 AI-powered image descriptions using Grok 2 Vision
  • 🔍 Semantic search with Upstash Vector Search (stores metadata too!)
  • 🔄 Resilient processing with Vercel Workflow automatic retries
  • 🎨 Beautiful UI built with shadcn/ui and Tailwind CSS
  • 💰 Incredibly cheap - No database needed!

🚀 How It Works

When you upload an image, Vectr automatically:

  1. 💾 Stores the image in Vercel Blob Storage
  2. 🧠 Generates a detailed description using Grok 2 Vision AI
  3. 🔎 Indexes the description AND metadata in Upstash for semantic search
sequenceDiagram participant User participant App as Next.js App participant Workflow as Vercel Workflow participant Blob as Vercel Blob participant AI as Grok Vision AI participant Search as Upstash Search User->>App: Upload Image (FormData) App->>Workflow: POST /api/upload Note over Workflow: Start Workflow Workflow->>Blob: Upload to Storage (Step 1) Note over Blob: Max 3 retries<br/>Rate limit handling Blob-->>Workflow: Blob URL + Metadata Workflow->>AI: Generate Description (Step 2) Note over AI: Max 5 retries<br/>Rate limit handling AI-->>Workflow: Image Description Workflow->>Search: Index with Metadata (Step 3) Note over Search: Max 5 retries<br/>Stores description + blob metadata Search-->>Workflow: Success Workflow-->>App: 200 OK User->>App: Search Images App->>Search: Semantic Query Search-->>App: Results with Metadata App-->>User: Display Results

🏗️ Architecture

Workflow Steps

Each step in the image processing workflow is isolated and runs on a separate serverless function with automatic retries:

Step 1: Upload Image (upload-image.ts)

  • 💾 Uploads to Vercel Blob Storage
  • ⏱️ Handles rate limiting with 1-minute retry delays
  • 🔄 Maximum 3 retry attempts
  • ❌ Fatal error on quota exceeded or invalid files

Step 2: Generate Description (generate-description.ts)

  • 🤖 Uses Grok 2 Vision AI to analyze the image
  • ⏱️ Handles rate limiting with 5-minute retry delays
  • 🔄 Maximum 5 retry attempts
  • ❌ Fatal error on invalid/unsupported images

Step 3: Index Image (index-image.ts)

  • 🔎 Indexes description AND blob metadata in Upstash
  • 💾 Stores all image data (url, size, contentType, etc.) as metadata
  • ⏱️ Handles rate limiting with 1-minute retry delays
  • 🔄 Maximum 5 retry attempts
  • ❌ Fatal error on invalid data

Error Handling

Vectr uses sophisticated error handling to ensure reliable processing:

  • 🔄 RetryableError: Temporary failures (rate limits, network issues, timeouts)
  • ❌ FatalError: Permanent failures (invalid data, constraint violations)
  • 📊 Context-aware retries: Each step tracks attempt count and timestamps
  • 🎯 Smart HTTP responses: 400 for fatal errors, 500 for retryable errors

🛠️ Tech Stack

  • ⚡ Framework: Next.js 15 with App Router and React 19
  • 🔄 Workflow: Vercel Workflow (alpha)
  • 🤖 AI: Grok 2 Vision via Vercel AI SDK
  • 🔍 Search & Storage: Upstash Vector Search (stores metadata too!)
  • 💾 Blob Storage: Vercel Blob Storage
  • 🎨 UI: shadcn/ui + Tailwind CSS 4
  • 🔒 Type Safety: TypeScript + Zod

🚀 Deploy to Vercel

The easiest way to deploy Vectr is using the Vercel Marketplace:

Deploy with Vercel

During deployment, you’ll be prompted to set up:

  1. 🔍 Upstash Vector Search - Semantic search + metadata storage
  2. 💾 Vercel Blob Storage - Image storage

Both services have generous free tiers and will be automatically configured. No database needed!

💻 Local Development

Prerequisites

  • 🟢 Node.js 18+
  • 📦 pnpm (recommended)

Setup

  1. Clone the repository:
git clone https://github.com/your-username/vectr.git
cd vectr
  1. Install dependencies:
pnpm install
  1. Set up environment variables:

Create a .env.local file with:

# Upstash Search
UPSTASH_SEARCH_URL="https://..."
UPSTASH_SEARCH_TOKEN="..."

# Vercel Blob (OIDC) — provided by `vercel env pull`
VERCEL_OIDC_TOKEN="..."   # short-lived, auto-rotated
BLOB_STORE_ID="..."

# AI Gateway Key (only needed locally)
AI_GATEWAY_API_KEY="..."
  1. Run the development server:
pnpm dev

Open http://localhost:3000 to see your app.

📜 Scripts

  • 🚀 pnpm dev - Start development server with Turbopack
  • 🏗️ pnpm build - Build for production
  • ✅ pnpm check - Run linting checks
  • ✨ pnpm format - Format code with Biome

📁 Project Structure

vectr/
├── app/
│   ├── actions/
│   │   └── search.ts                 # Server action for search
│   ├── api/
│   │   └── upload/
│   │       ├── route.ts              # Workflow route handler
│   │       ├── upload-image.ts       # Step 1: Upload to Blob
│   │       ├── generate-description.ts  # Step 2: AI description
│   │       └── index-image.ts        # Step 3: Index with metadata
│   ├── layout.tsx
│   └── page.tsx
├── components/
│   ├── header.tsx
│   ├── results.tsx
│   ├── upload-button.tsx
│   └── uploaded-images-provider.tsx
├── lib/
│   └── utils.ts
└── package.json

🔐 Environment Variables

Variable Description Required
UPSTASH_SEARCH_URL Upstash Vector Search endpoint Yes
UPSTASH_SEARCH_TOKEN Upstash authentication token Yes
VERCEL_OIDC_TOKEN Short-lived OIDC token for Vercel Blob (auto-injected on Vercel, vercel env pull locally) Yes
BLOB_STORE_ID Vercel Blob store id, paired with OIDC (auto-injected when a store is connected) Yes
XAI_API_KEY xAI API key for Grok Vision Yes

📊 Observability

Vectr includes comprehensive logging for monitoring and debugging:

  • 🔄 [WORKFLOW] - Workflow-level events and timing
  • 🔧 [stepId] - Step-level events with unique identifiers
  • 🌐 [API] - HTTP request/response logging

All logs include timestamps, attempt counts, and duration metrics.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. Our Contributing Guide has more information on how to get started.

📄 License

MIT

评论

暂无评论