Gemini Code Assist によるコード

このドキュメントでは、Google Cloud の AI を活用したコラボレーターである Gemini Code Assist の使用し、Cloud Shell で次のことを行う方法を説明します。

コードの問題を解決するためのガイダンスを提供する。
プロジェクトのコードを生成する。
コーディング時にインラインの候補を受け取る。

Gemini for Google Cloud がデータを使用する方法とタイミングについての説明をご確認ください。

コードに関するライセンス要件を遵守できるようにするために、Gemini Code Assist では、提案が特定のソースから詳細に直接引用を行っている場合、ソースの引用が提供されます。Gemini がソースを引用する方法とタイミングについて詳しくは、Gemini によるコードの生成とソースの引用方法をご覧ください。

このドキュメントは、全スキルレベルのデベロッパーを対象としています。Cloud Shell エディタに関する実践的な知識があり、Google Cloud の深い知識があることを前提としています。必要に応じて、Cloud Workstations、Cloud Code for IntelliJ、Cloud Code for VS Code で Gemini Code Assist を使用することもできます。

Google Cloud に接続してプロジェクトを選択する

このセクションでは、Google Cloud に接続し、Cloud Shell エディタで Cloud AI Companion API が有効になっている Google Cloud プロジェクトを選択します。

Cloud AI Companion API を有効にせずに Google Cloud プロジェクトを選択すると、IDE から API を有効にするオプションを提供する通知が送信されます。通知ウィンドウで [API を有効にする] を選択して、プロジェクトに対してこの API を有効にします。詳細については、プロジェクトに Gemini Code Assist を設定するをご覧ください。

Cloud Shell エディタで Google Cloud に接続するには、次の手順を実施します。

Cloud Shell エディタを起動する
以前のエディタを使用している場合は、[新しいエディタを試す] をクリックします。
ステータスバーで [Cloud Code] - [ログイン] をクリックします。
Cloud Shell エディタに Google Cloud API の呼び出しを認可するよう求められたら、[承認] をクリックします。
画面の指示に沿って Google アカウントにログインします。

これで Google Cloud に接続されました。

次に、Cloud AI Companion API が有効になっている Google Cloud プロジェクトを選択するには、次の手順に従います。

[Gemini コードアシスタンス] ステータスバーで [Gemini コードアシスタンス] をクリックします。
[Gemini コードアシスタンス] メニューで、[Select Gemini Code Assist project] を選択します。
Cloud AI Companion API が有効になっている Google Cloud プロジェクトを選択します。

Gemini を使用する準備ができました。

Gemini Code Assist とチャットする

このセクションでは、[Gemini コードアシスタンス] ペインを開き、Gemini コードアシスタンスとチャットして、既存のコードの説明を取得する方法について学習します。

Gemini とチャットを開始するには、次の手順を行います。

コードファイルを開きます。
Cloud Shell エディタのアクティビティバーで、spark [Gemini Code Assist] をクリックします。
[Gemini Code Assist] ペインで、プロンプト「Explain this code to me」を入力し、send [送信] をクリックします。

Gemini は、コードファイル内のコードをプロンプトへの参照として使用し、コードの説明を返します。

ファイル内のすべてのコードではなく、特定のコードブロックを参照するには、コードファイル内のブロックを選択して、Gemini に指示します。

チャット履歴をリセットする

Gemini コードアシスタンスは、プロンプトへの応答時に、追加のコンテキストとしてチャット履歴を使用します。

チャットの履歴と、実現しようとしていることとの関連性がなくなった場合は、チャット履歴をリセットできます（[Gemini コードアシスタンス] ペインでdelete [Chat のリセット] をクリックします）。

プロンプトを使用してコードを生成する

以下のセクションでは、Gemini Code Assist を使用して、コードファイル内のサンプルプロンプト Function to create a Cloud Storage bucket でコードを生成する方法について説明します。また、コーディング中には、コードの一部を選択して、チャット機能で Gemini Code Assist にサポートを求め、コードの候補から取捨選択することも可能です。

コードファイルで Gemini Code Assist をプロンプト表示する

