Jump to

• Request
• Response

Get Summaries

post

/omlmod/v1/cognitive-text/summary

A cognitive text endpoint that returns summaries for the provided list of text strings. A parameter of topN can be passed as part of the input to determine how many sentences to return per document. By default, topN is set to be 3. Callers can also pass a language parameter. The sentences in the summaries are returned in order of occurrence in the provided text strings.

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: 3

{
    "required":[
        "textList"
    ],
    "properties":{
        "textList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "topN":{
            "type":"integer",
            "minimum":1,
            "default":3
        },
        "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 summaries with weights and the associated text strings.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SummaryResponse

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

Nested Schema : SummaryResponse

Type: object

Show Source

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

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

Nested Schema : summaryResults

Type: array

Show Source

• Array of: object SummaryResult

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

Nested Schema : SummaryResult

Type: object

Show Source

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

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