AI 프롬프트 생성
새 AI 프롬프트를 생성합니다. 기존 프롬프트의 정보는 AI 프롬프트 수정 API로 변경할 수 있습니다.
필요 권한
관리자 이상의 계정으로 이용할 수 있습니다.
HTTP 요청
POST /api/sonar/ai/prompts
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
-d name="로그 분석" \
-d type="qna" \
-d description="로그 분석용 프롬프트" \
-d prompt="prompt: |
로그를 분석하여 이상 징후를 탐지하세요.
" \
-X POST \
https://HOSTNAME/api/sonar/ai/prompts
요청 매개변수
| 키 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|
| guid | X | 문자열 | 프롬프트 GUID | 36자. 미지정 시 자동 발급 |
| name | O | 문자열 | 프롬프트 이름 | 같은 이름의 프롬프트가 존재하면 안 됨 |
| description | X | 문자열 | 프롬프트 설명 | |
| type | O | 문자열 | 프롬프트 유형 | plan, action, qna 중 하나 |
| prompt | O | 문자열 | 프롬프트 내용 | YAML 형식 |
정상 응답
{
"guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
- guid (문자열): 생성된 프롬프트의 GUID
오류 응답
필수 매개변수가 누락된 경우
HTTP 상태 코드 400 응답
{
"error_code": "null-argument",
"error_msg": "name should be not null"
}
guid가 GUID 형식이 아닌 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-param-type",
"error_msg": "guid should be guid type."
}
같은 이름의 프롬프트가 이미 존재하는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "duplicated prompt name: 로그 분석"
}
프롬프트 생성 요청에 실패한 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "cannot create prompt"
}