Microsoft Azure Breaksentence API

openapi: 3.2.0
info:
  title: Microsoft Azure Breaksentence API
  version: '3.0'
  x-refined-note:
  - x-typespec-generated differs across the merged source definitions and was not carried
  description: 'Operations tagged Breaksentence across 2 of this provider''s published API definitions: text-translation-openapi-original.yml, translator-text-client-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.cognitive.microsofttranslator.com
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
        x-ms-client-name: clientTraceId
        schema:
          type: string
      - $ref: '#/components/parameters/BreakSentenceParameters.language'
      - $ref: '#/components/parameters/BreakSentenceParameters.script'
      - name: api-version
        in: query
        description: Mandatory API version parameter
        required: true
        x-ms-client-name: apiVersion
        schema:
          type: string
      responses:
        '200':
          description: Response for the Break SEntence API.
          headers:
            X-RequestId:
              description: Value generated by the service to identify the request. It is used for troubleshooting purposes.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BreakSentenceItem'
                x-ms-identifiers: []
        default:
          description: An unexpected error response.
          headers:
            X-RequestId:
              description: Value generated by the service to identify the request. It is used for troubleshooting purposes.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InputTextItem'
              x-ms-identifiers: []
        description: Defines the content of the request
        required: true
  /BreakSentence:
    post:
      description: Identifies the position of sentence boundaries in a piece of text.
      tags:
      - Breaksentence
      operationId: microsoftAzureTranslatorBreaksentence
      parameters:
      - $ref: '#/components/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
        schema:
          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
        schema:
          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
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BreakSentenceResult'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      x-ms-examples:
        BreakSentence success example:
          $ref: ./examples/breakSentenceSuccess.json
      deprecated: false
      summary: Microsoft Azure Post Breaksentence
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BreakSentenceTextInput'
        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"
        required: true
      security:
      - apim_key: []
      - api_key_all_in_one: []
      - api_region_all_in_one: []
    servers:
    - url: https://api.cognitive.microsofttranslator.com
components:
  schemas:
    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
    ErrorResponse:
      type: object
      description: Representation of the Error Response from Translator Service.
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetails'
          description: Error details.
      required:
      - error
    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: '#/components/schemas/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
    ErrorMessage:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    BreakSentenceResult:
      type: array
      description: Example of a successful break sentence request
      items:
        type: object
        properties:
          sentLen:
            type: array
            items:
              type: integer
    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
      x-ms-parameter-location: method
      schema:
        type: string
    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
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersion:
      name: api-version
      description: Version of the API requested by the client. Value must be **3.0**.
      in: query
      required: true
      schema:
        type: string
        default: '3.0'
  securitySchemes:
    apim_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    api_key_all_in_one:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    api_region_all_in_one:
      type: apiKey
      name: Ocp-Apim-Subscription-Region
      in: header
x-refined-from:
- text-translation-openapi-original.yml
- translator-text-client-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'