Microsoft Azure Microsoft Cognitive Language Service Analyze Text Authoring

swagger: '2.0'
info:
  title: Microsoft Azure Microsoft Cognitive Language Service - Analyze Text Authoring
  version: 2023-04-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:
  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/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}/:authorize-copy:
    post:
      description: >-
        Generates a copy project operation authorization to the current target
        Azure resource.
      operationId: microsoftAzureTextanalysisauthoringCopyprojectauthorization
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - in: body
          name: body
          description: The copy project authorization info.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringCopyAuthorizationOptions'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Payload to send to source resource to initiate project copying.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringCopyProjectOptions'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Copy Project Authorization:
          $ref: >-
            ./examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json
      summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :authorize Copy
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/:copy:
    post:
      description: Copies an existing project to another Azure resource.
      operationId: microsoftAzureTextanalysisauthoringCopyproject
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - in: body
          name: body
          description: The copy project info.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringCopyProjectOptions'
        - $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 Copy Project:
          $ref: ./examples/analyzetext-authoring/SuccessfulCopyProject.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :copy
      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
        - in: query
          name: trainedModelLabel
          description: >-
            Trained model label to export. If the trainedModelLabel is null, the
            default behavior is to export the current working copy.
          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: header
          name: format
          description: >-
            The format of the project to import. The currently supported formats
            are json and aml formats. If not provided, the default is set to
            json.
          type: string
          x-ms-parameter-location: method
        - 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}/copy/jobs/{jobId}:
    get:
      description: Gets the status of an existing copy project job.
      operationId: microsoftAzureTextanalysisauthoringGetcopyprojectstatus
      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/TextAnalysisAuthoringCopyProjectJobState'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Copy Project Status:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Copy Jobs Jobid
      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}/:delete-from-resources:
    post:
      description: Deletes a project deployment from the specified assigned resources.
      operationId: microsoftAzureTextanalysisauthoringDeletedeploymentfromresources
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: common.json#/parameters/DeploymentNamePathParameter
        - in: body
          name: body
          description: The options for deleting the deployment.
          required: true
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringDeleteDeploymentOptions'
        - $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/SuccessfulDeleteDeploymentFromResources.json
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments Deploymentname :delete From Resources
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}:
    get:
      description: >-
        Gets the status of an existing delete deployment from specific resources
        job.
      operationId: >-
        microsoftAzureTextanalysisauthoringGetdeploymentdeletefromresourcesstatus
      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 Delete From Resources Jobs Jobid
      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}/exported-models:
    get:
      description: Lists the exported models belonging to a project.
      operationId: microsoftAzureTextanalysisauthoringListexportedmodels
      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 exported models.
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringExportedTrainedModels'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful List Exported Models:
          $ref: ./examples/analyzetext-authoring/SuccessfulListExportedModels.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models
      tags:
        - Authoring
  /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}:
    get:
      description: Gets the details of an exported model.
      operationId: microsoftAzureTextanalysisauthoringGetexportedmodel
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Exported model info
          schema:
            $ref: '#/definitions/TextAnalysisAuthoringExportedTrainedModel'
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Get Exported Model:
          $ref: ./examples/analyzetext-authoring/SuccessfulGetExportedModel.json
      summary: >-
        Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname
      tags:
        - Authoring
    delete:
      description: Deletes an existing exported model.
      operationId: microsoftAzureTextanalysisauthoringDeleteexportedmodel
      produces:
        - application/json
      parameters:
        - $ref: common.json#/parameters/ProjectNamePathParameter
        - $ref: '#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter'
        - $ref: common.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: >-
            A successful call results in triggering the deletion of the exported
            model.
          headers:
            operation-location:
              description: The location of the status API for monitoring the deletion job.
              type: string
        default:
          description: Error response.
          schema:
            $ref: common.json#/definitions/ErrorResponse
      x-ms-examples:
        Successful Delete Exported Model:
          $ref: ./examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Delete Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname
      tags:
        - Authoring
    put:
      descr

# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-cognitive-language-service-analyze-text-authoring-openapi-original.yml