swagger: '2.0'
info:
  title: Microsoft Azure Microsoft Cognitive Language Service - Text Analysis Authoring
  version: 2022-05-15-preview
  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/language-service/overview">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.
securityDefinitions:
  apim_key:
    type: apiKey
    description: A subscription key for a Language service resource.
    name: Ocp-Apim-Subscription-Key
    in: header
security:
  - apim_key: []
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}/language'
  useSchemePrefix: false
  parameters:
    - $ref: common.json#/parameters/Endpoint
paths:
  /authoring/analyze-text/projects:
    get:
      description: Lists the existing projects.
      operationId: microsoftAzureTextanalysisauthoringListprojects
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The metadata of projects.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectsMetadata'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful List Projects:
          $ref: ./examples/analyzetext-authoring/SuccessfulListProjects.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}:
    patch:
      description: Creates a new project or updates an existing one.
      operationId: microsoftAzureTextanalysisauthoringCreateproject
      consumes:
        - application/merge-patch+json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - in: body
          name: body
          description: The project parameters.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringCreateProjectOptions'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The metadata of the updated project, if it already exists.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectMetadata'
        '201':
          description: The metadata of the created project.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectMetadata'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Create Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulCreateProject.json
      summary: Microsoft Azure Patch Authoring Analyze Text Projects Projectname
      tags:
        - Authoring
    get:
      description: Gets the details of a project.
      operationId: microsoftAzureTextanalysisauthoringGetproject
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The metadata of the project.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectMetadata'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetProject.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname
      tags:
        - Authoring
    delete:
      description: Deletes a project.
      operationId: microsoftAzureTextanalysisauthoringDeleteproject
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Delete Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulDeleteProject.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Authoring Analyze Text Projects Projectname
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/:export:
    post:
      description: Triggers a job to export a project's data.
      operationId: microsoftAzureTextanalysisauthoringExport
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter'
        - in: query
          name: assetKind
          description: Kind of asset to export.
          type: string
          x-ms-parameter-location: method
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Export Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulExportProject.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :export
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/:import:
    post:
      description: >-
        Triggers a job to import a project. If a project with the same name
        already exists, the data of that project is replaced.
      operationId: microsoftAzureTextanalysisauthoringImport
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - in: body
          name: body
          description: The project data to import.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringExportedProject'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Import Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulImportProject.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :import
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/:train:
    post:
      description: Triggers a training job for a project.
      operationId: microsoftAzureTextanalysisauthoringTrain
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - in: body
          name: body
          description: The training input parameters.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringTrainingJobOptions'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Train Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulTrainProject.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :train
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/deployments:
    get:
      description: Lists the deployments belonging to a project.
      operationId: microsoftAzureTextanalysisauthoringListdeployments
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: List of all deployments.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectDeployments'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful List Deployments:
          $ref: ./examples/analyzetext-authoring/SuccessfulListDeployments.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/deployments/:swap:
    post:
      description: Swaps two existing deployments with each other.
      operationId: microsoftAzureTextanalysisauthoringSwapdeployments
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - in: body
          name: body
          description: The job object to swap two deployments.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Swap Deployments:
          $ref: ./examples/analyzetext-authoring/SuccessfulSwapDeployments.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments :swap
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}:
    get:
      description: Gets the details of a deployment.
      operationId: microsoftAzureTextanalysisauthoringGetdeployment
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The Deployment info.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectDeployment'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Deployment:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetDeployment.json
      summary: >-
        Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname
      tags:
        - Authoring
    put:
      description: Creates a new deployment or replaces an existing one.
      operationId: microsoftAzureTextanalysisauthoringDeployproject
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - in: body
          name: body
          description: The new deployment info.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringCreateDeploymentOptions'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Deploy Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulDeployProject.json
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Put Authoring Analyze Text Projects Projectname Deployments Deploymentname
      tags:
        - Authoring
    delete:
      description: Deletes a project deployment.
      operationId: microsoftAzureTextanalysisauthoringDeletedeployment
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: The location of the status API for monitoring the created job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Delete Deployment:
          $ref: ./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Delete Authoring Analyze Text Projects Projectname Deployments Deploymentname
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}:
    get:
      description: Gets the status of an existing deployment job.
      operationId: microsoftAzureTextanalysisauthoringGetdeploymentstatus
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The deployment job result.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringDeploymentJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Deployment Status:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json
      summary: >-
        Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Jobs Jobid
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}:
    get:
      description: Gets the status of an existing swap deployment job.
      operationId: microsoftAzureTextanalysisauthoringGetswapdeploymentsstatus
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The swap deployment job result.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringDeploymentJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Swap Deployments Status:
          $ref: >-
            ./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json
      summary: >-
        Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Swap Jobs Jobid
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}:
    get:
      description: >-
        Gets the status of an export job. Once job completes, returns the
        project metadata, and assets.
      operationId: microsoftAzureTextanalysisauthoringGetexportstatus
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The status of the long running operation.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringExportProjectJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Export Status:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetExportStatus.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Export Jobs Jobid
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}:
    get:
      description: Gets the status for an import.
      operationId: microsoftAzureTextanalysisauthoringGetimportstatus
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The details of the long running operation.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringImportProjectJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Import Status:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetImportStatus.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Import Jobs Jobid
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/models:
    get:
      description: Lists the trained models belonging to a project.
      operationId: microsoftAzureTextanalysisauthoringListtrainedmodels
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: List of all trained models.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectTrainedModels'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful List Models:
          $ref: ./examples/analyzetext-authoring/SuccessfulListModels.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}:
    get:
      description: Gets the details of a trained model.
      operationId: microsoftAzureTextanalysisauthoringGettrainedmodel
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Trained model info
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectTrainedModel'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Model:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetModel.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel
      tags:
        - Authoring
    delete:
      description: Deletes an existing trained model.
      operationId: microsoftAzureTextanalysisauthoringDeletetrainedmodel
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '204':
          description: Deleted successfully.
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Delete Model:
          $ref: ./examples/analyzetext-authoring/SuccessfulDeleteModel.json
      summary: >-
        Microsoft Azure Delete Authoring Analyze Text Projects Projectname Models Trainedmodellabel
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result:
    get:
      description: >-
        Gets the detailed results of the evaluation for a trained model. This
        includes the raw inference results for the data included in the
        evaluation process.
      operationId: microsoftAzureTextanalysisauthoringGetmodelevaluationresults
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter'
        - $ref: '#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter'
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: List of the evaluation results.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringEvaluationResults'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Model Evaluation:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: >-
        Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Result
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result:
    get:
      description: >-
        Gets the evaluation summary of a trained model. The summary includes
        high level performance measurements of the model e.g., F1, Precision,
        Recall, etc.
      operationId: microsoftAzureTextanalysisauthoringGetmodelevaluationsummary
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: List of all evaluation results.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringEvaluationSummary'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Model Evaluation Summary:
          $ref: >-
            ./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json
      summary: >-
        Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Summary Result
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/train/jobs:
    get:
      description: Lists the non-expired training jobs created for a project.
      operationId: microsoftAzureTextanalysisauthoringListtrainingjobs
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: List of the training jobs.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringTrainingJobs'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful List Training Jobs:
          $ref: ./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}:
    get:
      description: Gets the status for a training job.
      operationId: microsoftAzureTextanalysisauthoringGettrainingstatus
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The training job result.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringTrainingJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Train Status:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs Jobid
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel:
    post:
      description: Triggers a cancellation for a running training job.
      operationId: microsoftAzureTextanalysisauthoringCanceltrainingjob
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results with an Operation-Location header used to
            check the status of the job.
          headers:
            operation-location:
              description: >-
                The location of the status API for monitoring the job
                cancellation.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Cancel Training Job:
          $ref: ./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Post Authoring Analyze Text Projects Projectname Train Jobs Jobid :cancel
      tags:
        - Authoring
  /authoring/analyze-text/projects/global/deletion-jobs/{jobId}:
    get:
      description: Gets the status for a project deletion job.
      operationId: microsoftAzureTextanalysisauthoringGetprojectdeletionstatus
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/TextAnalysisAuthoringJobIdPathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The project deletion job result.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringProjectDeletionJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Project Deletion Status:
          $ref: >-
            ./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Global Deletion Jobs Jobid
      tags:
        - Authoring
  /authoring/analyze-text/projects/global/languages:
    get:
      description: Lists the supported languages.
      operationId: microsoftAzureTextanalysisauthoringGetsupportedlanguages
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: The list of supported languages.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringSupportedLanguages'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Supported Languages:
          $ref: >-
            ./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects Global Languages
      tags:
        - Authoring
  /authoring/analyze-text/projects/global/training-config-versions:
    get:
      description: Lists the support training config version for a given project type.
      operationId: microsoftAzureTextanalysisauthoringListtrainingconfigversions
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/TextAnalysisAuthoringProjectKindQueryParameter'
        - $ref: common.json#/parameters/TopParameter
        - $ref: common.json#/parameters/SkipParameter
        - $ref: common.json#/parameters/MaxPageSizeParameter
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: List of all trained models.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringTrainingConfigVersions'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Supported Training Config Versions:
          $ref: >-
            ./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects Global Training Config Versions
      tags:
        - Authoring
