Sliding window
- Print
- PDF
Sliding window
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Delete sentences that exceed the maximum number of tokens when using Chat completions API.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /v1/api-tools/sliding/chat-messages/{modelName} |
Request headers
The following describes the headers.
| Header | Required | Description |
|---|---|---|
| X-NCP-CLOVASTUDIO-API-KEY | Y | API key issued when viewing code |
| X-NCP-APIGW-API-KEY | Y | API Gateway key issued when viewing code |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | Request ID for each request |
| Content-Type | Y | application/json |
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
| modelName | string | Y | Name of the model to use <E.g.> HCX-003 |
Request body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
| messages | array[ChatMessage] | Y | List of conversation messages (target to be adjusted for maximum number of tokens) |
| ChatMessage.role | enum | Y | Role of conversation messages |
| ChatMessage.content | string | Y | Conversation message content |
| maxTokens | int | Y | Maximum number of generated tokens (adjusted so that the sum of the number of tokens entered in messages and the number of tokens entered in maxTokens does not exceed 4096 tokens, the maximum number of tokens) |
Request syntax
The following is a sample syntax.
curl --location --request POST 'https://clovastudio.apigw.ntruss.com/v1/api-tools/sliding/chat-messages/{modelName}' \
--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 '{
"maxTokens" : 200,
"messages" : [ {
"role" : "user",
"content" : "hello"
} ]
}'
Response
The following describes the response format.
Response body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
| result | result | - | Response result (adjusted for maximum number of tokens) |
| result.role | enum | - | Role of conversation messages |
| result.content | string | - | Conversation message content |
Response syntax
The following is a sample syntax.
Success
The following is a sample syntax upon a successful call.
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"messages": [
{
"role": "user",
"content": "hello"
}
]
}
}
Failure
The following is a sample syntax upon a failed call.
Was this article helpful?