ジャンプ先

• リクエスト
• レスポンス

サマリーの取得

post

/omlmod/v1/cognitive-text/summary

指定されたテキスト文字列のリストのサマリーを返す認識テキスト・エンドポイント。topNのパラメータを入力の一部として渡して、ドキュメントごとに返す文の数を決定できます。デフォルトでは、topNは3に設定されます。コール元は、言語パラメータを渡すこともできます。サマリー内の文は、指定されたテキスト文字列内で出現する順に返されます。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

ソースの表示

• language: string
  使用可能な値: [ "AMERICAN", "SPANISH", "FRENCH", "ITALIAN" ]
• textList(required): array textList
• topN: integer
  最小値: 1

  デフォルト値: 3

{
    "required":[
        "textList"
    ],
    "properties":{
        "textList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "topN":{
            "type":"integer",
            "minimum":1,
            "default":3
        },
        "language":{
            "type":"string",
            "enum":[
                "AMERICAN",
                "SPANISH",
                "FRENCH",
                "ITALIAN"
            ]
        }
    }
}

ネストされたスキーマ : textList

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

重みおよび関連するテキスト文字列を含むサマリーのリスト。

本文()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object SummaryResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SummaryResponse"
    }
}

ネストされたスキーマ : SummaryResponse

型: object

ソースの表示

• summaryResults(required): array summaryResults
• text(required): string

{
    "required":[
        "text",
        "summaryResults"
    ],
    "properties":{
        "text":{
            "type":"string"
        },
        "summaryResults":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SummaryResult"
            }
        }
    }
}

ネストされたスキーマ : summaryResults

型: array

ソースの表示

• 配列: object SummaryResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SummaryResult"
    }
}

ネストされたスキーマ : SummaryResult

型: object

ソースの表示

• sentence(required): string
• weight(required): number (double)

{
    "required":[
        "sentence",
        "weight"
    ],
    "properties":{
        "sentence":{
            "type":"string"
        },
        "weight":{
            "type":"number",
            "format":"double"
        }
    }
}

400レスポンス

不正なリクエストです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

401レスポンス

認可されていません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404レスポンス

リソースが見つかりません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500レスポンス

予期しないエラーです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る