Completions
- 인쇄
- PDF
Completions
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Classic/VPC 환경에서 이용 가능합니다.
CLOVA Studio에서 결괏값(completion)을 생성하기 위한 정보를 CLOVA Studio에 전달할 수 있습니다. 프롬프트의 내용과 사용할 모델, 그 외의 설정 파라미터 값을 지정해서 전달하면 CLOVA Studio는 이 내용을 바탕으로 결괏값을 생성합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /v1/completions/{model} |
헤더
헤더에 대한 설명은 다음과 같습니다.
| 헤더 | 필수 여부 | 설명 |
|---|---|---|
| X-NCP-CLOVASTUDIO-API-KEY | Y | 테스트 앱이나 서비스 앱 생성 시 발급 받은 API KEY |
| X-NCP-APIGW-API-KEY | Y | 테스트 앱이나 서비스 앱 생성 시 발급 받은 API Gateway KEY |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | 각 요청에 대한 요청 아이디 |
| Content-Type | Y | application/json |
경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| model | string | Y | 모델 이름: LK-D2 |
바디
바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| includeAiFilters | boolean | N | 생성되는 텍스트에 대해 욕설, 비하/ 차별/ 혐오, 성희롱/ 음란 등의 카테고리별로 해당하는 정도를 표시함 |
| includeTokens | boolean | N | input_tokens와 output_tokens를 응답에 포함할지 여부 |
| maxTokens | int | N | 결과값을 생성할 때 사용할 최대 토큰의 수 |
| repeatPenalty | float | N | 같은 표현이 반복되는 토큰에 부여할 페널티 값 |
| restart | string | N | 출력값 뒤에 붙일 텍스트 |
| start | string | N | 사용자 입력값 뒤에 붙일 텍스트 |
| stopBefore | array | N | 토큰 생성 중단 문자 |
| temperature | float | N | 결과값의 무작위성. 높을수록 무작위한 결과가 생성될 가능성이 높아짐 |
| text | string | Y | 사용자의 입력값(프롬프트)으로, 이 텍스트를 바탕으로 새로운 문장 생성 |
| topK | int | N | Top K 값. 토큰을 확률이 높은 순서대로 나열하고 상위 K의 범위 안에 드는 토큰까지만 사용 |
| topP | float | N | Top P 값. Top P가 누적 확률 값 범위에 포함된 토큰을 후보로 선택 |
구문
구문 예시는 다음과 같습니다.
curl --location --request POST 'https://clovastudio.apigw.ntruss.com/testapp/v1/completions/LK-D2' \
--header 'X-NCP-CLOVASTUDIO-API-KEY: <X-NCP-CLOVASTUDIO-API-KEY>' \
--header 'X-NCP-APIGW-API-KEY: <X-NCP-APIGW-API-KEY>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json' \
--data '{
"start": "\n영어: ",
"stopBefore": ["\n한국어: "],
"text": "한국어: 사과\n영어: Apple\n한국어: 바나나",
"includeAiFilters": true
}'
응답
응답 형식을 설명합니다.
헤더
헤더에 대한 설명은 다음과 같습니다.
| 헤더 | 필수 여부 | 설명 |
|---|---|---|
| Content-Type | - | application/json |
바디
바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| 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"
}
]
}
}
이 문서가 도움이 되었습니까?