リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/v1/api-tools/segmentation

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド	必須の有無	説明
`Authorization`	Required	認証用 APIキー<例> `Bearer nv-************`
`X-NCP-CLOVASTUDIO-REQUEST-ID`	Optional	リクエスト ID
`Content-Type`	Required	リクエストデータの形式 `application/json`

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`text`	Array	Required	段落分け対象の文書 1~120,000文字(ハングル基準、スペースを含む)
`alpha`	Float	Optional	段落分けのための Thresholds値大きいほど分けられる段落数は増える -100 \| -1.5~1.5 (デフォルト: 0.0) -100: モデルが最適値で自動実行
`segCnt`	Integer	Optional	段落分け数 -1(デフォルト) \| 1以上 -1: モデルが最適値で自動実行
`postProcess`	Boolean	Optional	段落分けの実行後、目的の長さに合わせて段落を結合したり、分割する事後処理を行うかどうか `true` \| `false`(デフォルト) `true`: 事後処理を行って関連パラメータを適用 `false`: 事後処理を行わない
`postProcessMaxSize`	Integer	Optional	`postProcess`事後処理後段落の最大文字数 1以上(デフォルト: 1,000)
`postProcessMinSize`	Integer	Optional	`postProcess`事後処理後段落の最小文字数 -1 \| 0~`postProcessMaxSize`の値(デフォルト: 300) -1: 最小単位に自動設定

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://clovastudio.stream.ntruss.com/testapp/v1/api-tools/segmentation' \
--header 'Authorization: Bearer {API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
          "text": "ノートはどのように作成できますか?\n2つの方法があります。\nクローバーノートアプリで追加ボタンをクリックして録音を始めるか、スマートフォンに保存しておいた録音ファイルを呼び出すと、ノートが作成されます。\nこうやって作られたノートはアプリだけでなく、PCのクローバーノートのウェブサイトでも連携して確認することができます。\nクローバーノートサイトでは、保存した録音ファイルを呼び出すとノートを作成することができます。\nブックマークの使い方を教えてください。\nクローバーノートアプリの画面で録音の途中でブックマークボタンをクリックすると、以下のように表示され、録音を終えた後でも必要な区間を簡単に見つけることができます。\n普通録音が終わったら、もう一度探したい録音区間が絶対ありますよね。\nそういう時のためにブックマークを提供しています。\nじゃあ、録音した音声はどうすれば聞けますか?\n作成されたノートから記録された会話を選択すると、録音した音声をもう一度聞くことができます。\nもし音声記録が間違っている区間があれば、もう一度音声を聞いて編集ボタンをクリックして簡単に修正することができます。",
          "alpha": -100,
          "segCnt": -1,
          "postProcess": false,
          "postProcessMaxSize": 2000,
          "postProcessMinSize": 500
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`topicSeg`	Array	-	段落分けの結果
`span`	Array	-	段落が分けられたテキストのインデックス段落が分けられた位置を確認 `[]`(デフォルト)
`inputTokens`	Integer	-	段落分け対象文書のトークン

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功

呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "topicSeg": [
            [
                "ノートはどのように作成できますか?",
                "2つの方法があります。"
            ],
            [
                "クローバーノートアプリで追加ボタンをクリックして録音を始めるか、スマートフォンに保存しておいた録音ファイルを呼び出すと、ノートが作成されます。",
                "こうやって作られたノートはアプリだけでなく、PCのクローバーノートのウェブサイトでも連携して確認することができます。",
                "クローバーノートサイトでは、保存した録音ファイルを呼び出すとノートを作成することができます。"
            ],
            [
                "ブックマークの使い方を教えてください。",
                "クローバーノートアプリの画面で録音の途中でブックマークボタンをクリックすると、以下のように表示され、録音を終えた後でも必要な区間を簡単に見つけることができます。",
                "普通録音が終わったら、もう一度探したい録音区間が絶対ありますよね。",
                "そういう時のためにブックマークを提供しています。"
            ],
            [
                "じゃあ、録音した音声はどうすれば聞けますか?",
                "作成されたノートから記録された会話を選択すると、録音した音声をもう一度聞くことができます。",
                "もし音声記録が間違っている区間があれば、もう一度音声を聞いて編集ボタンをクリックして簡単に修正することができます。"
            ]
        ],
        "span": [
            [
                0,
                1
            ],
            [
                2,
                3,
                4
            ],
            [
                5,
                6,
                7,
                8
            ],
            [
                9,
                10,
                11
            ]
        ],
        "inputTokens": 330
    }
}

失敗

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

この記事は役に立ちましたか?

リクエスト
レスポンス
- レスポンスボディ
- レスポンス例