Jump to

• Request
• Response

Get Sentiments

post

/omlmod/v1/cognitive-text/sentiment

A cognitive-text endpoint that returns the sentiment for the given list of text strings. A sentiment is an enumerated type with values (positive, neutral, negative).

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

• textList(required): array textList

{
    "required":[
        "textList"
    ],
    "properties":{
        "textList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

Sentiment predictions and the associated text strings.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SentimentResponse

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

Nested Schema : SentimentResponse

Type: object

Show Source

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

{
    "required":[
        "text",
        "sentimentResults"
    ],
    "properties":{
        "text":{
            "type":"string"
        },
        "sentimentResults":{
            "type":"array",
            "minimum":3,
            "maximum":3,
            "items":{
                "$ref":"#/components/schemas/SentimentResult"
            }
        }
    }
}

Nested Schema : sentimentResults

Type: array

Minimum Value: 3

Maximum Value: 3

Show Source

• Array of: object SentimentResult

{
    "type":"array",
    "minimum":3,
    "maximum":3,
    "items":{
        "$ref":"#/components/schemas/SentimentResult"
    }
}

Nested Schema : SentimentResult

Type: object

Show Source

• confidence(required): number (double)
• sentiment(required): string
  Allowed Values: [ "positive", "neutral", "negative" ]

{
    "required":[
        "sentiment",
        "confidence"
    ],
    "properties":{
        "sentiment":{
            "type":"string",
            "enum":[
                "positive",
                "neutral",
                "negative"
            ]
        },
        "confidence":{
            "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