Jump to

• Request
• Response

Get Semantic Similarities

post

/omlmod/v1/cognitive-text/similarity

A cognitive-text endpoint that returns the semantic similarity between a probe text and a list of text strings. Callers can pass sort direction and a language parameter.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• language: string
  Allowed Values: [ "AMERICAN", "SPANISH", "FRENCH", "ITALIAN" ]
• probe(required): string
• sortDirection: string
  Allowed Values: [ "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"
            ]
        }
    }
}

Nested Schema : textList

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of similarity scores and the associated text strings.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SimilarityResponse

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

Nested Schema : SimilarityResponse

Type: object

Show Source

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

{
    "required":[
        "text",
        "similarity"
    ],
    "properties":{
        "text":{
            "type":"string"
        },
        "similarity":{
            "type":"number",
            "format":"double"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

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

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

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

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

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

404 Response

Resource not found.

Body ()

Root Schema : Error

Type: object

Show Source

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

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

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

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

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

Back to Top