コードファイルの新しい行でコメントを「Function to create a Cloud Storage bucket」と入力し、Enter（Windows および Linux の場合）または Return（macOS の場合）を押します。
コードを生成するには、Control+Enter（Windows および Linux）や Ctrl+Return（macOS の場合）を押します。

コードは、Gemini Code Assist がコードファイルのプロンプトテキストの横に、ゴーストテキスト形式で生成します。
省略可: 生成されたコードを受け入れるには、Tab を押します。

省略可: コードを生成するためのキーボードショートカットを変更します

前のセクションで説明したように、コードを生成するためのデフォルトのキーボードショートカットが動作しない場合は、次の手順でキーボードショートカットを変更できます。

Cloud Shell エディタで、[メニュー] [メニュー] をクリックし、[ファイル] > [設定] > [キーボードショートカット] に移動します。
キーボードショートカットのリストで、[Cloud Code: コードを生成] を検索します。
[Cloud Code: コードを生成] をクリックし、[編集] [キーバインドを変更] をクリックします。
表示されるダイアログで、独自のショートカットを入力します。
Enter（Windows および Linux の場合）または Return（macOS の場合）を押します。

新しく割り当てたキーボードショートカットを使用して、Gemini でコードを生成できるようになりました。

選択したコードを使用してチャットで Gemini Code Assist に指示する

Gemini Code Assist は、選択したコードに基づいてタスクを実行したり、質問に回答したりすることが可能です。選択したコードとプロンプトに基づいて生成されたコードを取得するには、次の手順を行います。

アクティビティバーで、spark [Gemini Code Assist] をクリックして [Gemini Code Assist] ペインを開きます。
コードファイルで、コードのブロックを選択します。
[Gemini Code Assist] ペインのテキストフィールドに、選択したコードに対するプロンプトを入力します。

たとえば、コード内の関数を選択し、プロンプト「Write a unit test for this function」を入力します。

Gemini は、選択したコードをリファレンスとして使用し、プロンプトに応答します。

コーディング中にインライン候補を表示する

Gemini Code Assist は、コードの記述時に、インラインコードの候補を作成します。ユーザーはこれを取捨選択できます。この機能を試すには、次の手順を行います。

コードファイルの新しい行で、関数の作成を開始します。たとえば、Python ファイルの場合は、「def」と記述します。

Gemini は、ゴーストテキスト形式でコードの候補を表示します。
Gemini Code Assist からのコード候補を受け入れるには、Tab を押します。それ以外で、提案を無視するには、Esc を押すか、引き続きコードを記述します。

省略可: インライン候補を無効にする

Gemini Code Assist でインライン候補を無効にするには、次の手順に従います。

Cloud Shell エディタで、メニュー [メニュー] を選択し、[ファイル] > [設定] > [設定] に移動します。
[設定] ダイアログの [ユーザー] タブで、[拡張機能] > [Cloud Code] に移動します。
[Cloudcode: Gemini Code Assist: Inline Suggestions: Enable Auto] リストが表示されるまでスクロールして、[Off] を選択します。

これで、インライン候補は無効になります。インライン候補は、Control+Enter（Windows および Linux の場合）や Ctrl+Return（macOS の場合）を押すことで、引き続き手動で起動できます。

引用されたソースに一致するコードの候補を無効にする

既存のオープンソースコードなど、別のソースから詳細に直接引用する際、Gemini が引用情報を提供します。詳細については、Gemini によるソースの引用方法とタイミングをご覧ください。

引用されたソースに一致するコードが提案されないようにするには、settings.json ファイルの cloudcode.duetAI.recitation.maxCitedLength 設定を 0 に変更します。

"cloudcode.duetAI.recitation.maxCitedLength": 0

スマートアクションを使用する

コンテキストの切り替えを最小限に抑えながら生産性を向上させるため、Gemini Code Assist では、AI を活用したスマートアクションをコードエディタに直接備えています。コードエディタでコードを選択すると、コンテキストに関連するアクションのリストを表示して選択できます。

コードでスマートアクションを使用するには、次の手順を行います。

コードファイルで、コードのブロックを選択します。
選択したコードブロックの横にある電球アイコン [コードアクションを表示] をクリックします。
[Generate unit tests] などのアクションを選択します。

