swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector :Query Text API
schemes:
- https
tags:
- name: :Query Text
paths:
  /:query-text:
    post:
      summary: Microsoft Azure Answers The Specified Question Using The Provided Text In The Body
      operationId: microsoftAzureQuestionansweringGetanswersfromtext
      parameters:
      - $ref: '#/parameters/AnswersFromTextOptions'
      - $ref: common.json#/parameters/ApiVersionParameter
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: A successful response to get answers from input text.
          schema:
            $ref: '#/definitions/AnswersFromTextResult'
        default:
          description: Error response.
          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
definitions:
  AnswersFromTextResult:
    type: object
    description: Represents the answer results.
    additionalProperties: false
    properties:
      answers:
        type: array
        description: Represents the answer results.
        items:
          $ref: '#/definitions/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.
  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: '#/definitions/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
  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: '#/definitions/TextDocument'
      language:
        $ref: common.json#/definitions/Language
      stringIndexType:
        $ref: common.json#/definitions/StringIndexType
parameters:
  AnswersFromTextOptions:
    name: textQueryOptions
    in: body
    required: true
    schema:
      $ref: '#/definitions/AnswersFromTextOptions'
    x-nullable: true
    description: Post body of the request.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'