エンジニアリング概要

Code Suggestions 機能の技術およびエンジニアリングの概要

はじめに

GitLab の Code Suggestions の技術概要へようこそ。これは、開発環境内に高度な AI 技術を直接統合することでコーディング体験を向上させるために設計された機能です。このページは、インテリジェントな補完と生成的なコーディング機能を通じてコーディングプロセスを大幅に効率化する、革新的な Code Suggestions 機能の背後にあるアーキテクチャと相互作用を理解するためのガイドです。

その中心では、Code Suggestions は、IDE 拡張機能、Language Server、GitLab Workhorse、そして AI Gateway などの複数のコンポーネントを含む洗練されたワークフローを通じて動作し、最終的にリアルタイムでコンテキストを認識したコーディング提案を提供します。タイピングタスクを高速化するシンプルなコード補完から、コードブロック全体を作り上げる複雑なコード生成まで、私たちのシステムは幅広いコーディングアクティビティをサポートし、生産性を向上させるように設計されています。

以下では、このエコシステム内の各コンポーネントの役割を詳述し、システムを通るデータの流れを説明し、迅速な提案と詳細なコード生成の両方を提供するために、さまざまなタイプのコーディングインタラクションがどのように処理されるかを説明します。

Code Suggestions 技術概要

Code Suggestions は通常、以下の図に示すシーケンスに従います。

sequenceDiagram
    actor USR as  User
    participant IDE
    participant EXT as IDE Extension
    participant LS as Language Server
    participant GLW as GitLab Workhorse
    participant GLR as GitLab Rails
    participant AIGW as AI Gateway
    participant LLM as Large Language Model

    USR->>IDE: types: "def add(a, b)"
    IDE->>EXT: notify about document change def add(a, b)
    EXT->>LS: register document change def add(a, b)
    LS->>GLW: sends code suggestion requests
    GLW->>GLR: proxies code suggestion request
    GLR->>GLW: enriches code suggestion request
    GLW->>AIGW: enriched code suggestion request
    AIGW->>LLM:  enriched code suggestion request
    LLM->>AIGW: "a + b"
    AIGW->>GLW: suggestion: "a + b"
    GLW->>LS:  suggestion: "a + b"
    LS->>EXT: triggers IDE code suggestion UI: "a + b"
    EXT->>IDE: triggers IDE code suggestion UI: "a + b"

図に示されているコンポーネントは以下の通りです。

  1. IDE 拡張機能：GitLab はいくつかの IDE 拡張機能（別名プラグイン）を提供しており、その他の機能の中でも Language Server との統合を提供します
    1. VSCode 拡張機能：https://gitlab.com/gitlab-org/gitlab-vscode-extension/
    2. JetBrains 拡張機能：https://gitlab.com/gitlab-org/editor-extensions/gitlab-jetbrains-plugin
    3. NeoVim 拡張機能：https://gitlab.com/gitlab-org/editor-extensions/gitlab.vim
  2. Language Server：これは、異なる IDE 間で共有できる機能を提供する統一された方法であり、重複を削減します。Language Server は、IDE 拡張機能との通信に LSP プロトコルを使用するコンポーネントです。
  3. GitLab Workhorse - GitLab Workhorse は、リソース集約的で長時間実行されるリクエストを処理するための GitLab 用のスマートなリバースプロキシです。
  4. GitLab Rails - 機能の大部分を提供する GitLab のメインコンポーネント。
  5. AI Gateway - GitLab のすべてのユーザーに対して、利用しているインスタンス（セルフマネージド、Dedicated、GitLab.com）にかかわらず AI 機能へのアクセスを提供するスタンドアロンサービスです。コンセプトに関する詳細はアーキテクチャブループリントを参照してください
  6. Large Language Model - コード生成機能を提供する AI モデル

Code Suggestions には 2 種類のインタラクションがあります。

  • Code Completion：既存の行またはコードブロックを完成させることを目的とした、短い AI 生成の提案
  • Code Generation：関数、クラス、コードブロック全体などを作成することを目的とした、より長い AI 生成の提案

