swagger: '2.0'
info:
  title: Microsoft Azure Microsoft Cognitive Language Service - Question Answering - Authoring
  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 <a
    href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview">https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview</a>.
  version: 2023-04-15-preview
securityDefinitions:
  AADToken:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    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.


      To 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.


      #### Notes

      * 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).

      * 

      The `Authorization URL` is specific to the Azure public cloud instance.
      Sovereign clouds have unique Authorization URLs and Azure Active directory
      configurations. 

      * 

      The 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.

      * 

      Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for
      configuration based setup of an application for multiple use cases.

      * 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.
    scopes:
      https://cognitiveservices.azure.com/.default: https://cognitiveservices.azure.com/.default
  apim_key:
    type: apiKey
    description: A subscription key for a Language service resource.
    name: Ocp-Apim-Subscription-Key
    in: header
security:
  - AADToken:
      - https://cognitiveservices.azure.com/.default
  - apim_key: []
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}/language'
  useSchemePrefix: false
  parameters:
    - $ref: common.json#/parameters/Endpoint
paths:
  /authoring/query-knowledgebases/projects:
    get:
      summary: 'Microsoft Azure Gets All Projects For A User'
      operationId: microsoftAzureQuestionansweringprojectsListprojects
      parameters:
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
      consumes:
        - application/json
      produces:
        - application/json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      responses:
        '200':
          description: The metadata of all projects.
          schema:
            $ref: '#/definitions/ProjectsMetadata'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}:
    get:
      summary: 'Microsoft Azure Get The Requested Project Metadata'
      operationId: microsoftAzureQuestionansweringprojectsGetprojectdetails
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: The metadata for the specified project.
          schema:
            $ref: '#/definitions/ProjectMetadata'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulGetProject.json
      description: Needs a more full description created.
      tags:
        - Authoring
    patch:
      summary: 'Microsoft Azure Create Or Update A Project'
      operationId: microsoftAzureQuestionansweringprojectsCreateproject
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - description: Parameters needed to create the project.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/CreateProjectOptions'
        - $ref: common.json#/parameters/ApiVersionParameter
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: The metadata of the updated project, if it already exists.
          schema:
            $ref: '#/definitions/ProjectMetadata'
        '201':
          description: The metadata of the created project, if it doesn't exist.
          schema:
            $ref: '#/definitions/ProjectMetadata'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulCreateProject.json
      description: Needs a more full description created.
      tags:
        - Authoring
    delete:
      summary: 'Microsoft Azure Delete The Project'
      operationId: microsoftAzureQuestionansweringprojectsDeleteproject
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            Operation-Location:
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulDeleteProject.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/deletion-jobs/{jobId}:
    get:
      summary: 'Microsoft Azure Gets The Status Of A Project Delete Job'
      operationId: microsoftAzureQuestionansweringprojectsGetdeletestatus
      parameters:
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/JobIdParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Project delete job status.
          schema:
            $ref: '#/definitions/JobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/:export:
    post:
      summary: 'Microsoft Azure Export Project Metadata And Assets'
      operationId: microsoftAzureQuestionansweringprojectsExport
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/ImportExportFormatParameter'
        - $ref: '#/parameters/AssetKindParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Export job status, project metadata, and assets.
          schema:
            $ref: '#/definitions/ExportJobState'
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            Operation-Location:
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}:
    get:
      summary: >-
        Microsoft Azure Gets The Status Of An Export Job, Once Job Completes, Returns The Project Metadata, And Assets
      operationId: microsoftAzureQuestionansweringprojectsGetexportstatus
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/JobIdParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Export job status, project metadata, and assets.
          schema:
            $ref: '#/definitions/ExportJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/:import:
    post:
      summary: 'Microsoft Azure Import Project Assets'
      operationId: microsoftAzureQuestionansweringprojectsImport
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - description: Project assets the needs to be imported.
          in: body
          name: body
          schema:
            $ref: '#/definitions/ImportJobOptions'
        - $ref: '#/parameters/ImportExportFormatParameter'
        - $ref: '#/parameters/AssetKindParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            Operation-Location:
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}:
    get:
      summary: 'Microsoft Azure Gets The Status Of An Import Job'
      operationId: microsoftAzureQuestionansweringprojectsGetimportstatus
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/JobIdParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Import job status.
          schema:
            $ref: '#/definitions/JobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}:
    put:
      summary: 'Microsoft Azure Deploy Project To Production'
      operationId: microsoftAzureQuestionansweringprojectsDeployproject
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            Operation-Location:
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}:
    get:
      summary: 'Microsoft Azure Gets The Status Of A Deploy Job'
      operationId: microsoftAzureQuestionansweringprojectsGetdeploystatus
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/JobIdParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Deploy job state.
          schema:
            $ref: '#/definitions/JobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/deployments:
    get:
      summary: 'Microsoft Azure List All Deployments Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsListdeployments
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
      consumes:
        - application/json
      produces:
        - application/json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      responses:
        '200':
          description: List of deployments of a project.
          schema:
            $ref: '#/definitions/ProjectDeployments'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/synonyms:
    get:
      summary: 'Microsoft Azure Gets All The Synonyms Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsGetsynonyms
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
      consumes:
        - application/json
      produces:
        - application/json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      responses:
        '200':
          description: All the synonyms of a project.
          schema:
            $ref: '#/definitions/SynonymAssets'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulGetSynonyms.json
      description: Needs a more full description created.
      tags:
        - Authoring
    put:
      summary: 'Microsoft Azure Updates All The Synonyms Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsUpdatesynonyms
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - description: All the synonyms of a project.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/SynonymAssets'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '204':
          description: Synonyms update successfully.
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/sources:
    get:
      summary: 'Microsoft Azure Gets All The Sources Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsGetsources
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
      consumes:
        - application/json
      produces:
        - application/json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      responses:
        '200':
          description: All the sources of a project.
          schema:
            $ref: '#/definitions/QnaSources'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulGetSources.json
      description: Needs a more full description created.
      tags:
        - Authoring
    patch:
      summary: 'Microsoft Azure Updates The Sources Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsUpdatesources
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - description: Update sources parameters of a project.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/UpdateSourcesOptions'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            Operation-Location:
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulUpdateSources.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}:
    get:
      summary: 'Microsoft Azure Gets The Status Of Update Sources Job'
      operationId: microsoftAzureQuestionansweringprojectsGetupdatesourcesstatus
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/JobIdParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Update sources job state.
          schema:
            $ref: '#/definitions/JobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/qnas:
    get:
      summary: 'Microsoft Azure Gets All The Qnas Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsGetqnas
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/SourceFilterParameter'
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
      consumes:
        - application/json
      produces:
        - application/json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      responses:
        '200':
          description: All the QnAs of a project.
          schema:
            $ref: '#/definitions/QnaAssets'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulGetQnas.json
      description: Needs a more full description created.
      tags:
        - Authoring
    patch:
      summary: 'Microsoft Azure Updates The Qnas Of A Project'
      operationId: microsoftAzureQuestionansweringprojectsUpdateqnas
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - description: Update QnAs parameters of a project.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/UpdateQnaOptions'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            Operation-Location:
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: ./examples/questionanswering/authoring/SuccessfulUpdateQnas.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}:
    get:
      summary: 'Microsoft Azure Gets The Status Of Update Qnas Job'
      operationId: microsoftAzureQuestionansweringprojectsGetupdateqnasstatus
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/JobIdParameter'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Update QnAs job state.
          schema:
            $ref: '#/definitions/JobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json
      description: Needs a more full description created.
      tags:
        - Authoring
  /authoring/query-knowledgebases/projects/{projectName}/feedback:
    post:
      summary: 'Microsoft Azure Update Active Learning Feedback'
      operationId: microsoftAzureQuestionansweringprojectsAddfeedback
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
        - description: Feedback for Active Learning.
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/ActiveLearningFeedback'
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '204':
          description: Feedback recorded successfully.
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful query:
          $ref: >-
            ./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json
      description: Needs a more full description created.
      tags:
        - Authoring
