Break paragraph
- Print
- PDF
Break paragraph
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Identify paragraphs in a post by topic by identifying similarities between sentences.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /testapp/v1/api-tools/segmentation/{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 | Unique ID of the applicable test app or service app |
Request body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
| texts | array[string] | Y | Document to break paragraphs for |
| alpha | float | N | The thresholds value for paragraph breaks; Larger values increase the number of paragraph splits |
| alpha | float | N | The thresholds value for paragraph breaks; Larger values increase the number of paragraph splits |
| segCnt | integer | N | Desired number of paragraph breaks |
| postProcess | boolean | N | Whether to perform post-processing to merge or split paragraphs to the desired length after performing a paragraph break |
| postProcessMaxSize | integer | N | Maximum number of characters in a string in a paragraph when applying post process module |
| postProcessMaxSize | integer | N | Maximum number of characters in a string in a paragraph when applying post process module |
Request syntax
The following is a sample syntax.
curl --location 'https://clovastudio.apigw.ntruss.com/testapp/v1/api-tools/segmentation/{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 '{
"text": "How can we create a note?\nThere are two ways to do it.\nTap the Add button in the CLOVA Note app to start recording, or import a recording file you have saved on your smartphone to create a note.\nThe notes you create can be viewed not only on the app but also integrated with the CLOVA Note website on your PC.\nOn the CLOVA Note website, you can create a note by importing a saved recording file.\nHow do we use bookmarks?\nIf you tap the Bookmark button in the middle of the recording on the CLOVA Note app page, it will be displayed as shown below, so you can easily find the section you need even after finishing the recording.\nIf you finish a recording, there must be a section of the recording that you want to find again.\nWe provide bookmarks for such moments.\nSo, how do we listen to our recordings?\nSelect the recorded conversation from the created notes and you can listen to the recording again.\nIf there's a mistake in the recording, you can easily correct it by listening to it again and tapping the Edit button.",
"alpha": -100,
"segCnt": -1,
"postProcess": false,
"postProcessMaxSize": 2000,
"postProcessMinSize": 500
}'
Response
The following describes the response format.
Response body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
| topicSeg | array[array[string]] | Y | Results with paragraphs separated by subtopics |
| span | array[array[integer]] | N | Index of paragraphed text (to see where paragraphs are broken) |
| inputTokens | integer | Y | Number of tokens in a document with paragraph break performed |
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": {
"topicSeg": [
[
"How can we create a note?",
"There are two ways to do it."
],
[
"Tap the Add button in the CLOVA Note app to start recording, or import a recording file you have saved on your smartphone to create a note.",
"The notes you create can be viewed not only on the app but also integrated with the CLOVA Note website on your PC.",
"On the CLOVA Note website, you can create a note by importing a saved recording file."
],
[
"How do we use bookmarks?",
"If you tap the Bookmark button in the middle of the recording on the CLOVA Note app page, it will be displayed as shown below, so you can easily find the section you need even after finishing the recording.",
"If you finish a recording, there must be a section of the recording that you want to find again.",
"We provide bookmarks for such moments."
],
[
"So, how do we listen to our recordings?",
"Select the recorded conversation from the created notes and you can listen to the recording again.",
"If there's a mistake in the recording, you can easily correct it by listening to it again and tapping the Edit button."
]
],
"span": [
[
0,
1
],
[
2,
3,
4
],
[
5,
6,
7,
8
],
[
9,
10,
11
]
],
"inputTokens": 330
}
}
Failure
The following is a sample syntax upon a failed call.
Was this article helpful?