各 Code Suggestions リクエストは単一のカテゴリに分類されます。リクエストの分類は、リクエストが GitLab Workhorse に送信される前に Language Server によって実行されます。Language Server で分類が行われていない場合、この分類は GitLab Rails によって実行されます。

Code Completion

Code Completion インタラクションは、IDE によってトリガーできる 2 種類の Code Suggestions リクエストの 1 つです。その目的は、より小さな提案サイズと、周辺のソースコードやリポジトリファイルに対するコンテキスト認識の少なさと引き換えに、非常に高速なレスポンス（< 1 秒）を提供することです。

デフォルトでは、code completion リクエストは 後述のシーケンスに示すように、GitLab Rails モノリスから取得した直接接続の詳細を使用して、AI Gateway に直接送信されます。 あるいは、リクエストは Code Suggestions 技術概要の図に示すように、GitLab Rails モノリスからルーティングすることもできます。

Language Server によって準備されたリクエストは、追加のコンテキストを付加せず、ほぼ修正されていない形式でプロキシされます。この機能における GitLab Rails の役割は、ほとんど認可エンティティとして、特定のユーザーが Code Suggestions 機能を使用することを許可されていることを保証することに限定されます。

Code Completion 直接接続の図

sequenceDiagram
    actor USR as  User
    participant IDE
    participant EXT as IDE Extension
    participant LS as Language Server
    participant GLR as GitLab Rails
    participant AIGW as AI Gateway

    USR->>IDE: types: "def add(a, b)"
    IDE->>EXT: notify about document change def add(a, b)
    EXT->>LS: register document change def add(a, b)
    LS->>LS: triggers code suggestion request
    alt there is unexpired direct connection details in cache?
    LS->>LS: fetches direct connection details from cache
    else
    LS->>GLR: requests for direct connection details
    GLR->>LS: returns direct connection details (AIGW url and token, expiry, model details)
    LS->>LS: caches direct connection details, with 1 hour expiry
    end
    LS->>AIGW: sends code suggestion requests using direct connection details
    AIGW->>LS:  suggestion: "a + b"
    LS->>EXT: triggers IDE code suggestion UI: "a + b"
    EXT->>IDE: triggers IDE code suggestion UI: "a + b"

図に描かれているコンポーネントは 技術概要セクションで説明されています。

Code Generation

Code Generation インタラクションは、IDE によってトリガーできるもう 1 つのタイプの Code Suggestions リクエストです。その目的は、関数やクラスのような完全なコードブロックを生成する、長くて広範なレスポンスを提供することです。これは、code completion よりもはるかに長い応答時間を持ちます（最大 30 秒）。このタイプの Code Suggestions リクエストは、ユーザータスクを解決する際に、拡張されたコンテキストを考慮します。このコンテキストは、IDE 内の現在のファイルだけでなく、Repository X-Ray のレポートからも来ます。

sequenceDiagram
    actor USR as User
    participant IDE
    participant PG as GitLab PostgreSQL DB
    participant GLR as GitLab Rails
    participant AIGW as AI Gateway

    USR->>+IDE: types: "#35; generate a function that transposes a matrix"
    IDE->>+GLR: trigger code generation for line ` "#35; generate function `
    GLR->>PG: fetch X-Ray report for project and language
    PG->>GLR:  xray_reports record
    GLR->>GLR: include first 300 entities from xray report into code generation prompt
    GLR->>-AIGW: trigger code generation ` "#35; generate function `

上記の図では、簡潔さのためいくつかのコンポーネント（GitLab Workhorse や Language Server を含む）が省略されています。しかし、技術概要セクションに示されているリクエストの高レベルなフローは変わりません。

API リファレンス

Rails モノリスと AI Gateway プロジェクトの両方で使用される Code Suggestions API エンドポイントの完全な概要については、以下を参照してください。

最終更新 May 6, 2026: Merge pull request #100 from kyama0/fix/upload-images-tolerate-upstream-missing (70970e1a)
ページのソースコードを見る - ページの編集 - please contribute. Creative Commons License