要約

Prev Next

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

さまざまなオプションを適用して長文を要約します。

リクエスト

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

メソッド URI
POST /v1/api-tools/summarization/v2

リクエストヘッダ

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
texts Array Required 要約対象の文書
  • 1~35,000文字(ハングル基準、スペースを含む)
autoSentenceSplitter Boolean Optional 要約対象文章の段落分けを許可するかどうか
  • true(デフォルト) | false
    • true: 段落分けとsegCount、segMaxSize、segMinSizeを適用
    • false: 段落分けしない
segCount Integer Optional 要約対象文章の段落分け数
  • -1(デフォルト) | 1以上
    • -1: モデルが最適値で自動実行
segMaxSize Integer Optional 段落分け後段落の最大文字数
  • 1~3,000文字(ハングル基準、スペースを含む) (デフォルト: 1,000)
segMinSize Integer Optional 段落分け後段落の最小文字数
  • 0~segMaxSizeの値(デフォルト: 300)
includeAiFilters Boolean Optional AIフィルタを適用するかどうか
  • true | false(デフォルト)
    • true: 適用
    • false: 適用しない

リクエスト例

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

curl --location --request POST 'https://clovastudio.stream.ntruss.com/v1/api-tools/summarization/v2' \
--header 'Authorization: Bearer {API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
            "texts": [
                「CLOVA Studioが提供するさまざまな機能は次の通りです。- 文章生成: いくつかのキーワードを入力するだけで、そのキーワードをもとにシナリオ作成、自己紹介書作成、メール作成、マーケティングのキャッチコピー作成などさまざまな分野の文章を生成。- 要約: あらすじ、レポート、メールなど、長文から主要な要素を把握して設定した要約文の長さに合わせて文章を要約。- 分類: 文章のタイプ、文書のインデックス、感情、意図などの特徴を分類したり、段落から主要なキーワードを抽出可能。- 会話: 例を入力すると固有のペルソナを持つ AIを生成し、百科事典型チャットボット、カスタムチャットボットなどの会話インターフェースを作成可能。- 文章変換: 入力した例と似たスタイルの文章に文章の形を変換可能な AI Filter: 要注意か安全でない結果が生成されることを検知して通知する AI Filter機能を提供"
            ],
            "autoSentenceSplitter": true,
            "segCount": -1,
            "segMaxSize": 1000,
            "segMinSize": 300,
            "includeAiFilters": false
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
text String - 要約結果
inputTokens Integer - 要約対象文章のトークン数

レスポンス例

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

成功

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

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "text": "- CLOVA Studioが提供するさまざまな機能を説明している",
        "inputTokens": 187
    }
}

失敗

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