Microsoft Azure Dictionary/Lookup API

openapi: 3.2.0
info:
  version: '3.0'
  title: Microsoft Azure Translator Text Client Dictionary/Lookup API
  termsOfService: http://www.microsoftvolumelicensing.com/DocumentSearch.aspx?Mode=3&DocumentTypeId=31
  contact:
    name: Microsoft Translator team
    email: translator@microsoft.com
    url: https://www.microsoft.com/translator
  description: '# Introduction


    The Microsoft Translator Text API provides a JSON-based Web API. It provides:


    * Translation between any supported languages to any other supported language. * Translation to multiple languages in one request. * Transliteration to convert text from one script to another script of the same language. * Language detection, translation, and transliteration in one request. * Dictionary to lookup alternative translations of a term, to find back-translations and examples showing terms used in context. * Rich language detection. # Base URLs


    The Translator Text API is available in the following clouds:


    | Description | Region | Base URL |

    | ------- | -------- | ------- |

    | Azure | Global | api.cognitive.microsofttranslator.com |

    | Azure | Europe | api-eur.cognitive.microsofttranslator.com |


    # Authentication


    Subscribe to the Translator Text API, part of Azure Cognitive Services, and use your subscription key from the Azure portal to authenticate. You can follow the steps in https://docs.microsoft.com/en-us/azure/cognitive-services/translator/translator-text-how-to-signup. The simplest way is to pass your Azure secret key to the Translator service using the http request header `Ocp-Apim-Subscription-Key`. If you prefer using a short-lived authentication, you may use your secret key to obtain an authorization token from the token service. In that case you pass the authorization token to the Translator service using the `Authorization` request header. To obtain an authorization token, make a `POST` request to the following URL:


    | Environment | Authentication service URL |

    | ---------- | ---------- |

    | Azure | `https://api.cognitive.microsoft.com/sts/v1.0/issueToken` |


    Here are example requests to obtain a token with a lifetime of 10 minutes, given a secret key:


    ```python

    // Pass secret key using header

    curl --header ''Ocp-Apim-Subscription-Key: '' --data "" ''https://api.cognitive.microsoft.com/sts/v1.0/issueToken''

    // Pass secret key using query string parameter

    curl --data "" ''https://api.cognitive.microsoft.com/sts/v1.0/issueToken?Subscription-Key=''

    ```


    A successful request returns the encoded access token as plain text in the response body. The valid token is passed to the Translator service as a bearer token in the Authorization. ```

    Authorization: Bearer

    ```


    An authentication token is valid for 10 minutes. The token should be re-used when making multiple calls to the Translator APIs. If you make requests to the Translator API over an extended period of time, you must request a new access token at regular intervals before the token expires, for instance every 9 minutes. To summarize, a client request to the Translator API will include one authorization header taken from the following table:


    | Headers | Description |

    | ---------- | ---------- |

    | Ocp-Apim-Subscription-key | Use with Cognitive Services subscription if you are passing your secret key. The value is the Azure secret key for your subscription to Translator Text API. |

    | Authorization | Use with Cognitive Services subscription if you are passing an authentication token. The value is the Bearer token: `Bearer `. |


    ## All-in-one subscription

    The last authentication option is to use a Cognitive Service’s all-in-one subscription. This allows you to use a single secret key to authenticate requests for multiple services. When you use an all-in-one secret key, you must include two authentication headers with your request. The first passes the secret key, the second specifies the region associated with your subscription. `Ocp-Api-Subscription-Key` `Ocp-Apim-Subscription-Region`

    If you pass the secret key in the query string with the parameter `Subscription-Key`, then you must specify the region with query parameter `Subscription-Region`. If you use a bearer token, you must obtain the token from the region endpoint:

    `https://.api.cognitive.microsoft.com/sts/v1.0/issueToken`.'
