Vectorize

🚀 Vectorize 在 VS Code 中的配置與使用指南

本指南將詳細介紹如何在 VS Code 中配置和使用 Vectorize，幫助你快速上手並高效使用該工具。

🚀 快速開始

✨ 主要特性

• 支持一鍵安裝和手動安裝兩種方式，方便不同需求的用戶。
• 可在多個平臺（Claude/Windsurf/Cursor/Cline）上進行配置。
• 提供多種工具功能，如文檔檢索、多語言處理和文檔處理等。

📦 安裝指南

使用一鍵安裝按鈕

在本節頂部有一對“一鍵安裝”按鈕，點擊即可快速完成安裝。

手動安裝

將以下 JSON 代碼添加到 VS Code 的用戶設置（JSON）文件中。可以通過按 Ctrl + Shift + P 並輸入“首選項：打開用戶設置 (JSON)”來實現。

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "org_id",
        "description": "Vectorize 組織 ID"
      },
      {
        "type": "promptString",
        "id": "token",
        "description": "Vectorize Token",
        "password": true
      },
      {
        "type": "promptString",
        "id": "pipeline_id",
        "description": "Vectorize 管道 ID"
      }
    ],
    "servers": {
      "vectorize": {
        "command": "npx",
        "args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
        "env": {
          "VECTORIZE_ORG_ID": "${input:org_id}",
          "VECTORIZE_TOKEN": "${input:token}",
          "VECTORIZE_PIPELINE_ID": "${input:pipeline_id}"
        }
      }
    }
  }
}

工作區配置（可選）

在工作區中創建一個名為 .vscode/mcp.json 的文件，與其他用戶共享配置：

{
  "inputs": [
    {
      "type": "promptString",
      "id": "org_id",
      "description": "Vectorize 組織 ID"
    },
    {
      "type": "promptString",
      "id": "token",
      "description": "Vectorize Token",
      "password": true
    },
    {
      "type": "promptString",
      "id": "pipeline_id",
      "description": "Vectorize 管道 ID"
    }
  ],
  "servers": {
    "vectorize": {
      "command": "npx",
      "args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
      "env": {
        "VECTORIZE_ORG_ID": "${input:org_id}",
        "VECTORIZE_TOKEN": "${input:token}",
        "VECTORIZE_PIPELINE_ID": "${input:pipeline_id}"
      }
    }
  }
}

📚 詳細文檔

配置說明

在 Claude/Windsurf/Cursor/Cline 上配置：

{
  "mcpServers": {
    "vectorize": {
      "command": "npx",
      "args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
      "env": {
        "VECTORIZE_ORG_ID": "your-org-id",
        "VECTORIZE_TOKEN": "your-token",
        "VECTORIZE_PIPELINE_ID": "your-pipeline-id"
      }
    }
  }
}

💻 使用示例

基礎用法

檢索文檔

執行向量搜索並檢索文檔（參考官方 API）：

{
  "name": "retrieve",
  "arguments": {
    "question": "公司的財務狀況",
    "k": 5
  }
}

高級用法

多語言處理

使用以下命令進行多語言文本處理（參考官方 API）：

npx vectorize translate --source-lang zh --target-lang en "你好，世界！"
# 輸出：Hello, world!

npx vectorize detect-language "Bonjour, le monde!"
# 輸出：法語

npx vectorize sentence-similarity \
    --text1 "我今天天氣不錯。" \
    --text2 "今天陽光明媚。"
# 輸出：相似度分數

文檔處理工具

使用以下命令對文檔進行處理（參考官方 API）：

npx vectorize split-document --input-file ./example.pdf
# 將 PDF 文件分割成多個文本塊

npx vectorize extract-entities --text "在 2023 年的全球峰會上，來自 50 多個國家的領導人齊聚一堂。"
# 提取實體信息：地點、人名、組織等

🔧 技術細節

開發與發佈

安裝依賴

運行以下命令安裝開發所需的依賴項：

npm install @vectorize/core @vectorize/mcp-server

運行示例

在項目根目錄下創建一個 package.json 文件，內容如下：

{
  "name": "vectorize-app",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js"
  }
}

然後運行以下命令啟動應用：

npm run start

發佈版本

按照以下步驟進行發佈：

1. 更新 package.json 中的版本號
2. 打包構建：

   npm pack
   

3. 發佈到指定倉庫或分發平臺

📄 許可證

文檔未提及許可證相關信息，暫不展示。

其他注意事項

⚠️ 重要提示

• 確保安裝 Node.js 和 npm 前置環境
• 配置文件中的佔位符需要替換為實際值
• 詳細日誌和錯誤信息請參考官方文檔