Gemini は、選択したアクションに基づいて回答を生成します。

プレビュー：コード変換を使用する

Gemini Code Assist には、コード変換が用意されています。これにより、コードファイルの一部を選択し、インラインテキストボックスを使用して自然言語のプロンプトで既存のコードの変更をリクエストできます。

コード変換を使用すると、次のことができます。

コードを文書化するためのコメント行を生成する
問題のあるコードのトラブルシューティング
コードの可読性を高める
コードを効率化する

生成されたレスポンスのコンテキストソースは、[Gemini: チャット] ペインで表示することもできます。

インラインテキストボックスで Gemini Code Assist をプロンプト表示する

インラインテキストボックスでは、コードファイル内で Gemini Code Assist を直接操作できます。

インラインテキストボックスを開いて Gemini をプロンプト表示するには、次の手順に従います。

コードファイルで、Ctrl+I（Windows および Linux の場合）または Command+I（macOS の場合）を押します。
プロンプト（Write a function to create a Cloud Storage bucket など）を入力して、Enter （Windows と Linux の場合）または Return（macOS の場合）を押します。

Gemini Code Assist は、プロンプトに基づいてコードを生成します。

リファクタリングされたコードの差分を表示する

インラインテキストボックスに組み込まれた差分ビューでは、Gemini が提案する変更と元のコードを確認できます。その後、提案された変更を受け入れることも、破棄することもできます。

インラインテキストボックスからリファクタリングされたコードの差分を表示するには、次の手順を行います。

コードファイルで関数を選択し、Ctrl+I（Windows および Linux の場合）または Command+I（macOS の場合）を押してインラインテキストボックスを開きます。
「Add comments」などのプロンプトを入力して、Enter（Windows と Linux の場合）または Return（macOS の場合）を押します。

選択した関数に対するコードの変更が Gemini によって生成されると、差分ビューが表示されます。
変更を承認または破棄するには、[承認] または [破棄] をクリックします。

生成された回答のコンテキストソースを表示する

コンテキスト表示機能では、プロンプトへのレスポンスの生成への参照として使用されたプロジェクトファイル（コンテキストソース）が一覧表示されます。どのファイルが参照として使用されたかを知ることで、プロンプトを絞り込み、より具体的なレスポンスを得ることができます。コンテキストソースは、Gemini とのチャットを使用するたびに表示されます。

生成されたレスポンスのコンテキストソースを表示するには、[Gemini: チャット] ペインで、[Context Sources] スニペットが表示されるまでスクロールします。スニペットを展開すると、すべてのコンテキストソースが表示されます。

Gemini の [チャット] ペインに表示されるコンテキストソース。

Smart Commands を使用する

スマートコマンドは、インラインテキストボックスで使用でき、コードに対して特定のアクションを実行するコマンドです。

/explain スマートコマンドを使用してコードファイル全体の説明を取得するには、次の手順に従います。

コードファイルで、Ctrl+I（Windows と Linux の場合）または Command+I（macOS の場合）を押してインラインテキストボックスを開きます。
/ を押すと、スマートコマンドとその説明のリストが表示されます。
[/explain] を選択します。

Gemini によって、コードファイル全体の説明がインラインテキストボックスに生成されます。
省略可: 生成された回答を [Gemini: チャット] ペインに表示する場合は、[チャットで表示] をクリックします。

プロンプト履歴を表示する

プロンプトの履歴にアクセスすると、大きいコードファイルに同じプロンプトを入力する必要がある場合に時間を節約できます。

プロンプトの履歴にアクセスするには、コードファイルで Ctrl+I（Windows および Linux の場合）または command+I（macOS の場合）を押してインラインテキストボックスを開きます。Ctrl+↑（Windows および Linux）または Command+↑（macOS の場合）を押します。これにより、古いプロンプトを順番に処理し、必要に応じて再利用できます。

英語を母国語としないユーザー向けにコードの読みやすさを向上させる

翻訳アプリケーションに依存している非ネイティブの英語話者の場合は、インラインテキストボックスを使用して他の言語でコメントを生成できます。

英語のコメントを別の言語に変換したり、別の言語で新しいコメントを追加したりするには、次の手順を行います。