definitions:
  TextAnalysisAuthoringConfusionMatrix:
    type: object
    additionalProperties:
      $ref: '#/definitions/TextAnalysisAuthoringConfusionMatrixRow'
    x-ms-client-name: ConfusionMatrix
  TextAnalysisAuthoringConfusionMatrixCell:
    description: Represents a cell in a confusion matrix.
    required:
      - normalizedValue
      - rawValue
    type: object
    properties:
      normalizedValue:
        format: float
        description: Represents normalized value in percentages.
        type: number
      rawValue:
        format: float
        description: Represents raw value.
        type: number
    x-ms-client-name: ConfusionMatrixCell
  TextAnalysisAuthoringConfusionMatrixRow:
    type: object
    additionalProperties:
      $ref: '#/definitions/TextAnalysisAuthoringConfusionMatrixCell'
    x-ms-client-name: ConfusionMatrixRow
  TextAnalysisAuthoringCreateDeploymentOptions:
    description: Represents the options for creating or updating a project deployment.
    required:
      - trainedModelLabel
    type: object
    properties:
      trainedModelLabel:
        description: Represents the trained model label.
        type: string
    x-ms-client-name: CreateDeploymentOptions
  TextAnalysisAuthoringCreateProjectOptions:
    description: Represents the options used to create or update a project.
    required:
      - projectKind
      - storageInputContainerName
      - projectName
      - language
    type: object
    properties:
      projectKind:
        description: The project kind.
        $ref: '#/definitions/TextAnalysisAuthoringProjectKind'
      storageInputContainerName:
        description: The storage container name.
        type: string
      settings:
        description: The project settings.
        $ref: '#/definitions/TextAnalysisAuthoringProjectSettings'
      projectName:
        description: The new project name.
        type: string
      multilingual:
        description: Whether the project would be used for multiple languages or not.
        type: boolean
      description:
        description: The project description.
        type: string
      language:
        description: >-
          The project language. This is BCP-47 representation of a language. For
          example, use "en" for English, "en-gb" for English (UK), "es" for
          Spanish etc.
        type: string
    x-ms-client-name: CreateProjectOptions
  TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult:
    description: >-
      Represents the document evaluation result for a custom entity recognition
      project.
    required:
      - customEntityRecognitionResult
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringDocumentEvaluationResult'
    properties:
      customEntityRecognitionResult:
        description: Represents the evaluation prediction for entity recognition.
        $ref: >-
          #/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult
    x-ms-discriminator-value: CustomEntityRecognition
    x-ms-client-name: CustomEntityRecognitionDocumentEvaluationResult
  TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary:
    description: Represents the evaluation summary for a custom entity recognition project.
    required:
      - customEntityRecognitionEvaluation
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringEvaluationSummary'
    properties:
      customEntityRecognitionEvaluation:
        description: Contains the data related to extraction evaluation.
        $ref: '#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary'
    x-ms-discriminator-value: CustomEntityRecognition
    x-ms-client-name: CustomEntityRecognitionEvaluationSummary
  TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult:
    description: >-
      Represents the document evaluation result for a custom multi-label
      classification project.
    required:
      - customMultiLabelClassificationResult
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringDocumentEvaluationResult'
    properties:
      customMultiLabelClassificationResult:
        description: Represents the evaluation prediction for multi label classification.
        $ref: >-
          #/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult
    x-ms-discriminator-value: CustomMultiLabelClassification
    x-ms-client-name: CustomMultiLabelClassificationDocumentEvaluationResult
  TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary:
    description: >-
      Represents the evaluation summary for a custom multi-label classification
      project.
    required:
      - customMultiLabelClassificationEvaluation
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringEvaluationSummary'
    properties:
      customMultiLabelClassificationEvaluation:
        description: Contains the data related to multi label classification evaluation.
        $ref: >-
          #/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary
    x-ms-discriminator-value: CustomMultiLabelClassification
    x-ms-client-name: CustomMultiLabelClassificationEvaluationSummary
  TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult:
    description: >-
      Represents the document evaluation result for a custom single-label
      classification project.
    required:
      - customSingleLabelClassificationResult
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringDocumentEvaluationResult'
    properties:
      customSingleLabelClassificationResult:
        description: Represents the evaluation prediction for single label classification.
        $ref: >-
          #/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult
    x-ms-discriminator-value: CustomSingleLabelClassification
    x-ms-client-name: CustomSingleLabelClassificationDocumentEvaluationResult
  TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary:
    description: >-
      Represents the evaluation summary for a custom single-label classification
      project.
    required:
      - customSingleLabelClassificationEvaluation
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringEvaluationSummary'
    properties:
      customSingleLabelClassificationEvaluation:
        description: Contains the data related to single label classification evaluation.
        $ref: >-
          #/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary
    x-ms-discriminator-value: CustomSingleLabelClassification
    x-ms-client-name: CustomSingleLabelClassificationEvaluationSummary
  TextAnalysisAuthoringDeploymentJobState:
    description: Represents the state of a deployment job.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringJobState'
    x-ms-client-name: DeploymentJobState
  TextAnalysisAuthoringDocumentEntityLabelEvaluationResult:
    description: Represents an evaluation result entity label.
    required:
      - category
      - offset
      - length
    type: object
    properties:
      category:
        description: Represents the entity category.
        type: string
      offset:
        format: int32
        description: Represents the entity offset index relative to the original text.
        type: integer
      length:
        format: int32
        description: Represents the entity length.
        type: integer
    x-ms-client-name: DocumentEntityLabelEvaluationResult
  TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult:
    description: Represents the entity recognition evaluation result for a document.
    required:
      - entities
    type: object
    properties:
      entities:
        description: Represents the document labelled entities.
        type: array
        items:
          $ref: >-
            #/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult
    x-ms-client-name: DocumentEntityRecognitionEvaluationResult
  TextAnalysisAuthoringDocumentEntityRegionEvaluationResult:
    description: >-
      Represents the evaluation comparison between the expected and predicted
      entities of a document region.
    required:
      - expectedEntities
      - predictedEntities
      - regionOffset
      - regionLength
    type: object
    properties:
      expectedEntities:
        description: Represents the region's expected entity labels.
        type: array
        items:
          $ref: >-
            #/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult
      predictedEntities:
        description: Represents the region's predicted entity labels.
        type: array
        items:
          $ref: >-
            #/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult
      regionOffset:
        format: int32
        description: Represents the region offset.
        type: integer
      regionLength:
        format: int32
        description: Represents the region length.
        type: integer
    x-ms-client-name: DocumentEntityRegionEvaluationResult
  TextAnalysisAuthoringDocumentEvaluationResult:
    description: Represents the evaluation result of a document.
    required:
      - location
      - language
      - projectKind
    type: object
    properties:
      location:
        description: Represents the document path.
        type: string
      language:
        description: >-
          Represents the document language. This is BCP-47 representation of a
          language. For example, use "en" for English, "en-gb" for English (UK),
          "es" for Spanish etc.
        type: string
      projectKind:
        description: Represents the project kind.
        $ref: '#/definitions/TextAnalysisAuthoringProjectKind'
    discriminator: projectKind
    x-ms-client-name: DocumentEvaluationResult
  TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult:
    description: >-
      Represents the comparison between the expected and predicted classes that
      are result from the evaluation operation.
    required:
      - expectedClasses
      - predictedClasses
    type: object
    properties:
      expectedClasses:
        description: Represents the document's expected classes.
        type: array
        items:
          type: string
      predictedClasses:
        description: Represents the document's predicted classes.
        type: array
        items:
          type: string
    x-ms-client-name: DocumentMultiLabelClassificationEvaluationResult
  TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult:
    description: >-
      Represents the comparison between the expected and predicted class that
      result from an evaluation operation.
    required:
      - expectedClass
      - predictedClass
    type: object
    properties:
      expectedClass:
        description: Represents the document's expected class.
        type: string
      predictedClass:
        description: Represents the document's predicted class.
        type: string
    x-ms-client-name: DocumentSingleLabelClassificationEvaluationResult
  TextAnalysisAuthoringEntityEvaluationSummary:
    description: Represents the evaluation summary for an entity.
    required:
      - f1
      - precision
      - recall
      - truePositiveCount
      - trueNegativeCount
      - falsePositiveCount
      - falseNegativeCount
    type: object
    properties:
      f1:
        format: double
        description: Represents the model precision
        type: number
      precision:
        format: double
        description: Represents the model recall
        type: number
      recall:
        format: double
        description: Represents the model F1 score
        type: number
      truePositiveCount:
        format: int32
        description: Represents the count of true positive
        type: integer
      trueNegativeCount:
        format: int32
        description: Represents the count of true negative
        type: integer
      falsePositiveCount:
        format: int32
        description: Represents the count of false positive
        type: integer
      falseNegativeCount:
        format: int32
        description: Represents the count of false negative
        type: integer
    x-ms-client-name: EntityEvaluationSummary
  TextAnalysisAuthoringEntityRecognitionEvaluationSummary:
    description: Represents the evaluation summary for a custom entity recognition project.
    required:
      - confusionMatrix
      - entities
      - microF1
      - microPrecision
      - microRecall
      - macroF1
      - macroPrecision
      - macroRecall
    type: object
    properties:
      confusionMatrix:
        description: >-
          Represents the confusion matrix between two entities (the two entities
          can be the same). The matrix is between the entity that was labelled
          and the entity that was predicted.
        $ref: '#/definitions/TextAnalysisAuthoringConfusionMatrix'
      entities:
        description: Represents the entities evaluation
        type: object
        additionalProperties:
          $ref: '#/definitions/TextAnalysisAuthoringEntityEvaluationSummary'
      microF1:
        format: float
        description: Represents the micro F1
        type: number
      microPrecision:
        format: float
        description: Represents the micro precision
        type: number
      microRecall:
        format: float
        description: Represents the micro recall
        type: number
      macroF1:
        format: float
        description: Represents the macro F1
        type: number
      macroPrecision:
        format: float
        description: Represents the macro precision
        type: number
      macroRecall:
        format: float
        description: Represents the macro recall
        type: number
    x-ms-client-name: EntityRecognitionEvaluationSummary
  TextAnalysisAuthoringEvaluationKind:
    enum:
      - percentage
      - manual
    type: string
    x-ms-enum:
      name: EvaluationKind
      modelAsString: true
      values:
        - value: percentage
          description: >-
            Split the data into training and test sets according to user-defined
            percentages.
        - value: manual
          description: >-
            Split the data according to the chosen dataset for every example in
            the data.
    x-ms-client-name: EvaluationKind
  TextAnalysisAuthoringEvaluationOptions:
    description: Represents the options used running the evaluation.
    type: object
    properties:
      kind:
        description: >-
          Represents the evaluation kind. By default, the evaluation kind is set
          to percentage.
        $ref: '#/definitions/TextAnalysisAuthoringEvaluationKind'
      trainingSplitPercentage:
        format: int32
        description: >-
          Represents the training dataset split percentage. Only needed in case
          the evaluation kind is percentage.
        type: integer
      testingSplitPercentage:
        format: int32
        description: >-
          Represents the testing dataset split percentage. Only needed in case
          the evaluation kind is percentage.
        type: integer
    x-ms-client-name: EvaluationOptions
  TextAnalysisAuthoringEvaluationResults:
    description: Represents a list of results for an evaluation operation.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: THe list of documents evaluation results.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringDocumentEvaluationResult'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: EvaluationResults
  TextAnalysisAuthoringEvaluationSummary:
    description: Represents the summary for an evaluation operation.
    required:
      - projectKind
      - evaluationOptions
    type: object
    properties:
      projectKind:
        description: Represents the project type that the evaluation ran on.
        $ref: '#/definitions/TextAnalysisAuthoringProjectKind'
      evaluationOptions:
        $ref: '#/definitions/TextAnalysisAuthoringEvaluationOptions'
    discriminator: projectKind
    x-ms-client-name: EvaluationSummary
  TextAnalysisAuthoringExportedClass:
    description: Represents a class of an exported project.
    type: object
    properties:
      category:
        description: The class category.
        type: string
    x-ms-client-name: ExportedClass
  TextAnalysisAuthoringExportedCustomEntityRecognitionDocument:
    description: Represents an exported document for a custom entity recognition project.
    type: object
    properties:
      entities:
        description: The list of entity labels belonging to the document.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringExportedDocumentRegion'
      location:
        description: The location of the document in the storage.
        type: string
      language:
        description: >-
          Represents the document language. This is BCP-47 representation of a
          language. For example, use "en" for English, "en-gb" for English (UK),
          "es" for Spanish etc.
        type: string
      dataset:
        description: The dataset for this document. Allowed values are 'Train' and 'Test'.
        type: string
    x-ms-client-name: ExportedCustomEntityRecognitionDocument
  TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets:
    description: Represents the exported assets for a entity recognition project.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringExportedProjectAssets'
    properties:
      entities:
        description: The list of entities belonging to the project.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringExportedEntity'
      documents:
        description: The list of documents belonging to the project.
        type: array
        items:
          $ref: >-
            #/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument
    x-ms-discriminator-value: CustomEntityRecognition
    x-ms-client-name: ExportedCustomEntityRecognitionProjectAssets
  TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument:
    description: >-
      Represents an exported document of a custom multi-label classification
      project.
    type: object
    properties:
      classes:
        description: The document classes.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringExportedDocumentClass'
      location:
        description: The location of the document in the storage.
        type: string
      language:
        description: >-
          Represents the document language. This is BCP-47 representation of a
          language. For example, use "en" for English, "en-gb" for English (UK),
          "es" for Spanish etc.
        type: string
      dataset:
        description: The dataset for this document. Allowed values are 'Train' and 'Test'.
        type: string
    x-ms-client-name: ExportedCustomMultiLabelClassificationDocument
  TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets:
    description: >-
      Represents the exported assets for a custom multi-label classification
      project.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringExportedProjectAssets'
    properties:
      classes:
        description: The list of classes in the project.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringExportedClass'
      documents:
        description: The list of documents in the project.
        type: array
        items:
          $ref: >-
            #/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument
    x-ms-discriminator-value: CustomMultiLabelClassification
    x-ms-client-name: ExportedCustomMultiLabelClassificationProjectAssets
  TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument:
    description: >-
      Represents an exported document for a custom single-label classification
      project.
    type: object
    properties:
      class:
        description: The class of the documents.
        $ref: '#/definitions/TextAnalysisAuthoringExportedDocumentClass'
      location:
        description: The location of the document in the storage.
        type: string
      language:
        description: >-
          Represents the document language. This is BCP-47 representation of a
          language. For example, use "en" for English, "en-gb" for English (UK),
          "es" for Spanish etc.
        type: string
      dataset:
        description: The dataset for this document. Allowed values are 'Train' and 'Test'.
        type: string
    x-ms-client-name: ExportedCustomSingleLabelClassificationDocument
  TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets:
    description: Represents the exported assets for a single-label classification project.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringExportedProjectAssets'
    properties:
      classes:
        description: The list of classes belonging to this project.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringExportedClass'
      documents:
        description: The list of documents belonging to this project.
        type: array
        items:
          $ref: >-
            #/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument
    x-ms-discriminator-value: CustomSingleLabelClassification
    x-ms-client-name: ExportedCustomSingleLabelClassificationProjectAssets
  TextAnalysisAuthoringExportedDocumentClass:
    description: Represents a classification label for a document.
    type: object
    properties:
      category:
        type: string
    x-ms-client-name: ExportedDocumentClass
  TextAnalysisAuthoringExportedDocumentEntityLabel:
    description: Represents an entity label for a document.
    type: object
    properties:
      category:
        description: The entity category.
        type: string
      offset:
        format: int32
        description: Start position for the entity text.
        type: integer
      length:
        format: int32
        description: Length for the entity text.
        type: integer
    x-ms-client-name: ExportedDocumentEntityLabel
  TextAnalysisAuthoringExportedDocumentRegion:
    description: Represents a region in a document for entity labeling.
    type: object
    properties:
      regionOffset:
        format: int32
        description: Start position for the region.
        type: integer
      regionLength:
        format: int32
        description: Length for the region text.
        type: integer
      labels:
        description: The list of entity labels belonging to this region.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel'
    x-ms-client-name: ExportedDocumentRegion
  TextAnalysisAuthoringExportedEntity:
    description: Represents an entity in an exported project.
    type: object
    properties:
      category:
        description: The entity category.
        type: string
    x-ms-client-name: ExportedEntity
  TextAnalysisAuthoringExportedProject:
    description: Represents an exported project.
    required:
      - projectFileVersion
      - stringIndexType
      - metadata
    type: object
    properties:
      projectFileVersion:
        description: The version of the exported file.
        type: string
      stringIndexType:
        description: >-
          Specifies the method used to interpret string offsets. For additional
          information see https://aka.ms/text-analytics-offsets.
        $ref: '#/definitions/TextAnalysisAuthoringStringIndexType'
      metadata:
        description: Represents the project metadata.
        $ref: '#/definitions/TextAnalysisAuthoringCreateProjectOptions'
      assets:
        description: Represents the project assets.
        $ref: '#/definitions/TextAnalysisAuthoringExportedProjectAssets'
    x-ms-client-name: ExportedProject
  TextAnalysisAuthoringExportedProjectAssets:
    description: Represents the assets of an exported project.
    required:
      - projectKind
    type: object
    properties:
      projectKind:
        description: The type of the project the assets belong to.
        $ref: '#/definitions/TextAnalysisAuthoringProjectKind'
    discriminator: projectKind
    x-ms-client-name: ExportedProjectAssets
  TextAnalysisAuthoringExportProjectJobState:
    description: Represents the state of an export job.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringJobState'
    properties:
      resultUrl:
        description: The URL to use in order to download the exported project.
        type: string
    x-ms-client-name: ExportProjectJobState
  TextAnalysisAuthoringImportProjectJobState:
    description: Represents the state of an import job.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringJobState'
    x-ms-client-name: ImportProjectJobState
  TextAnalysisAuthoringJobState:
    description: Represents a job's state.
    required:
      - jobId
      - createdDateTime
      - lastUpdatedDateTime
      - status
    type: object
    properties:
      jobId:
        description: The job ID.
        type: string
      createdDateTime:
        format: date-time
        description: The creation date time of the job.
        type: string
      lastUpdatedDateTime:
        format: date-time
        description: The last date time the job was updated.
        type: string
      expirationDateTime:
        format: date-time
        description: The expiration date time of the job.
        type: string
      status:
        description: The job status.
        $ref: '#/definitions/TextAnalysisAuthoringJobStatus'
      warnings:
        description: The warnings that were encountered while executing the job.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringWarning'
      errors:
        description: The errors encountered while executing the job.
        type: array
        items:
          $ref: common.json#/definitions/Error
    x-ms-client-name: JobState
  TextAnalysisAuthoringJobStatus:
    enum:
      - notStarted
      - running
      - succeeded
      - failed
      - cancelled
      - cancelling
      - partiallyCompleted
    type: string
    x-ms-enum:
      name: JobStatus
      modelAsString: true
    x-ms-client-name: JobStatus
  TextAnalysisAuthoringMultiLabelClassEvaluationSummary:
    description: >-
      Represents the evaluation summary of a class in a multi-label
      classification project.
    required:
      - f1
      - precision
      - recall
      - truePositiveCount
      - trueNegativeCount
      - falsePositiveCount
      - falseNegativeCount
    type: object
    properties:
      f1:
        format: double
        description: Represents the model precision
        type: number
      precision:
        format: double
        description: Represents the model recall
        type: number
      recall:
        format: double
        description: Represents the model F1 score
        type: number
      truePositiveCount:
        format: int32
        description: Represents the count of true positive
        type: integer
      trueNegativeCount:
        format: int32
        description: Represents the count of true negative
        type: integer
      falsePositiveCount:
        format: int32
        description: Represents the count of false positive
        type: integer
      falseNegativeCount:
        format: int32
        description: Represents the count of false negative
        type: integer
    x-ms-client-name: MultiLabelClassEvaluationSummary
  TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary:
    description: >-
      Represents the evaluation summary for a multi-label classification
      project.
    required:
      - classes
      - microF1
      - microPrecision
      - microRecall
      - macroF1
      - macroPrecision
      - macroRecall
    type: object
    properties:
      classes:
        description: Represents the classes evaluation
        type: object
        additionalProperties:
          $ref: '#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary'
      microF1:
        format: float
        description: Represents the micro F1
        type: number
      microPrecision:
        format: float
        description: Represents the micro precision
        type: number
      microRecall:
        format: float
        description: Represents the micro recall
        type: number
      macroF1:
        format: float
        description: Represents the macro F1
        type: number
      macroPrecision:
        format: float
        description: Represents the macro precision
        type: number
      macroRecall:
        format: float
        description: Represents the macro recall
        type: number
    x-ms-client-name: MultiLabelClassificationEvaluationSummary
  TextAnalysisAuthoringProjectDeletionJobState:
    description: Represents the state of a project deletion job.
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringJobState'
    x-ms-client-name: ProjectDeletionJobState
  TextAnalysisAuthoringProjectDeployment:
    description: Represents a project deployment.
    required:
      - deploymentName
      - modelId
      - lastTrainedDateTime
      - lastDeployedDateTime
      - deploymentExpirationDate
      - modelTrainingConfigVersion
    type: object
    properties:
      deploymentName:
        description: Represents deployment name.
        type: string
      modelId:
        description: Represents deployment modelId.
        type: string
      lastTrainedDateTime:
        format: date-time
        description: Represents deployment last trained time.
        type: string
      lastDeployedDateTime:
        format: date-time
        description: Represents deployment last deployed time.
        type: string
      deploymentExpirationDate:
        format: date
        description: Represents deployment expiration date in the runtime.
        type: string
      modelTrainingConfigVersion:
        description: Represents model training config version.
        type: string
    x-ms-client-name: ProjectDeployment
  TextAnalysisAuthoringProjectDeployments:
    description: Represents a list of retrieved deployments.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: The list of retrieved deployments.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringProjectDeployment'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: ProjectDeployments
  TextAnalysisAuthoringProjectKind:
    enum:
      - CustomSingleLabelClassification
      - CustomMultiLabelClassification
      - CustomEntityRecognition
    type: string
    x-ms-enum:
      name: ProjectKind
      modelAsString: true
      values:
        - value: CustomSingleLabelClassification
          description: >-
            For building a classification model to classify text using your own
            data. Each file will have only one label. For example, file 1 is
            classified as A and file 2 is classified as B.
        - value: CustomMultiLabelClassification
          description: >-
            For building a classification model to classify text using your own
            data. Each file can have one or many labels. For example, file 1 is
            classified as A, B, and C and file 2 is classified as B and C.
        - value: CustomEntityRecognition
          description: >-
            For building an extraction model to identify your domain categories
            using your own data.
    x-ms-client-name: ProjectKind
  TextAnalysisAuthoringProjectMetadata:
    description: Represents the metadata of a project.
    required:
      - createdDateTime
      - lastModifiedDateTime
      - projectKind
      - storageInputContainerName
      - projectName
      - language
    type: object
    properties:
      createdDateTime:
        format: date-time
        description: Represents the project creation datetime.
        type: string
      lastModifiedDateTime:
        format: date-time
        description: Represents the project last modification datetime.
        type: string
      lastTrainedDateTime:
        format: date-time
        description: Represents the project last training datetime.
        type: string
      lastDeployedDateTime:
        format: date-time
        description: Represents the project last deployment datetime.
        type: string
      projectKind:
        description: The project kind.
        $ref: '#/definitions/TextAnalysisAuthoringProjectKind'
      storageInputContainerName:
        description: The storage container name.
        type: string
      settings:
        description: The project settings.
        $ref: '#/definitions/TextAnalysisAuthoringProjectSettings'
      projectName:
        description: The new project name.
        type: string
      multilingual:
        description: Whether the project would be used for multiple languages or not.
        type: boolean
      description:
        description: The project description.
        type: string
      language:
        description: >-
          The project language. This is BCP-47 representation of a language. For
          example, use "en" for English, "en-gb" for English (UK), "es" for
          Spanish etc.
        type: string
    x-ms-client-name: ProjectMetadata
  TextAnalysisAuthoringProjectSettings:
    description: Represents the settings used to define the project behavior.
    type: object
    x-ms-client-name: ProjectSettings
  TextAnalysisAuthoringProjectsMetadata:
    description: Represents a list of retrieved projects' metadata.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: The list of projects.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringProjectMetadata'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: ProjectsMetadata
  TextAnalysisAuthoringProjectTrainedModel:
    description: Represents a trained model.
    required:
      - label
      - modelId
      - lastTrainedDateTime
      - lastTrainingDurationInSeconds
      - modelExpirationDate
      - modelTrainingConfigVersion
    type: object
    properties:
      label:
        description: The trained model label.
        type: string
      modelId:
        description: The model ID.
        type: string
      lastTrainedDateTime:
        format: date-time
        description: The last trained date time of the model.
        type: string
      lastTrainingDurationInSeconds:
        format: int32
        description: The duration of the model's last training request in seconds.
        type: integer
      modelExpirationDate:
        format: date
        description: The model expiration date.
        type: string
      modelTrainingConfigVersion:
        description: The model training config version.
        type: string
    x-ms-client-name: ProjectTrainedModel
  TextAnalysisAuthoringProjectTrainedModels:
    description: Represents a list of retrieved trained models.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: The list of retrieved jobs.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringProjectTrainedModel'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: ProjectTrainedModels
  TextAnalysisAuthoringSingleLabelClassEvaluationSummary:
    description: >-
      Represents the evaluation summary for a class in a single-label
      classification project.
    required:
      - f1
      - precision
      - recall
      - truePositiveCount
      - trueNegativeCount
      - falsePositiveCount
      - falseNegativeCount
    type: object
    properties:
      f1:
        format: double
        description: Represents the model precision
        type: number
      precision:
        format: double
        description: Represents the model recall
        type: number
      recall:
        format: double
        description: Represents the model F1 score
        type: number
      truePositiveCount:
        format: int32
        description: Represents the count of true positive
        type: integer
      trueNegativeCount:
        format: int32
        description: Represents the count of true negative
        type: integer
      falsePositiveCount:
        format: int32
        description: Represents the count of false positive
        type: integer
      falseNegativeCount:
        format: int32
        description: Represents the count of false negative
        type: integer
    x-ms-client-name: SingleLabelClassEvaluationSummary
  TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary:
    description: >-
      Represents the evaluation summary for a custom single-label classification
      project.
    required:
      - confusionMatrix
      - classes
      - microF1
      - microPrecision
      - microRecall
      - macroF1
      - macroPrecision
      - macroRecall
    type: object
    properties:
      confusionMatrix:
        description: >-
          Represents the confusion matrix between two classes (the two classes
          can be the same). The matrix is between the class that was labelled
          and the class that was predicted.
        $ref: '#/definitions/TextAnalysisAuthoringConfusionMatrix'
      classes:
        description: Represents the classes evaluation
        type: object
        additionalProperties:
          $ref: '#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary'
      microF1:
        format: float
        description: Represents the micro F1
        type: number
      microPrecision:
        format: float
        description: Represents the micro precision
        type: number
      microRecall:
        format: float
        description: Represents the micro recall
        type: number
      macroF1:
        format: float
        description: Represents the macro F1
        type: number
      macroPrecision:
        format: float
        description: Represents the macro precision
        type: number
      macroRecall:
        format: float
        description: Represents the macro recall
        type: number
    x-ms-client-name: SingleLabelClassificationEvaluationSummary
  TextAnalysisAuthoringStringIndexType:
    enum:
      - Utf16CodeUnit
    type: string
    x-ms-enum:
      name: StringIndexType
      modelAsString: true
      values:
        - value: Utf16CodeUnit
          description: >-
            The offset and length values will correspond to UTF-16 code units.
            Use this option if your application is written in a language that
            support Unicode, for example Java, JavaScript.
    x-ms-client-name: StringIndexType
  TextAnalysisAuthoringSubTrainingJobState:
    description: Represents the detailed state of a training sub-operation.
    required:
      - percentComplete
      - status
    type: object
    properties:
      percentComplete:
        format: int32
        description: Represents progress percentage.
        type: integer
      startDateTime:
        format: date-time
        description: Represents the start date time.
        type: string
      endDateTime:
        format: date-time
        description: Represents the end date time.
        type: string
      status:
        description: Represents the status of the sub-operation.
        $ref: '#/definitions/TextAnalysisAuthoringJobStatus'
    x-ms-client-name: SubTrainingJobState
  TextAnalysisAuthoringSupportedLanguage:
    description: Represents a supported language.
    required:
      - languageName
      - languageCode
    type: object
    properties:
      languageName:
        description: The language name.
        type: string
      languageCode:
        description: >-
          The language code. This is BCP-47 representation of a language. For
          example, "en" for English, "en-gb" for English (UK), "es" for Spanish
          etc.
        type: string
    x-ms-client-name: SupportedLanguage
  TextAnalysisAuthoringSupportedLanguages:
    description: Represents a list of retrieved languages.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: The list of the languages.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringSupportedLanguage'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: SupportedLanguages
  TextAnalysisAuthoringSwapDeploymentsOptions:
    description: Represents the options for swapping two deployments together.
    required:
      - firstDeploymentName
      - secondDeploymentName
    type: object
    properties:
      firstDeploymentName:
        description: Represents the first deployment name.
        type: string
      secondDeploymentName:
        description: Represents the second deployment name.
        type: string
    x-ms-client-name: SwapDeploymentsOptions
  TextAnalysisAuthoringTrainingConfigVersion:
    description: Represents a training config version.
    required:
      - trainingConfigVersion
      - modelExpirationDate
    type: object
    properties:
      trainingConfigVersion:
        description: Represents the version of the config.
        type: string
      modelExpirationDate:
        format: date
        description: Represents the training config version expiration date.
        type: string
    x-ms-client-name: TrainingConfigVersion
  TextAnalysisAuthoringTrainingConfigVersions:
    description: Represents a list of training config versions.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: The list of the training config versions.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringTrainingConfigVersion'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: TrainingConfigVersions
  TextAnalysisAuthoringTrainingJobOptions:
    description: Represents the options for starting a new training job.
    required:
      - modelLabel
      - trainingConfigVersion
    type: object
    properties:
      modelLabel:
        description: Represents the output model label.
        type: string
      trainingConfigVersion:
        description: Represents training config version.
        type: string
      evaluationOptions:
        description: >-
          Represents the evaluation options. By default, the evaluation kind is
          percentage, with training split percentage as 80, and testing split
          percentage as 20.
        $ref: '#/definitions/TextAnalysisAuthoringEvaluationOptions'
    x-ms-client-name: TrainingJobOptions
  TextAnalysisAuthoringTrainingJobResult:
    description: Represents the output of a training job.
    required:
      - modelLabel
      - trainingConfigVersion
      - trainingStatus
    type: object
    properties:
      modelLabel:
        description: Represents trained model label.
        type: string
      trainingConfigVersion:
        description: Represents training config version.
        type: string
      trainingStatus:
        description: Represents model train status.
        $ref: '#/definitions/TextAnalysisAuthoringSubTrainingJobState'
      evaluationStatus:
        description: Represents model evaluation status.
        $ref: '#/definitions/TextAnalysisAuthoringSubTrainingJobState'
      estimatedEndDateTime:
        format: date-time
        description: Represents the estimate end date time for training and evaluation.
        type: string
    x-ms-client-name: TrainingJobResult
  TextAnalysisAuthoringTrainingJobs:
    description: Represents a list of retrieved training jobs.
    required:
      - value
      - nextLink
    type: object
    properties:
      value:
        description: The list of jobs.
        type: array
        items:
          $ref: '#/definitions/TextAnalysisAuthoringTrainingJobState'
      nextLink:
        description: The next page link.
        type: string
        x-nullable: true
    x-ms-client-name: TrainingJobs
  TextAnalysisAuthoringTrainingJobState:
    description: Represents the state of a training job.
    required:
      - result
    type: object
    allOf:
      - $ref: '#/definitions/TextAnalysisAuthoringJobState'
    properties:
      result:
        description: Represents training tasks detailed result.
        $ref: '#/definitions/TextAnalysisAuthoringTrainingJobResult'
    x-ms-client-name: TrainingJobState
  TextAnalysisAuthoringWarning:
    description: Represents a warning that was encountered while executing the request.
    required:
      - code
      - message
    type: object
    properties:
      code:
        description: The warning code.
        type: string
      message:
        description: The warning message.
        type: string
    x-ms-client-name: Warning
