ジャンプ先

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

意味的類似度の取得

post

/omlmod/v1/cognitive-text/similarity

プローブ・テキストとテキスト文字列のリストとの間の意味的類似度を返す認識テキスト・エンドポイント。コール元は、ソート方向と言語パラメータを渡すことができます。

リクエスト

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

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

• application/json

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

ルート・スキーマ : schema

型: object

ソースの表示

• language: string
  使用可能な値: [ "AMERICAN", "SPANISH", "FRENCH", "ITALIAN" ]
• probe(required): string
• sortDirection: string
  使用可能な値: [ "ASC", "DESC" ]
• textList(required): array textList

{
    "required":[
        "probe",
        "textList"
    ],
    "properties":{
        "textList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "probe":{
            "type":"string"
        },
        "sortDirection":{
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ]
        },
        "language":{
            "type":"string",
            "enum":[
                "AMERICAN",
                "SPANISH",
                "FRENCH",
                "ITALIAN"
            ]
        }
    }
}

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

型: array

ソースの表示

• 配列: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

類似度スコアおよび関連するテキスト文字列のリスト。

本文()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object SimilarityResponse

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

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

型: object

ソースの表示

• similarity(required): number (double)
• text(required): string

{
    "required":[
        "text",
        "similarity"
    ],
    "properties":{
        "text":{
            "type":"string"
        },
        "similarity":{
            "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"
        }
    }
}

先頭に戻る