코드 제안 API

코드 제안 API를 사용하여 코드 제안 기능에 액세스합니다.

코드 완성 생성

Status: Experiment

context 및 user_instruction 속성의 가용성은 기능 플래그에 의해 제어됩니다.
더 많은 정보는 역사에서 확인하세요.
이 속성은 테스트를 위해 제공되지만, 생산 사용 준비는 되어 있지 않습니다.
POST /code_suggestions/completions
note
이 엔드포인트는 각 사용자의 요청을 1분당 60회로 제한합니다.

AI 추상화 계층을 사용하여 코드 완성을 생성합니다.

이 엔드포인트에 대한 요청은 AI Gateway로 프록시됩니다.

매개변수:

속성 유형 필수 설명
current_file 해시 예 제안 생성을 위한 파일의 속성. 이 속성이 수용하는 문자열의 목록은 파일 속성에서 확인하세요.
intent 문자열 아니요 완성 요청의 의도. completion 또는 generation 중 하나일 수 있습니다.
stream 불리언 아니요 응답을 작게 나누어 준비가 되는 대로 스트리밍할지 여부(해당하는 경우). 기본값: false.
project_path 문자열 아니요 프로젝트의 경로.
generation_type 문자열 아니요 생성 요청의 이벤트 유형. comment, empty_function, 또는 small_file일 수 있습니다.
context 배열 아니요 코드 제안을 위한 추가 컨텍스트. 이 속성이 수용하는 매개변수 목록은 컨텍스트 속성에서 확인하세요.
user_instruction 문자열 아니요 코드 제안에 대한 사용자의 지침.

파일 속성

current_file 속성은 다음 문자열을 수용합니다:

  • file_name - 파일의 이름. 필수.
  • content_above_cursor - 현재 커서 위치 위의 파일 내용. 필수.
  • content_below_cursor - 현재 커서 위치 아래의 파일 내용. 선택 사항.

컨텍스트 속성

context 속성은 다음 속성을 가진 요소 목록을 수용합니다:

  • type - 컨텍스트 요소의 유형. file 또는 snippet 중 하나일 수 있습니다.
  • name - 컨텍스트 요소의 이름. 파일 이름 또는 코드 스니펫.
  • content - 컨텍스트 요소의 내용. 파일 본문이나 함수.

예제 요청:

curl --request POST \
  --header "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  --data '{
      "current_file": {
        "file_name": "car.py",
        "content_above_cursor": "class Car:\n    def __init__(self):\n        self.is_running = False\n        self.speed = 0\n    def increase_speed(self, increment):",
        "content_below_cursor": ""
      },
      "intent": "completion"
    }' \
  --url "https://gitlab.example.com/api/v4/code_suggestions/completions"

예제 응답:

{
  "id": "id",
  "model": {
    "engine": "vertex-ai",
    "name": "code-gecko"
  },
  "object": "text_completion",
  "created": 1688557841,
  "choices": [
    {
      "text": "\n        if self.is_running:\n            self.speed += increment\n            print(\"The car's speed is now",
      "index": 0,
      "finish_reason": "length"
    }
  ]
}

코드 제안이 활성화되었는지 확인

다음 중 하나를 확인하기 위해 이 엔드포인트를 사용하세요:

  • 프로젝트에 code_suggestions가 활성화되어 있는지 여부.
  • 프로젝트의 그룹이 네임스페이스 설정에서 code_suggestions가 활성화되어 있는지 여부.
POST code_suggestions/enabled

지원되는 속성:

속성 유형 필수 설명
project_path string yes 확인할 프로젝트의 경로입니다.

성공적으로 수행되면 다음을 반환합니다:

  • 기능이 활성화되어 있으면 200.
  • 기능이 비활성화되어 있으면 403.

경로가 비어 있거나 프로젝트가 존재하지 않으면 404를 추가로 반환합니다.

예제 요청:

curl --request POST \
  --url "https://gitlab.example.com/api/v4/code_suggestions/enabled"
  --header "Private-Token: <YOUR_ACCESS_TOKEN>" \
  --header "Content-Type: application/json" \
  --data '{
      "project_path": "group/project_name"
    }' \

직접 연결 정보 가져오기

  • GitLab 17.0에서 도입됨 code_suggestions_direct_completions라는 플래그와 함께. 기본적으로 비활성화됨.
  • GitLab 17.2에서 일반적으로 사용 가능. 기능 플래그 code_suggestions_direct_completions가 제거됨.
POST /code_suggestions/direct_access

참고:

이 엔드포인트는 각 사용자에게 5분당 10개의 요청으로 제한합니다.

IDE/클라이언트가 AI 게이트웨이에 직접 완료 요청을 보낼 수 있도록 사용자별 연결 세부 정보를 반환합니다.

예제 요청:

curl --request POST \
  --header "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  --url "https://gitlab.example.com/api/v4/code_suggestions/direct_access"

예제 응답:

{
  "base_url": "http://0.0.0.0:5052",
  "token": "유효한 토큰",
  "expires_at": 1713343569,
  "headers": {
    "X-Gitlab-Instance-Id": "292c3c7c-c5d5-48ec-b4bf-f00b724ce560",
    "X-Gitlab-Realm": "saas",
    "X-Gitlab-Global-User-Id": "Df0Jhs9xlbetQR8YoZCKDZJflhxO0ZBI8uoRzmpnd1w=",
    "X-Gitlab-Host-Name": "gitlab.example.com"
  }
}