parameters:
  TextAnalysisAuthoringStringIndexTypeQueryParameter:
    in: query
    name: stringIndexType
    description: >-
      Specifies the method used to interpret string offsets. For additional
      information see https://aka.ms/text-analytics-offsets.
    required: true
    type: string
    enum:
      - Utf16CodeUnit
    x-ms-enum:
      name: StringIndexType
      modelAsString: true
      values:
        - value: Utf16CodeUnit
          description: >-
            The offset and length values will correspond to UTF-16 code units.
            Use this option if your application is written in a language that
            support Unicode, for example Java, JavaScript.
    x-ms-parameter-location: method
  TextAnalysisAuthoringJobIdPathParameter:
    in: path
    name: jobId
    description: The job ID.
    required: true
    type: string
    x-ms-parameter-location: method
  TextAnalysisAuthoringTrainedModelLabelPathParameter:
    in: path
    name: trainedModelLabel
    description: The trained model label.
    required: true
    type: string
    x-ms-parameter-location: method
  TextAnalysisAuthoringProjectKindQueryParameter:
    in: query
    name: projectKind
    description: The project kind.
    required: true
    type: string
    enum:
      - CustomSingleLabelClassification
      - CustomMultiLabelClassification
      - CustomEntityRecognition
    x-ms-enum:
      name: ProjectKind
      modelAsString: true
      values:
        - value: CustomSingleLabelClassification
          description: >-
            For building a classification model to classify text using your own
            data. Each file will have only one label. For example, file 1 is
            classified as A and file 2 is classified as B.
        - value: CustomMultiLabelClassification
          description: >-
            For building a classification model to classify text using your own
            data. Each file can have one or many labels. For example, file 1 is
            classified as A, B, and C and file 2 is classified as B and C.
        - value: CustomEntityRecognition
          description: >-
            For building an extraction model to identify your domain categories
            using your own data.
    x-ms-parameter-location: method
tags:
  - name: Authoring