Jump to

• Request
• Response

Get Most Relevant Keywords

post

/omlmod/v1/cognitive-text/keywords

A cognitive text endpoint that returns the most relevant keywords for the provided list of text strings. A parameter of topN can be passed as part of the input to determine how many keywords to return per document. By default, 5 keywords will be returned. Callers can also pass a language parameter. The keywords will be sorted by weight.

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" ]
• textList(required): array textList
• topN: integer
  Minimum Value: 1

  Default Value: 5

{
    "required":[
        "textList"
    ],
    "properties":{
        "textList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "topN":{
            "type":"integer",
            "minimum":1,
            "default":5
        },
        "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

A list of keywords with weights and the associated text strings.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object KeywordResponse

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

Nested Schema : KeywordResponse

Type: object

Show Source

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

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

Nested Schema : keywordResults

Type: array

Show Source

• Array of: object KeywordResult

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

Nested Schema : KeywordResult

Type: object

Show Source

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

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