Summarize
- Print
- PDF
Summarize
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Summarize long sentences by applying different options.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /testapp/v1/api-tools/summarization/v2/{appId} |
Request headers
The following describes the headers.
| Header | Required | Description |
|---|---|---|
| X-NCP-CLOVASTUDIO-API-KEY | Y | API key issued when creating the test app |
| X-NCP-APIGW-API-KEY | Y | API Gateway key issued when creating the test app or service app |
| 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 |
|---|---|---|---|
| appId | string | Y |
Request body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
| texts | array[string] | Y | List of sentences to summarize |
| autoSentenceSplitter | boolean | N | Whether to allow sentence separation in the list of sentences to summarize |
| segCount | integer | N | Number of paragraphs to separate the list of sentences to summarize |
| segMaxSize | integer | N | Maximum number of characters in a string to be included in a paragraph when separating paragraphs |
| postProcess | boolean | N | Whether to perform post-processing to merge or split paragraphs to the desired length after performing a paragraph break |
| segMaxSize | integer | N | Minimum number of characters in a string to be included in a paragraph when separating paragraphs |
| includeAiFilters | boolean | N | Whether to apply AI Filter (default: false) |
Request syntax
The following is a sample syntax.
curl --location 'https://clovastudio.apigw.ntruss.com/testapp/v1/api-tools/summarization/v2/{appId}' \
--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 '{
"texts": [
"The following are some of the many features that CLOVA Studio offers. - Sentence generation: Just type in a few keywords and generate sentences based on those keywords for screenwriting, cover letter writing, email writing, marketing copy creation, etc. - Summarization: Identify key elements from a long article, such as a plot, report, or email, and summarize the article based on the set summary length. - Categorization: Categorize features such as sentence type, document index, sentiment, intent, or extract keywords from paragraphs. - Conversation: Create AIs with unique personas through example inputs to create conversational interfaces such as encyclopedic chatbots, custom chatbots, etc. - Sentence conversion: Convert sentences into sentences with a similar style to the entered example. AI Filter: AI Filter detects and alerts you when sensitive or unsafe output is being generated."
],
"autoSentenceSplitter": true,
"segCount": -1,
"segMaxSize": 1000,
"segMinSize": 300,
"includeAiFilters": false
}'
Response
The following describes the response format.
Response body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
| text | string | Y | Summary results |
| inputTokens | integer | Y | Number of tokens used when typing a sentence to summarize |
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": {
"text": "- Explaining the different features that CLOVA Studio offers",
"inputTokens": 187
}
}
Failure
The following is a sample syntax upon a failed call.
Was this article helpful?