definitions:
  ActiveLearningFeedback:
    type: object
    description: Feedback for Active Learning.
    additionalProperties: false
    properties:
      records:
        $ref: '#/definitions/FeedbackRecords'
  FeedbackRecords:
    type: array
    description: A list of Feedback Records for Active Learning.
    additionalProperties: false
    items:
      $ref: '#/definitions/FeedbackRecord'
  FeedbackRecord:
    type: object
    description: Feedback Record for Active Learning.
    additionalProperties: false
    properties:
      userId:
        type: string
        description: Unique identifier of the user.
      userQuestion:
        type: string
        description: User suggested question for the QnA.
      qnaId:
        type: integer
        description: Unique ID of the QnA.
        format: int32
  ProjectsMetadata:
    type: object
    description: Collection of projects metadata and global settings.
    additionalProperties: false
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ProjectMetadata'
      nextLink:
        type: string
  ProjectMetadata:
    type: object
    description: Represents the project.
    additionalProperties: false
    properties:
      projectName:
        type: string
        description: Name of the project.
      description:
        type: string
        description: Description of the project.
      language:
        $ref: common.json#/definitions/Language
      multilingualResource:
        type: boolean
        description: Resource enabled for multiple languages across projects or not.
      settings:
        $ref: '#/definitions/ProjectSettings'
      createdDateTime:
        type: string
        description: Project creation date-time.
        format: date-time
      lastModifiedDateTime:
        type: string
        description: Represents the project last modified date-time.
        format: date-time
      lastDeployedDateTime:
        type: string
        description: Represents the project last deployment date-time.
        format: date-time
  CreateProjectOptions:
    type: object
    description: Parameters needed to create the project.
    additionalProperties: false
    required:
      - language
    properties:
      description:
        type: string
        description: Description of the project.
      language:
        $ref: common.json#/definitions/Language
      multilingualResource:
        type: boolean
        description: >-
          Set to true to enable creating knowledgebases in different languages
          for the same resource.
      settings:
        $ref: '#/definitions/ProjectSettings'
  ProjectSettings:
    type: object
    description: Configurable settings of the Project.
    additionalProperties: false
    properties:
      defaultAnswer:
        type: string
        description: >-
          Default Answer response when no good match is found in the knowledge
          base.
  ImportJobOptions:
    type: object
    description: Project assets the needs to be imported.
    additionalProperties: false
    properties:
      metadata:
        $ref: '#/definitions/CreateProjectOptions'
      assets:
        $ref: '#/definitions/Assets'
      fileUri:
        type: string
        description: Import data File URI.
  JobMetadata:
    description: Represents the job metadata.
    properties:
      createdDateTime:
        format: date-time
        type: string
      expirationDateTime:
        format: date-time
        type: string
      jobId:
        type: string
      lastUpdatedDateTime:
        format: date-time
        type: string
      status:
        $ref: '#/definitions/JobStatus'
    required:
      - jobId
      - lastUpdatedDateTime
      - createdDateTime
      - status
    type: object
  JobStatus:
    description: Job Status.
    enum:
      - notStarted
      - running
      - succeeded
      - failed
      - cancelled
      - cancelling
      - partiallyCompleted
    type: string
    x-ms-enum:
      modelAsString: true
      name: jobStatus
  JobState:
    description: Job state represents the job metadata and any errors.
    allOf:
      - $ref: '#/definitions/JobMetadata'
      - $ref: '#/definitions/Errors'
  Errors:
    description: Collection of Error types.
    type: object
    properties:
      errors:
        type: array
        items:
          $ref: common.json#/definitions/Error
  ExportJobState:
    description: Export job status, project metadata, and assets.
    allOf:
      - $ref: '#/definitions/JobState'
      - $ref: '#/definitions/ExportJobResultUrl'
  ExportJobResultUrl:
    type: object
    description: URL to download the result of the Export Job.
    required:
      - resultUrl
    properties:
      resultUrl:
        type: string
        description: URL to download the result of the Export Job.
  Assets:
    type: object
    description: All assets for this project.
    additionalProperties: false
    properties:
      synonyms:
        $ref: '#/definitions/SynonymAsset'
      qnas:
        $ref: '#/definitions/ImportQnaAsset'
  SynonymAssets:
    type: object
    description: All synonym assets for this project.
    additionalProperties: false
    properties:
      value:
        $ref: '#/definitions/SynonymAsset'
      nextLink:
        type: string
  SynonymAsset:
    type: array
    description: Collection of synonyms.
    additionalProperties: false
    maxLength: 10000
    items:
      $ref: '#/definitions/WordAlterations'
  WordAlterations:
    type: object
    description: Collection of word alterations.
    additionalProperties: false
    required:
      - alterations
    properties:
      alterations:
        type: array
        description: Collection of word alterations.
        maxLength: 20
        items:
          type: string
  QnaAssets:
    type: object
    description: All QnA assets for the project.
    additionalProperties: false
    properties:
      value:
        $ref: '#/definitions/QnaAsset'
      nextLink:
        type: string
  ImportQnaAsset:
    type: array
    description: List of QnA records to import.
    additionalProperties: false
    items:
      $ref: '#/definitions/ImportQnaRecord'
  QnaAsset:
    type: array
    description: List of QnA records.
    additionalProperties: false
    items:
      $ref: '#/definitions/RetrieveQnaRecord'
  QnaRecord:
    type: object
    description: QnA record.
    additionalProperties: false
    properties:
      id:
        type: integer
        description: Unique ID for the QnA.
        format: int32
      answer:
        type: string
        description: Answer text.
        maxLength: 25000
        minLength: 1
      source:
        type: string
        description: >-
          Source from which QnA was indexed e.g.
          https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs
          .
        maxLength: 300
      questions:
        type: array
        description: List of questions associated with the answer.
        maxLength: 100
        minLength: 1
        items:
          type: string
      metadata:
        type: object
        description: >-
          Metadata associated with the answer, useful to categorize or filter
          question answers.
        additionalProperties:
          type: string
      dialog:
        description: Context of a QnA.
        $ref: '#/definitions/QnaDialog'
      activeLearningSuggestions:
        type: array
        description: List of Active Learning suggestions for the QnA.
        items:
          $ref: '#/definitions/SuggestedQuestionsCluster'
  SuggestedQuestionsCluster:
    type: object
    description: Active Learning suggested questions cluster details.
    additionalProperties: false
    properties:
      clusterHead:
        type: string
        description: >-
          Question chosen as the head of suggested questions cluster by Active
          Learning clustering algorithm.
      suggestedQuestions:
        type: array
        description: List of all suggested questions for the QnA.
        items:
          $ref: '#/definitions/SuggestedQuestion'
  SuggestedQuestion:
    type: object
    description: Question suggested by the Active Learning feature.
    additionalProperties: false
    properties:
      question:
        type: string
        description: Question suggested by the Active Learning feature.
      userSuggestedCount:
        type: integer
        description: The number of times the question was suggested explicitly by the user.
        format: int32
      autoSuggestedCount:
        type: integer
        description: >-
          The number of times the question was suggested automatically by the
          Active Learning algorithm.
        format: int32
  ImportQnaRecord:
    description: Import QnA Record.
    allOf:
      - $ref: '#/definitions/RetrieveQnaRecord'
      - $ref: '#/definitions/SourceDisplayNameParameter'
  SourceDisplayNameParameter:
    type: object
    properties:
      sourceDisplayName:
        description: Friendly name of the Source.
        type: string
        maxLength: 200
        minLength: 1
  RetrieveQnaRecord:
    description: QnA Record with last updated date-time.
    allOf:
      - $ref: '#/definitions/QnaRecord'
      - $ref: '#/definitions/LastUpdatedDateTimeParameter'
  LastUpdatedDateTimeParameter:
    type: object
    description: Last updated date-time parameter.
    properties:
      lastUpdatedDateTime:
        type: string
        format: date-time
        description: Date-time when the QnA was last updated.
  QnaDialog:
    type: object
    description: Dialog associated with QnA Record.
    properties:
      isContextOnly:
        type: boolean
        description: >-
          To mark if a prompt is relevant only with a previous question or not.
          If true, do not include this QnA as answer for queries without
          context; otherwise, ignores context and includes this QnA in answers.
      prompts:
        type: array
        description: List of prompts associated with the answer.
        maxItems: 20
        items:
          $ref: '#/definitions/QnaPrompt'
  QnaPrompt:
    type: object
    description: Prompt for an answer.
    properties:
      displayOrder:
        type: integer
        description: Index of the prompt. It is used for ordering of the prompts.
        format: int32
      qnaId:
        type: integer
        description: ID of the QnA corresponding to the prompt.
        format: int32
      qna:
        description: >-
          QnA record. Either QnAId or QnA record needs to be present in a
          Prompt.
        $ref: '#/definitions/QnaRecord'
      displayText:
        type: string
        description: Text displayed to represent a follow up question prompt.
        maxLength: 200
  UpdateOperationKind:
    type: string
    description: Update operation type for assets.
    enum:
      - add
      - delete
      - replace
    x-ms-enum:
      modelAsString: true
      name: updateOperationKind
  UpdateSourcesOptions:
    type: array
    description: A list of sources to be updated.
    additionalProperties: false
    items:
      $ref: '#/definitions/UpdateSourceRecord'
  UpdateQnaOptions:
    type: array
    description: A list of QnAs to be updated.
    additionalProperties: false
    items:
      $ref: '#/definitions/UpdateQnaRecord'
  UpdateQnaRecord:
    type: object
    description: QnA record to be updated.
    additionalProperties: false
    required:
      - op
      - value
    properties:
      op:
        type: string
        $ref: '#/definitions/UpdateOperationKind'
      value:
        $ref: '#/definitions/QnaRecord'
  UpdateSourceRecord:
    type: object
    description: Source to be updated.
    additionalProperties: false
    required:
      - op
      - value
    properties:
      op:
        type: string
        $ref: '#/definitions/UpdateOperationKind'
      value:
        $ref: '#/definitions/UpdateQnaSourceRecord'
  QnaSources:
    type: object
    description: All QnA sources for the project.
    additionalProperties: false
    properties:
      value:
        $ref: '#/definitions/QnaSourcesMetadata'
      nextLink:
        type: string
  QnaSourcesMetadata:
    type: array
    description: >-
      Custom sources from which QnAs were extracted or explicitly added to the
      project.
    additionalProperties: false
    items:
      $ref: '#/definitions/QnaSourceRecord'
  QnaSourceRecord:
    description: Custom source record with last updated date-time.
    allOf:
      - $ref: '#/definitions/QnaSourceMetadata'
      - $ref: '#/definitions/LastUpdatedDateTimeParameter'
  UpdateQnaSourceRecord:
    description: Update source record.
    allOf:
      - $ref: '#/definitions/QnaSourceMetadata'
      - $ref: '#/definitions/RefreshSourceOptions'
  RefreshSourceOptions:
    type: object
    description: Boolean flag used to refresh data from the Source.
    properties:
      refresh:
        type: boolean
        description: Boolean flag used to refresh data from the Source.
  QnaSourceMetadata:
    type: object
    description: Input source file or url details.
    additionalProperties: false
    required:
      - sourceUri
      - sourceKind
      - source
    properties:
      displayName:
        type: string
        description: Friendly name of the Source.
        maxLength: 200
        minLength: 1
      source:
        type: string
        description: >-
          Unique source identifier. Name of the file if it's a 'file' source;
          otherwise, the complete URL if it's a 'url' source.
      sourceUri:
        type: string
        description: URI location for the file or url.
        format: uri
      sourceKind:
        type: string
        $ref: '#/definitions/QnaSourceKind'
        default: url
      contentStructureKind:
        type: string
        $ref: '#/definitions/SourceContentStructureKind'
        default: Unstructured
  QnaSourceKind:
    type: string
    description: Supported source types.
    x-ms-enum:
      name: sourceKind
      modelAsString: true
    enum:
      - file
      - url
  SourceContentStructureKind:
    type: string
    description: Content structure type for sources.
    enum:
      - unstructured
    x-ms-enum:
      modelAsString: true
      name: sourceContentStructureKind
  ProjectDeployments:
    type: object
    description: All deployments of a project.
    additionalProperties: false
    properties:
      value:
        $ref: '#/definitions/ProjectDeploymentsList'
      nextLink:
        type: string
  ProjectDeploymentsList:
    type: array
    description: List of deployments of a project.
    additionalProperties: false
    items:
      $ref: '#/definitions/ProjectDeployment'
  ProjectDeployment:
    type: object
    description: Project deployment details.
    additionalProperties: false
    properties:
      deploymentName:
        type: string
        description: Name of the deployment.
      lastDeployedDateTime:
        type: string
        description: Represents the project last deployment date-time.
        format: date-time
parameters:
  JobIdParameter:
    name: jobId
    in: path
    description: Job ID.
    required: true
    type: string
    x-ms-parameter-location: method
  AssetKindParameter:
    name: assetKind
    type: string
    in: query
    description: Kind of the asset of the project.
    enum:
      - qnas
      - synonyms
    x-ms-enum:
      name: assetKind
      modelAsString: true
      values:
        - value: qnas
        - value: synonyms
    x-ms-parameter-location: method
  ImportExportFormatParameter:
    name: format
    type: string
    in: query
    description: Knowledge base Import or Export format.
    default: json
    enum:
      - json
      - tsv
      - excel
    x-ms-enum:
      name: format
      modelAsString: true
      values:
        - value: json
          description: Export or Import QnA assets in JSON format.
        - value: tsv
          description: >-
            Export or Import knowledge base replica including all assets and
            metadata in Excel format.
        - value: excel
          description: >-
            Export or Import knowledge base replica including all assets and
            metadata in Tsv format.
    x-ms-parameter-location: method
  SourceFilterParameter:
    name: source
    in: query
    description: Source of the QnA.
    type: string
    x-ms-parameter-location: method
tags:
  - name: Authoring