段落分け

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

文章間の類似度を把握してテーマ単位で文章の段落を区切ります。

リクエスト

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

メソッド	URI
POST	/testapp/v1/api-tools/segmentation/{appId}

リクエストヘッダ

ヘッダの説明は次の通りです。

ヘッダ	必須の有無	説明
X-NCP-CLOVASTUDIO-API-KEY	Y	テストアプリの作成時に発行された API KEY
X-NCP-APIGW-API-KEY	Y	テストアプリやサービスアプリの作成時に発行された API Gateway KEY
X-NCP-CLOVASTUDIO-REQUEST-ID	N	各リクエストのリクエスト ID
Content-Type	Y	application/json

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
appId	string	Y	テストアプリ/サービスアプリの固有 ID

リクエストボディ

ボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
texts	array[string]	Y	段落分けを行う対象の文書 1~120,000文字(ハングル基準、スペースを含む)
alpha	float	N	段落分けのための thresholds値。大きいほど分けられる段落数は増える -1.5~1.5、-100(-100入力時、モデルが最適値で段落分けを自動で実行) デフォルト: 0.0
alpha	float	N	段落分けのための thresholds値。大きいほど分けられる段落数は増える -1.5~1.5、-100(-100入力時、モデルが最適値で段落分けを自動で実行) デフォルト: 0.0
segCnt	integer	N	目的の段落分けの数 1以上(-1に設定時、モデルが最適な段落数で分割) デフォルト: -1
postProcess	boolean	N	段落分けの実行後、目的の長さに合わせて段落を結合したり、分割する事後処理を行うかどうか true: postProcess関連のパラメータが動作 false: postProcess関連のパラメータが動作しない(デフォルト)
postProcessMaxSize	integer	N	post process module適用時に段落に含まれる文字列の最大文字数 1以上(デフォルト: 1000)
postProcessMinSize	integer	N	post process module適用時に段落に含まれる文字列の最小文字数 0~postProcessMaxSize(-1入力時、自動で最小単位に設定) デフォルト: 300

リクエスト構文

構文のサンプルコードは次の通りです。

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": "ノートはどのように作成できますか?\n2つの方法があります。\nクローバーノートアプリで追加ボタンをクリックして録音を始めるか、スマートフォンに保存しておいた録音ファイルを呼び出すと、ノートが作成されます。\nこうやって作られたノートはアプリだけでなく、PCのクローバーノートのウェブサイトでも連携して確認することができます。\nクローバーノートサイトでは、保存した録音ファイルを呼び出すとノートを作成することができます。\nブックマークの使い方を教えてください。\nクローバーノートアプリの画面で録音の途中でブックマークボタンをクリックすると、以下のように表示され、録音を終えた後でも必要な区間を簡単に見つけることができます。\n普通録音が終わったら、もう一度探したい録音区間が絶対ありますよね。\nそういう時のためにブックマークを提供しています。\nじゃあ、録音した音声はどうすれば聞けますか?\n作成されたノートから記録された会話を選択すると、録音した音声をもう一度聞くことができます。\nもし音声記録が間違っている区間があれば、もう一度音声を聞いて編集ボタンをクリックして簡単に修正することができます。",
          "alpha": -100,
          "segCnt": -1,
          "postProcess": false,
          "postProcessMaxSize": 2000,
          "postProcessMinSize": 500
}'

レスポンス

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

レスポンスボディ

ボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
topicSeg	array[array[string]]	Y	詳細なテーマ別段落が分けられた結果
span	array[array[integer]]	N	段落が分けられたテキストのインデックス(段落が分けられた位置を確認) デフォルト: []
inputTokens	integer	Y	段落分けを実行した文書のトークン数

レスポンス構文

構文のサンプルコードは次の通りです。

成功

呼び出しに成功した場合の構文例は次の通りです。

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

失敗

呼び出しに失敗した場合の構文例は次の通りです。

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

What's Next

要約

リクエスト
レスポンス