Pipet Code Agent を使用して AI コード アシスタントを構築する

コードを書くのはやりがいも満足感もありますが、 仕事を同僚のためにプレゼンターに変えるのは、しばしば雑務です。人工 インテリジェンス生成モデルでは、コードコメントの追加、 人間が行う前に検出し、その他のさまざまなタスクを実行して、 コーディングワークフローが簡単になります

このチュートリアルでは、Google Cloud で Pipet Code Agent Google Cloud の AI デベロッパー リレーションズ チームが構築した AI 搭載のコード アシスタンス ツール Googleこのオープンソース プロジェクトは Microsoft Visual Studio の拡張機能です。 Code(VS Code)です。 コーディングの重要ではあるものの楽さは低いタスク(コメント、 間違いの発見、改善の提案といったタスクが含まれます。この拡張機能は コーディング支援リクエストを Gemini API に送信し、その応答を コード編集ウィンドウを開きます

Pipet は 新しいコマンドを作成して 開発ワークフローのサポートを強化できます

プロジェクトの概要と拡張方法(分析情報を含む)の動画 ご覧ください。 AI Code Assistant - Google AI でビルドする。 それ以外の場合は、手順に沿ってプロジェクトの拡張を開始できます。 ご覧ください

プロジェクトの設定

ここでは、Pippet Code Agent プロジェクトをセットアップする手順について説明します。 開発とテストに使用できます。一般的な手順では、いくつかの前提条件をインストールします。 環境変数の設定、コードからのプロジェクトのクローン作成、 構成のインストールを実行します。

前提条件をインストールする

Pipet Code Agent プロジェクトは、Microsoft Visual Studio の拡張機能として動作します。 コードであり、 Node.js と、管理用の npm ツール アプリケーションをパッケージ化して実行します。次のインストール手順は、 作成する必要があります。

必要なソフトウェアをインストールするには:

  1. Visual Studio Code をインストールする 検討してください
  2. インストールの手順に沿って、nodenpm をインストールします。 手順をご覧ください。

プロジェクトのクローンを作成して構成する

プロジェクト コードをダウンロードし、npm インストール コマンドを使用してダウンロードします。 プロジェクトを構成します。必要な 取得する git ソース管理システム ソースコードを変更せずに済みます

プロジェクト コードをダウンロードして構成するには:

  1. 次のコマンドを使用して Git リポジトリのクローンを作成します。
    git clone https://github.com/google/generative-ai-docs
    
  2. 必要に応じて、スパース チェックアウトを使用するようにローカルの Git リポジトリを構成します。 ドキュメント エージェント プロジェクトのファイルのみが含まれることになります。
    cd generative-ai-docs/
    git sparse-checkout init --cone
    git sparse-checkout set examples/gemini/node/pipet-code-agent/
    
  3. Pipet Code Agent プロジェクトのルート ディレクトリに移動します。
    cd generative-ai-docs/examples/gemini/node/pipet-code-agent/
    
  4. インストール コマンドを実行して依存関係をダウンロードし、プロジェクトを構成します。
    npm install
    

拡張機能を構成してテストする

Pipet Code Agent を VS Code の開発拡張機能を使用できます。テストでは、VM ごとに個別の 新しい拡張機能を利用できる Code Extension Development Host ウィンドウ。 この新しいウィンドウで、拡張機能がアクセスに使用する API キーを設定します。 Google Gemini API。

Extension Development Host ウィンドウで実行されている Pipet Code エージェント 図 1. Pipet が表示されている VS Code Extension Development Host ウィンドウ 使用できます。

設定を構成してテストするには:

  1. VS Code アプリケーションを起動します。
  2. VS Code で、[File] >新しいウィンドウ
  3. [File >フォルダを開く pipet-code-agent/ フォルダを選択します。
  4. pipet-code-agent/package.json ファイルを開きます。
  5. [Run] >デバッグを開始するをご覧ください。 この手順では、別の VS Code の [Extension Development Host] ウィンドウを開きます。
  6. [Code] >設定 >設定
  7. Google Gemini API キーを キー文字列をコピーします。
  8. API キーを構成設定として指定します。[検索の設定] フィールドに「pipet」と入力し、[User] タブを選択して、[Google >Gemini: [API キー] 設定を開き、[settings.json で編集] リンクをクリックし、 Gemini API キー:
    "google.gemini.apiKey": "your-api-key-here"
    
  9. settings.json ファイルに変更を保存し、設定タブを閉じます。
で確認できます。

拡張機能コマンドをテストするには:

  1. VS Code の [Extension Development Host] ウィンドウで、任意のコードを選択します。 をクリックします。
  2. [表示 >コマンド パレット
  3. コマンド パレットで「Pipet」と入力し、 使用します。

既存のコマンドを変更する

Pipet Code Agent で提供されているコマンドを変更することは、 拡張機能の動作と機能を変更します。コメントと コマンドの確認には、 少数ショット プロンプト そのコードのサンプルとコードのコメントに加え、いくつかの 一般的な手順を説明しました。このプロンプト コンテキスト Gemini 生成モデルが回答を生成する際の指針となります。方法 コメントまたはプロンプトでプロンプトの指示、例、またはその両方を 既存の各コマンドの動作を変更できます。

ここでは、review.ts コマンドを変更する方法について説明します。 コマンドのプロンプト テキストを変更します。

review.ts コマンドの編集を準備するには:

  1. VS Code アプリケーションを起動します。
  2. VS Code で、[File] >新しいウィンドウ
  3. [File >フォルダを開く pipet-code-agent/ フォルダを選択します。
  4. pipet-code-agent/src/review.ts ファイルを開きます。

review.ts コマンドの動作を変更するには:

  1. review.ts ファイルで、PROMPT の先頭を変更します。 異なる命令に定数を与えます。
    const PROMPT = '
    Write review comments for following code, identifying bugs and ways to improve code quality. Examples of bugs are syntax errors or typos, out of memory errors, and boundary value errors. Examples of improving code quality are reducing complexity of code, eliminating duplicate code, and ensuring other developers
    are able to understand the code.
    ${CODE_LABEL}
    ...
  2. 必要に応じて、review.ts ファイルで、別の例を コードレビューの例を紹介します。
    ...
    ${REVIEW_LABEL}
    There are duplicate lines of code in this control structure.
    ${CODE_LABEL}
    const fixed_value = 128;
    ${REVIEW_LABEL}
    Make sure constant names are in all capitals (FIXED_VALUE) for clarity.
    ';
  3. 変更を review.ts ファイルに保存します。

変更したコマンドをテストするには:

  1. VS Code Pipet 拡張機能のプロジェクト ウィンドウで、次のコマンドを実行してデバッガを再起動します。 [Run >デバッグを再開する
  2. VS Code の [Extension Development Host] ウィンドウで、任意のコードを選択します。 をクリックします。
  3. [表示 >コマンド パレット
  4. コマンド パレットで「Pipet」と入力し、[Pipet: を選択します。

新しいコマンドを作成

まったく新しいタスクを実行する新しいコマンドを作成して、Pippet を拡張できます 生成 AI です各コマンド ファイル(comment.tsreview.ts)のほとんどは、 自己完結型であり、アクティブなエディタからテキストを収集するためのコードが含まれています。 プロンプトの作成、Gemini API への接続、プロンプトの送信、処理の 返されます。

[Name the Selection] 関数が表示されている Pipet Code Agent 図 2. VS Code 拡張機能の新しい関数名推奨コマンド [Development Host] ウィンドウ

この手順では、次のコードを使用して新しいコマンドを作成する方法を説明します。 既存のコマンド comment.ts をテンプレートとして作成する。

関数名を推奨するコマンドを作成するには:

  1. pipet-code-agent/src/comment.ts ファイルのコピーを作成します。 (src/ ディレクトリにある name.ts)というファイルです。
  2. VS Code で src/name.ts ファイルを開きます。
  3. name.ts ファイルのプロンプトの手順を次のように変更します。 PROMPT 値を編集します。
    // Provide instructions for the AI generative model
    const PROMPT = `Recommend a name for this function. Explain your
    reasoning in 3 sentences or less:`;
    
  4. コマンド関数の名前と情報メッセージを変更します。
    export async function generateName() {
      vscode.window.showInformationMessage('Generating function name...');
    
  5. PROMPT のみを含めるようにプロンプト アセンブリ コードを更新します。 値とエディタで選択されたテキストが表示されます。
      // Build the full prompt using the template.
      const fullPrompt = `${PROMPT}
    "
    ${selectedCode}
    "
    `;
  6. レスポンス出力を変更して、何が生成されているかを説明します。
        // update prefix to describe output
        let commentIntro = padding + commentPrefix + "Recommended name: (generated)\n";
        editBuilder.insert(selection.start, commentIntro);
        editBuilder.insert(selection.start, pyComment);
    
  7. 変更を review.ts ファイルに保存します。

新しいコマンドを統合する

新しいコマンドのコードが完成したら、コードを できます。extension.ts ファイルと package.json ファイルを次のように更新します。 新しいコマンドを拡張機能の一部にして、VS Code で 使用します。

name コマンドを拡張機能コードと統合するには:

  1. VS Code で pipet-code-agent/src/extension.ts ファイルを開きます。
  2. 新しいインポートを追加して、新しいコードファイルを拡張機能に追加する ステートメントです。
    import { generateName } from './name';
    
  3. 次のコードを activate() 関数を使用します。
    export function activate(context: vscode.ExtensionContext) {
        ...
        vscode.commands.registerCommand('pipet-code-agent.nameFunction', generateName);
    }
  4. 変更を extension.ts ファイルに保存します。

name コマンドを拡張機能パッケージと統合するには:

  1. VS Code で pipet-code-agent/package.json ファイルを開きます。
  2. パッケージの commands セクションに新しいコマンドを追加します。 表示されます。
      "contributes": {
        "commands": [
          ...
          {
            "command": "pipet-code-agent.nameFunction",
            "title": "Pipet: Name the selected function."
          }
        ],
    
  3. 変更を package.json ファイルに保存します。

新しいコマンドをテストする

コマンドのコーディングと テストできます。新しいコマンドは VS Code でのみ使用できます。 [Extension Development Host] ウィンドウに表示できます。 拡張機能のコードを編集しました。

変更したコマンドをテストするには:

  1. VS Code Pipet 拡張機能のプロジェクト ウィンドウで、次のコマンドを実行してデバッガを再起動します。 [Run >[Restart Debugging] を使用します。 Extension Development Host ウィンドウ。
  2. VS Code の [Extension Development Host] ウィンドウで、コードを選択します。 をクリックします。
  3. [表示 >コマンド パレット
  4. コマンド パレットで「Pipet」と入力し、[Pipet: Name the 関数を選択します。

参考情報

Pipet Code Agent プロジェクトについて詳しくは、 コード リポジトリ。 アプリケーションの構築についてサポートが必要な場合や、開発者をお探しの場合 詳しくは、 Google Developers コミュニティの Discord あります。

本番環境のアプリケーション

多数のユーザー向けにドキュメント エージェントをデプロイする予定の場合は、 Google Gemini API は、レート制限やその他の 使用制限。 Gemini API を使用した本番環境アプリケーションの構築を ドキュメント エージェントの Google Cloud Vertex AI アプリケーションのスケーラビリティと信頼性を向上させる。