ジャンプ先

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

最も関連性の高いトピックの取得

post

/omlmod/v1/cognitive-text/topics

指定されたテキスト文字列のリストに最も関連性の高いトピックを返す認識テキスト・エンドポイント。topNのパラメータを入力の一部として渡して、返すトピック数を決定できます。デフォルトでは、2つのトピックが返されます。コール元は、言語パラメータを渡すこともできます。トピックは重みでソートされます。

リクエスト

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

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

• application/json

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

ルート・スキーマ : schema

型: object

ソースの表示

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

  デフォルト値: 2

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

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

型: array

ソースの表示

• 配列: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

重みおよび関連するテキスト文字列を含むトピックのリスト。

本文()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object TopicResponse

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

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

型: object

ソースの表示

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

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

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

型: array

ソースの表示

• 配列: object TopicResult

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

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

型: object

ソースの表示

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

{
    "required":[
        "topic",
        "weight"
    ],
    "properties":{
        "topic":{
            "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"
        }
    }
}

先頭に戻る