要約
- 印刷する
- PDF
要約
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
様々なオプションを適用して長文を要約します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /testapp/v1/api-tools/summarization/v2/{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 |
リクエストボディ
ボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
texts | array[string] | Y | 要約対象の文章リスト |
autoSentenceSplitter | boolean | N | 要約対象の文章リストの文章の分割を許可するかどうか |
segCount | integer | N | 要約対象の文章リストを分ける段落数 |
segMaxSize | integer | N | 段落分けの際に1つの段落に含まれる最大文字列の文字数 |
postProcess | boolean | N | 段落分けの実行後、目的の長さに合わせて段落を結合したり、分けたりする事後処理を行うかどうか |
segMinSize | integer | N | 段落分けの際に1つの段落に含まれる最大文字列の文字数 |
includeAiFilters | boolean | N | Ai Filterを適用するかどうか(デフォルト: false) |
リクエスト構文
構文のサンプルコードは次の通りです。
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": [
「CLOVA Studioが提供する様々な機能は次の通りです。- 文章生成: いくつかのキーワードを入力するだけで、そのキーワードをもとにシナリオ作成、自己紹介書作成、メール作成、マーケティングのキャッチコピー作成など様々な分野の文章を生成。- 要約: あらすじ、レポート、メールなど、長文から主要な要素を把握して設定した要約文の長さに合わせて文章を要約。- 分類: 文章のタイプ、文書のインデックス、感情、意図などの特徴を分類したり、段落から主要なキーワードを抽出可能。- 会話: 例を入力すると固有のペルソナを持つ AIを生成し、百科事典型チャットボット、カスタムチャットボットなどの会話インターフェースを作成可能。- 文章変換: 入力した例と似たスタイルの文章に文章の形を変換可能な AI Filter: 要注意か安全でない結果が生成されることを検知して通知する AI Filter機能を提供"
],
"autoSentenceSplitter": true,
"segCount": -1,
"segMaxSize": 1000,
"segMinSize": 300,
"includeAiFilters": false
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
ボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
text | string | Y | 要約結果 |
inputTokens | integer | Y | 要約対象の文章の入力時に使用したトークン数 |
レスポンス構文
構文のサンプルコードは次の通りです。
成功
呼び出しに成功した場合の構文例は次の通りです。
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"text": "- CLOVA Studioが提供する様々な機能を説明している",
"inputTokens": 187
}
}
失敗
呼び出しに失敗した場合の構文例は次の通りです。
この記事は役に立ちましたか?