コードファイルで、コメントを追加するコードを選択します。
Ctrl+I（Windows と Linux の場合）または Command+I（macOS の場合）を押して、インラインテキストボックスを開きます。
「Add spanish comments」などのプロンプトを入力して、Enter（Windows と Linux の場合）または Return（macOS の場合）を押します。

Gemini によって、プロンプトで指定した言語でコメントが生成され、これらの提案の差分が表示されます。
コードの変更を承認または破棄するには、[承認] または [破棄] をクリックします。

他のサンプルプロンプトをテストする

このドキュメントのプロンプトを使用してコードを生成するセクションを読み終えたら、次のプロンプト例をいくつか試してください。

コードの説明を取得する

コードファイルで、説明対象の関数を選択します。
[Gemini コードアシスタンス] ペインで、プロンプト「Explain this code to me」を入力します。

Gemini は、選択したコードをリファレンスとして使用し、選択した関数の説明を返します。

テスト計画を生成する

コードファイルで、単体テストを追加するコードを選択します。
[Gemini コードアシスタンス] ペインで、プロンプト「Write unit tests for my code」を入力します。

デバッグコードでヘルプを受ける

コードファイルで、デバッグするコードを選択します。
[Gemini コードアシスタンス] ペインで、プロンプト「Help me debug my code」を入力します。

コードを読みやすくする

コードファイルで、読みやすくするコードを選択します。
[Gemini コードアシスタンス] ペインで、プロンプト「Make my code more readable」を入力します。

コードの特定の部分に焦点を当てるには、Gemini のプロンプトを表示する前にコードの目的の箇所を選択します。

既知の問題

以降のセクションでは、Gemini Code Assist の既知の問題について説明します。

ライセンスの引用に関する警告がセッションをまたいで維持されない

ライセンスの引用に関する警告がセッションをまたいで維持されない場合は、永続ログをご覧ください。

メニュー メニュー > [表示] > [出力] の順にクリックします。
[Gemini コードアシスタンス- 引用] を選択します。

Gemini コードアシスタンスの出力ウィンドウにおける接続の問題

Gemini Code Assist の出力ウィンドウに接続エラーなどの接続の問題が表示される場合は、次のことをお試しください。

oauth2.googleapis.com と cloudaicompanion.googleapis.com へのアクセスを許可するようにファイアウォールを構成する。
gRPC が使用する HTTP/2 経由の通信を許可するようにファイアウォールを構成する。

grpc-health-probe ツールを使用して接続をテストできます。テストで問題がない場合は、次の出力が表示されます。

$ grpc-health-probe -addr cloudaicompanion.googleapis.com:443 -tls error: this server does not implement the grpc health protocol (grpc.health.v1.Health): GRPC target method can't be resolved

テストで問題があった場合は、次の出力が表示されます。

timeout: failed to connect service "cloudaicompanion.googleapis.com:443" within 1s

詳細を取得するには、「grpc-health-probe」の前に次のコマンドを実行します。

export GRPC_GO_LOG_SEVERITY_LEVEL=info

Gemini Code Assist プロジェクトを選択した後も、[Gemini Code Assist を有効にする] が表示される

このガイドの手順（Cloud AI Companion API を有効にすることを含む）に沿ってプロジェクトを選択した場合は、LS サーバーに問題が生じる可能性があります。

問題の詳細を確認するには、次の操作を行います。

ステータスバーで、spark [Gemini Code Assist] をクリックしてから、[フィードバックを送信] を選択します。
いずれかのログファイルの [表示] をクリックすると、詳細が表示され、問題のトラブルシューティングを実行できます。

フィードバック

体験へのフィードバックを残すには、次の手順に従います。

ステータスバーで [Gemini コードアシスタンス] をクリックし、[クイックピック] メニューで [フィードバックの送信] を選択します。
フォームの [Title] と [Comment] のフィールドに記入します。
Skaffold または AI Companion のログを共有したい場合は、[Skaffold ログを送信する] または [AI Companion ログを送信する] のオプションを選択していることを確認します。
[フィードバックを送信する] をクリックします。

次のステップ

より良いプロンプトを作成する方法を確認する。