Microsoft Azure :Query Text API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft Cognitive Language Service…
  description: The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.
  version: 2023-04-15-preview
security:
- AADToken:
  - https://cognitiveservices.azure.com/.default
- apim_key: []
tags:
- name: :Query Text
paths:
  /:query-text:
    post:
      summary: Microsoft Azure Answers The Specified Question Using The Provided Text In The…
      operationId: microsoftAzureQuestionansweringGetanswersfromtext
      parameters:
      - $ref: '#/components/parameters/AnswersFromTextOptions'
      - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: A successful response to get answers from input text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnswersFromTextResult'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/SuccessfulQueryText.json
      description: Needs a more full description created.
      tags:
      - :Query Text
components:
  schemas:
    AnswersFromTextResult:
      type: object
      description: Represents the answer results.
      additionalProperties: false
      properties:
        answers:
          type: array
          description: Represents the answer results.
          items:
            $ref: '#/components/schemas/TextAnswer'
    TextDocument:
      type: object
      description: Represent input text record to be queried.
      additionalProperties: false
      required:
      - id
      - text
      properties:
        id:
          type: string
          description: Unique identifier for the text record.
        text:
          type: string
          description: Text contents of the record.
    AnswersFromTextOptions:
      type: object
      description: The question and text record parameters to answer.
      required:
      - question
      - records
      additionalProperties: false
      properties:
        question:
          type: string
          description: User question to query against the given text records.
        records:
          type: array
          x-ms-client-name: textDocuments
          description: Text records to be searched for given question.
          items:
            $ref: '#/components/schemas/TextDocument'
        language:
          $ref: common.json#/definitions/Language
        stringIndexType:
          $ref: common.json#/definitions/StringIndexType
    TextAnswer:
      type: object
      description: Represents answer result.
      additionalProperties: false
      properties:
        answer:
          type: string
          description: Answer.
        confidenceScore:
          type: number
          x-ms-client-name: confidence
          description: answer confidence score, value ranges from 0 to 1.
          format: double
          maximum: 1
          minimum: 0
        id:
          type: string
          description: record ID.
        answerSpan:
          type: object
          x-ms-client-name: shortAnswer
          description: Answer span object with respect to user's question.
          $ref: '#/components/schemas/AnswerSpan'
        offset:
          type: integer
          description: The sentence offset from the start of the document.
          format: int32
        length:
          type: integer
          description: The length of the sentence.
          format: int32
    AnswerSpan:
      type: object
      description: Answer span object of QnA.
      additionalProperties: false
      properties:
        text:
          type: string
          description: Predicted text of answer span.
        confidenceScore:
          type: number
          x-ms-client-name: confidence
          description: Predicted score of answer span, value ranges from 0 to 1.
          format: double
          maximum: 1
          minimum: 0
        offset:
          type: integer
          description: The answer span offset from the start of answer.
          format: int32
        length:
          type: integer
          description: The length of the answer span.
          format: int32
  parameters:
    AnswersFromTextOptions:
      name: textQueryOptions
      in: body
      required: true
      schema:
        $ref: '#/components/schemas/AnswersFromTextOptions'
      description: Post body of the request.
      x-ms-parameter-location: method
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://cognitiveservices.azure.com/.default: https://cognitiveservices.azure.com/.default
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts."
    apim_key:
      type: apiKey
      description: A subscription key for a Language service resource.
      name: Ocp-Apim-Subscription-Key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}/language'
  useSchemePrefix: false
  parameters:
  - $ref: common.json#/parameters/Endpoint