Vectorize

🚀 Vectorize を VS Code での設定と使用ガイド

Vectorize を VS Code で使用するための設定方法や使用方法、開発と公開に関する手順を説明します。

📦 インストール

ワンクリックインストールボタンを使用する

このセクションの上部にある「ワンクリックインストール」ボタンをクリックすると、すぐにインストールを完了できます。

手動インストール

以下の 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 の事前環境がインストールされていることを確認してください。
• 設定ファイルのプレースホルダーを実際の値に置き換えてください。
• 詳細なログやエラー情報については、公式ドキュメントを参照してください。