Microsoft Azure Breaksentence API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Breaksentence API
schemes:
- https
tags:
- name: Breaksentence
paths:
  /breaksentence:
    post:
      operationId: microsoftAzureFindsentenceboundaries
      summary: Microsoft Azure Find Sentence Boundaries
      description: Find Sentence Boundaries
      parameters:
      - name: X-ClientTraceId
        in: header
        description: A client-generated GUID to uniquely identify the request.
        required: false
        type: string
        x-ms-client-name: clientTraceId
      - $ref: '#/parameters/BreakSentenceParameters.language'
      - $ref: '#/parameters/BreakSentenceParameters.script'
      - name: api-version
        in: query
        description: Mandatory API version parameter
        required: true
        type: string
        x-ms-client-name: apiVersion
      - name: requestBody
        in: body
        description: Defines the content of the request
        required: true
        schema:
          type: array
          items:
            $ref: '#/definitions/InputTextItem'
          x-ms-identifiers: []
      responses:
        '200':
          description: Response for the Break SEntence API.
          schema:
            type: array
            items:
              $ref: '#/definitions/BreakSentenceItem'
            x-ms-identifiers: []
          headers:
            X-RequestId:
              type: string
              description: Value generated by the service to identify the request. It is used for troubleshooting purposes.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            X-RequestId:
              type: string
              description: Value generated by the service to identify the request. It is used for troubleshooting purposes.
      x-ms-examples:
        Find Sentence Boundaries:
          $ref: ./examples/FindSentenceBoundaries_MaximumSet_Gen.json
        Find Sentence Boundaries with minimum properties:
          $ref: ./examples/FindSentenceBoundaries_MinimumSet_Gen.json
      tags:
      - Breaksentence
  /BreakSentence:
    post:
      description: Identifies the position of sentence boundaries in a piece of text.<br>
      tags:
      - Breaksentence
      operationId: microsoftAzureTranslatorBreaksentence
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - name: Language
        description: Language tag of the language of the input text. If not specified, Translator will apply automatic language detection.
        in: query
        required: false
        type: string
      - name: Script
        description: Script identifier of the script used by the input text. If a script is not specified, the default script of the language will be assumed.
        in: query
        required: false
        type: string
      - name: X-ClientTraceId
        description: A client-generated GUID to uniquely identify the request. Note that you can omit this header if you include the trace ID in the query string using a query parameter named ClientTraceId.
        in: header
        required: false
        type: string
      - name: text
        description: "# Request Body\nThe body of the request is a JSON array. Each array element is a JSON object with a string property named Text. Sentence boundaries are computed for the value of the Text property. \n\nThe following limitations apply:\n* The array can have at most 100 elements.\n* The text value of an array element cannot exceed 10,000 characters including spaces.\n* The entire text included in the request cannot exceed 50,000 characters including spaces.\n* If the `language` query parameter is specified, then all array elements must be in the same language. Otherwise, language auto-detection is applied to each array element independently.\n\n# Response Body\nA successful response is a JSON array with one result for each string in the input array. A result object includes the following properties:\n* `sentLen`- An array of integers representing the lengths of the sentences in the text element. The length of the array is the number of sentences, and the values are the length of each sentence.\n* `detectedLanguage`- An object describing the detected language through the following properties\n  * `language`- Code of the detected language.\n  * `score`- A float value indicating the confidence in the result. The score is between zero and one and a low score indicates a low confidence.\n* Note that the `detectedLanguage` property is only present in the result object when language auto-detection is requested.\n# Response Header\nX-RequestId - Value generated by the service to identify the request. It is used for troubleshooting purposes.\n"
        in: body
        required: true
        schema:
          type: array
          items:
            $ref: '#/definitions/BreakSentenceTextInput'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BreakSentenceResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorMessage'
      x-ms-examples:
        BreakSentence success example:
          $ref: ./examples/breakSentenceSuccess.json
      deprecated: false
      summary: Microsoft Azure Post Breaksentence
definitions:
  ErrorMessage:
    type: object
    properties:
      error:
        type: object
        properties:
          code:
            type: string
          message:
            type: string
  ErrorResponse:
    type: object
    description: Representation of the Error Response from Translator Service.
    properties:
      error:
        $ref: '#/definitions/ErrorDetails'
        description: Error details.
    required:
    - error
  BreakSentenceResult:
    type: array
    description: Example of a successful break sentence request
    items:
      type: object
      properties:
        sentLen:
          type: array
          items:
            type: integer
  ErrorDetails:
    type: object
    description: Error details as returned by Translator Service.
    properties:
      code:
        type: integer
        format: int32
        description: Number identifier of the error.
      message:
        type: string
        description: Human readable error description.
    required:
    - code
    - message
  DetectedLanguage:
    type: object
    description: An object describing the detected language.
    properties:
      language:
        type: string
        description: A string representing the code of the detected language.
      score:
        type: number
        format: float
        description: 'A float value indicating the confidence in the result.

          The score is between zero and one and a low score indicates a low confidence.'
    required:
    - language
    - score
  InputTextItem:
    type: object
    description: Element containing the text for translation.
    properties:
      text:
        type: string
        description: Text to translate.
    required:
    - text
  BreakSentenceItem:
    type: object
    description: Item containing break sentence result.
    properties:
      detectedLanguage:
        $ref: '#/definitions/DetectedLanguage'
        description: The detectedLanguage property is only present in the result object when language auto-detection is requested.
      sentLen:
        type: array
        description: 'An integer array representing the lengths of the sentences in the input text.

          The length of the array is the number of sentences, and the values are the length of each sentence.'
        items:
          type: integer
          format: int32
    required:
    - sentLen
  BreakSentenceTextInput:
    type: object
    description: Text needed for break sentence request
    properties:
      text:
        type: string
        maximum: 10000
    example:
      text: Today is a good day.
parameters:
  BreakSentenceParameters.language:
    name: language
    in: query
    description: "Language tag identifying the language of the input text. \nIf a code isn't specified, automatic language detection will be applied."
    required: false
    type: string
    x-ms-parameter-location: method
  ApiVersion:
    name: api-version
    description: Version of the API requested by the client. Value must be **3.0**.
    in: query
    required: true
    type: string
    default: '3.0'
  BreakSentenceParameters.script:
    name: script
    in: query
    description: "Script tag identifying the script used by the input text. \nIf a script isn't specified, the default script of the language will be assumed."
    required: false
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'