servers:
- url: https://api.cognitive.microsofttranslator.com
security:
- apim_key: []
- api_key_all_in_one: []
- api_region_all_in_one: []
tags:
- name: Dictionary/Lookup
paths:
  /Dictionary/Lookup:
    post:
      description: Provides alternative translations for a word and a small number of idiomatic phrases. Each translation has a `part-of-speech` and a list of `back-translations`. The back-translations enable a user to understand the translation in context. The Dictionary Example operation allows further drill down to see example uses of each translation pair.
      tags:
      - Dictionary/Lookup
      operationId: microsoftAzureTranslatorDictionarylookup
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - name: from
        description: Specifies the language of the input text. The source language must be one of the supported languages included in the `dictionary` scope.
        in: query
        required: true
        schema:
          type: string
      - name: to
        description: Specifies the language of the output text. The target language must be one of the supported languages included in the `dictionary` scope of the Languages resource.
        in: query
        required: true
        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/DictionaryLookupResult'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      x-ms-examples:
        DictionaryLookup success example:
          $ref: ./examples/dictionaryLookupSuccess.json
      deprecated: false
      summary: Microsoft Azure Post Dictionary Lookup
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/DictionaryLookupTextInput'
        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`, which represents the term to lookup.\nThe following limitations apply:\n* The array can have at most 10 elements.\n* The text value of an array element cannot exceed 100 characters including spaces.\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* `normalizedSource`- A string giving the normalized form of the source term. For example, if the request is \"JOHN\", the normalized form will be \"john\". The content of this field becomes the input to lookup examples.\n* `displaySource`- A string giving the source term in a form best suited for end-user display. For example, if the input is \"JOHN\", the display form will reflect the usual spelling of the name- \"John\".\n* `translations`- A list of translations for the source term. Each element of the list is an object with the following properties:\n  * `normalizedTarget`- A string giving the normalized form of this term in the target language. This value should be used as input to lookup examples.\n  * `displayTarget`- A string giving the term in the target language and in a form best suited for end-user display. Generally, this will only differ from the `normalizedTarget` in terms of capitalization. For example, a proper noun like \"Juan\" will have `normalizedTarget = \"juan\"` and `displayTarget = \"Juan\"`.\n  * `posTag`- A string associating this term with a part-of-speech tag.\n  \n  | Tag name  | Description       |\n  | --------- | ----------------  |\n  | ADJ       | Adjectives        |\n  | ADV       | Adverbs           |\n  | CONJ      | Conjunctions       |\n  | DET       | Determiners       |\n  | MODAL     | Verbs             |\n  | NOUN      | Nouns             |\n  | PREP      | Prepositions      |\n  | PRON      | Pronouns          |\n  | VERB      | Verbs             |\n  | OTHER     | Other             |\n  \n  As an implementation note, these tags were determined by part-of-speech tagging the English side, and then taking the most frequent tag for each source/target pair. So if people frequently translate a Spanish word to a different part-of-speech tag in English, tags may end up being wrong (with respect to the Spanish word).\n    * `confidence`- A value between 0.0 and 1.0 which represents the \"confidence\" (or perhaps more accurately, \"probability in the training data\") of that translation pair. The sum of confidence scores for one source word may or may not sum to 1.0.\n    * `prefixWord-` A string giving the word to display as a prefix of the translation. Currently, this is the gendered determiner of nouns, in languages that have gendered determiners. For example, the prefix of the Spanish word \"mosca\" is \"la\", since \"mosca\" is a feminine noun in Spanish. This is only dependent on the translation, and not on the source. If there is no prefix, it will be the empty string.\n    * `backTranslations-` A list of \"back translations\" of the target. For example, source words that the target can translate to. The list is guaranteed to contain the source word that was requested (e.g., if the source word being looked up is \"fly\", then it is guaranteed that \"fly\" will be in the `backTranslations` list). However, it is not guaranteed to be in the first position, and often will not be. Each element of the `backTranslations` list is an object described by the following properties-\n      * `normalizedText-` A string giving the normalized form of the source term that is a back-translation of the target. This value should be used as input to lookup examples.\n      * `displayText-` A string giving the source term that is a back-translation of the target in a form best suited for end-user display.\n      * `numExamples-` An integer representing the number of examples that are available for this translation pair. Actual examples must be retrieved with a separate call to lookup examples. The number is mostly intended to facilitate display in a UX. For example, a user interface may add a hyperlink to the back-translation if the number of examples is greater than zero and show the back-translation as plain text if there are no examples. Note that the actual number of examples returned by a call to lookup examples may be less than `numExamples`, because additional filtering may be applied on the fly to remove \"bad\" examples.\n      * `frequencyCount-` An integer representing the frequency of this translation pair in the data. The main purpose of this field is to provide a user interface with a means to sort back-translations so the most frequent terms are first.\n      \nNote - If the term being looked up does not exist in the dictionary, the response is 200 (OK) but the `translations` list is an empty list.\n  \n# Response Header\nX-RequestId - Value generated by the service to identify the request. It is used for troubleshooting purposes.\n"
        required: true
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    DictionaryLookupResult:
      type: array
      description: Example of a successful dictionary lookup request
      items:
        type: object
        properties:
          normalizedSource:
            type: string
          displaySource:
            type: string
          translations:
            type: array
            items:
              type: object
              properties:
                normalizedTarget:
                  type: string
                displayTarget:
                  type: string
                posTag:
                  type: string
                confidence:
                  type: number
                prefixWord:
                  type: string
                backTranslations:
                  type: array
                  items:
                    type: object
                    properties:
                      normalizedText:
                        type: string
                      displayText:
                        type: string
                      numExamples:
                        type: integer
                      frequencyCount:
                        type: integer
    DictionaryLookupTextInput:
      type: object
      description: 'Text needed for a dictionary lookup request '
      properties:
        text:
          type: string
          maximum: 100
      example:
        text: Bug
  parameters:
    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-ms-parameterized-host:
  hostTemplate: '{Endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'