Completion (JP)
- 인쇄
- PDF
Completion (JP)
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Completion API
Completion API를 이용하여 CLOVA Studio에서 결과값(completion)을 생성하기 위한 정보를 CLOVA Studio에 전달할 수 있습니다. 프롬프트의 내용과 사용할 모델, 그 외의 설정 파라미터 값을 지정해서 전달하면 CLOVA Studio는 이 내용을 바탕으로 결과값을 생성합니다.
요청
POST: /v1/completions/{model}
| Name | Description |
|---|---|
| model | 사용할 모델 |
요청 헤더
| Name | Required | Description |
|---|---|---|
| X-NCP-CLOVASTUDIO-API-KEY | 필수 | 테스트 앱 또는 서비스 앱 생성 시 발급 받은 API KEY |
| X-NCP-APIGW-API-KEY | 필수 | 테스트 앱 또는 서비스 앱 생성 시 발급 받은 API Gateway KEY |
| X-NCP-CLOVASTUDIO-REQUEST-ID | 선택 | 각 요청에 대한 REQUEST ID |
요청 바디
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| includeAiFilters | boolean | 선택 | true | 생성되는 텍스트에 대해 욕설, 비하/ 차별/ 혐오, 성희롱/ 음란 등의 카테고리별로 해당하는 정도를 표시함 |
| includeTokens | bool | 선택 | false | input_tokens와 output_tokens를 응답에 포함할지 여부
|
| maxTokens | integer | 선택 | 32 | 결과값을 생성할 때 사용할 최대 토큰의 수(0~2048) |
| repeatPenalty | float | 선택 | 5.0 | 같은 표현이 반복되는 토큰에 부여할 페널티 값 (0~10) |
| restart | string | 선택 | '' | 출력값 뒤에 붙일 텍스트 |
| start | string | 선택 | '' | 사용자 입력값 뒤에 붙일 텍스트 |
| stopBefore | string array | 선택 | empty list | 결과값 생성을 중단하라는 신호가 될 문자열(stop sequence). 지정한 문자열은 생성한 텍스트에 포함되지 않음 |
| temperature | float | 선택 | 0.5 | 결과값의 무작위성. 높을수록 무작위한 결과가 생성될 가능성이 높아짐 (0~1.0) |
| text | string | 필수 | N/A | 사용자의 입력값(프롬프트). 이 텍스트를 바탕으로 새로운 문장 생성 |
| topK | integer | 선택 | 0 | Top K 값. 토큰을 확률이 높은 순서대로 나열하고 상위 K의 범위 안에 드는 토큰까지만 사용 (0~128) |
| topP | float | 선택 | 0.8 | Top P 값. Top P가 누적 확률 값 범위에 포함된 토큰을 후보로 선택. (0~1.0) |
{
"start": "\n영어: ",
"stopBefore": ["\n한국어: "],
"text": "한국어: 사과\n영어: Apple\n한국어: 바나나",
"includeAiFilters": true
}
응답
| Key | Type | Required | Description |
|---|---|---|---|
| aiFilters | object array | 선택 | AI Filter 점수 |
| aiFilters[].groupName | string | 필수 | AI Filter 분류 참조 |
| aiFilters[].name | string | 필수 | AI Filter 분류 참조 |
| aiFilters[].score | string | 필수 | 텍스트가 aiFilters[].name 카테고리에 해당하는 정도
|
| inputLength | integer | 필수 | 입력된 토큰 수 |
| inputTokens | string array | 선택 | 입력된 토큰 정보 |
| outputLength | integer | 필수 | 출력된 토큰 수 |
| outputTokens | string array | 선택 | 출력된 토큰 정보 |
| stopReason | string | 필수 | 결과값 생성을 중단한 이유
|
| text | string | 필수 | 생성한 토큰. 프롬프트와 결과값 모두 포함 |
| probs | float | 선택 | 생성된 각 토큰이 선택될 확률 |
AI Filter 분류
aiFilters[].groupName과 aiFilters[].name에 포함되는 내용은 아래의 표를 참고합니다.
| groupName | name | 설명 |
|---|---|---|
| curse | discrimination | 비하 또는 차별 또는 혐오 |
| curse | insult | 욕설 |
| unsafeContents | sexualHarassment | 성희롱 또는 음란 |
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"text": "...",
"stopReason": "stop_before",
"inputLength": 10,
"outputLength": 20,
"inputTokens" : ["who", " ", "are", " ", "you"],
"outputTokens" : ["hello", " ", "world"],
"aiFilters": [
{
"groupName": "curse",
"name": "insult",
"score": "0"
},
{
"groupName": "curse",
"name": "discrimination",
"score": "1"
},
{
"groupName": "unsafeContents",
"name": "sexualHarassment",
"score": "2"
}
]
}
}
이 문서가 도움이 되었습니까?