swagger: '2.0'
info:
  title: Microsoft Azure LUIS Authoring Client
  version: 3.0-preview
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}/luis/authoring/v3.0-preview'
  useSchemePrefix: false
  parameters:
    - $ref: '#/parameters/Endpoint'
securityDefinitions:
  apiKeyHeader:
    type: apiKey
    name: Ocp-Apim-Subscription-Key
    in: header
security:
  - apiKeyHeader: []
paths:
  /apps/{appId}/versions/{versionId}/phraselists:
    post:
      description: Creates a new phraselist feature in a version of the application.
      operationId: microsoftAzureFeaturesAddphraselist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: phraselistCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/PhraselistCreateObject'
          description: >-
            A Phraselist object containing Name, comma-separated Phrases and the
            isExchangeable boolean. Default value for isExchangeable is true.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created feature.
          schema:
            $ref: '#/definitions/FeatureIDResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Create Phraselist Feature request:
          $ref: ./examples/features/SuccessfulCreatePhraselistFeatureRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Phraselists
      tags:
        - Apps
    get:
      description: Gets all the phraselist features in a version of the application.
      operationId: microsoftAzureFeaturesListphraselists
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of all phraselist features.
          schema:
            $ref: '#/definitions/PhraseListFeatureInfoList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Phraselist Features request:
          $ref: >-
            ./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Phraselists
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/features:
    get:
      description: >-
        Gets all the extraction phraselist and pattern features in a version of
        the application.
      operationId: microsoftAzureFeaturesList
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: >-
            A list of all phraselist features and a list of all pattern
            features.
          schema:
            $ref: '#/definitions/FeaturesResponseObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Features request:
          $ref: >-
            ./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Features
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/phraselists/{phraselistId}:
    get:
      description: Gets phraselist feature info in a version of the application.
      operationId: microsoftAzureFeaturesGetphraselist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: phraselistId
          in: path
          description: The ID of the feature to be retrieved.
          required: true
          type: integer
      responses:
        '200':
          description: A phraselist feature info.
          schema:
            $ref: '#/definitions/PhraseListFeatureInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Phraselist Feature Info request:
          $ref: ./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Phraselists Phraselistid
      tags:
        - Apps
    put:
      description: >-
        Updates the phrases, the state and the name of the phraselist feature in
        a version of the application.
      operationId: microsoftAzureFeaturesUpdatephraselist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: phraselistId
          in: path
          description: The ID of the feature to be updated.
          required: true
          type: integer
        - name: phraselistUpdateObject
          in: body
          schema:
            $ref: '#/definitions/PhraselistUpdateObject'
          description: >-
            The new values for: - Just a boolean called IsActive, in which case
            the status of the feature will be changed. - Name, Pattern, Mode,
            and a boolean called IsActive to update the feature.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated phraselist.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Phraselist Feature Info request:
          $ref: >-
            ./examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Phraselists Phraselistid
      tags:
        - Apps
    delete:
      description: Deletes a phraselist feature from a version of the application.
      operationId: microsoftAzureFeaturesDeletephraselist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: phraselistId
          in: path
          description: The ID of the feature to be deleted.
          required: true
          type: integer
      responses:
        '200':
          description: Successfully deleted phraselist.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Phraselist Feature Info request:
          $ref: >-
            ./examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Phraselists Phraselistid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/example:
    post:
      description: Adds a labeled example utterance in a version of the application.
      operationId: microsoftAzureExamplesAdd
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/EnableNestedChildren'
        - name: exampleLabelObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ExampleLabelObject'
          description: A labeled example utterance with the expected intent and entities.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created example utterance.
          schema:
            $ref: '#/definitions/LabelExampleResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Label request:
          $ref: ./examples/examples/SuccessfulAddLabelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Example
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/examples:
    post:
      description: >-
        Adds a batch of labeled example utterances to a version of the
        application.
      operationId: microsoftAzureExamplesBatch
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/EnableNestedChildren'
        - name: exampleLabelObjectArray
          in: body
          required: true
          schema:
            $ref: '#/definitions/ExampleLabelObjectArray'
          description: Array of example utterances.
      consumes:
        - application/json
      responses:
        '201':
          description: >-
            A string array determining which labeled example utterances were
            added successfully.
          schema:
            $ref: '#/definitions/BatchLabelExampleResponse'
        '207':
          description: >-
            Indicates that the request was partially successful. The response
            contains a string array indicating the status of each of the added
            labeled example utterances.
          schema:
            $ref: '#/definitions/BatchLabelExampleResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Batch Add Labels request:
          $ref: ./examples/examples/SuccessfulBatchAddLabelsRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Examples
      tags:
        - Apps
    get:
      description: >-
        Returns example utterances to be reviewed from a version of the
        application.
      operationId: microsoftAzureExamplesList
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
        - $ref: '#/parameters/EnableNestedChildren'
      responses:
        '200':
          description: >-
            A list of predictions and label pairs for every example utterance in
            the application.
          schema:
            $ref: '#/definitions/LabeledUtterances'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Review Labeled Examples request:
          $ref: ./examples/examples/SuccessfulReviewLabeledExamplesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Examples
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/examples/{exampleId}:
    delete:
      description: >-
        Deletes the labeled example utterances with the specified ID from a
        version of the application.
      operationId: microsoftAzureExamplesDelete
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: exampleId
          in: path
          description: The example ID.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Successfully deleted example utterance.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Example Label request:
          $ref: ./examples/examples/SuccessfulDeleteExampleLabelRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Examples Exampleid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/intents:
    post:
      description: Adds an intent to a version of the application.
      operationId: microsoftAzureModelAddintent
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: intentCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelCreateObject'
          description: A model object containing the name of the new intent.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created intent model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Create Intent Classifier request:
          $ref: ./examples/model/SuccessfulCreateIntentClassifierRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Intents
      tags:
        - Apps
    get:
      description: >-
        Gets information about the intent models in a version of the
        application.
      operationId: microsoftAzureModelListintents
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of intent model infos.
          schema:
            $ref: '#/definitions/IntentClassifiersList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Intent Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Intents
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities:
    post:
      description: Adds an entity extractor to a version of the application.
      operationId: microsoftAzureModelAddentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityModelCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/EntityModelCreateObject'
          description: >-
            A model object containing the name of the new entity extractor and
            its children.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Create Entity Extractor request:
          $ref: ./examples/model/SuccessfulCreateEntityExtractorRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Entities
      tags:
        - Apps
    get:
      description: >-
        Gets information about all the simple entity models in a version of the
        application.
      operationId: microsoftAzureModelListentities
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of entity model infos.
          schema:
            $ref: '#/definitions/NDepthEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Entity Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Entities
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/hierarchicalentities:
    get:
      description: >-
        Gets information about all the hierarchical entity models in a version
        of the application.
      operationId: microsoftAzureModelListhierarchicalentities
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of hierarchical entity model infos.
          schema:
            $ref: '#/definitions/HierarchicalEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Hierarchical Entity Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Hierarchicalentities
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/compositeentities:
    get:
      description: >-
        Gets information about all the composite entity models in a version of
        the application.
      operationId: microsoftAzureModelListcompositeentities
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of composite entity model infos.
          schema:
            $ref: '#/definitions/CompositeEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Composite Entity Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Compositeentities
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/closedlists:
    get:
      description: >-
        Gets information about all the list entity models in a version of the
        application.
      operationId: microsoftAzureModelListclosedlists
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of list entity model infos.
          schema:
            $ref: '#/definitions/ClosedListEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Closed List Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Closedlists
      tags:
        - Apps
    post:
      description: Adds a list entity model to a version of the application.
      operationId: microsoftAzureModelAddclosedlist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: closedListModelCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ClosedListModelCreateObject'
          description: >-
            A model containing the name and words for the new list entity
            extractor.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Create Closed List Entity Model request:
          $ref: ./examples/model/SuccessfulCreateClosedListEntityModelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Closedlists
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/prebuilts:
    post:
      description: Adds a list of prebuilt entities to a version of the application.
      operationId: microsoftAzureModelAddprebuilt
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: prebuiltExtractorNames
          in: body
          required: true
          schema:
            $ref: '#/definitions/PrebuiltExtractorNames'
          description: An array of prebuilt entity extractor names.
      consumes:
        - application/json
      responses:
        '201':
          description: An array of the created prebuilt extractor infos.
          schema:
            $ref: '#/definitions/PrebuiltEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Application Version Prebuilt Infos request:
          $ref: >-
            ./examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Prebuilts
      tags:
        - Apps
    get:
      description: >-
        Gets information about all the prebuilt entities in a version of the
        application.
      operationId: microsoftAzureModelListprebuilts
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of prebuilt entity models infos.
          schema:
            $ref: '#/definitions/PrebuiltEntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Prebuilt Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Prebuilts
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/listprebuilts:
    get:
      description: >-
        Gets all the available prebuilt entities in a version of the
        application.
      operationId: microsoftAzureModelListprebuiltentities
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: A list of the possible prebuilt entity extractors.
          schema:
            $ref: '#/definitions/AvailablePrebuiltEntityModels'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Available Prebuilt Entity Extractors request:
          $ref: >-
            ./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Listprebuilts
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/models:
    get:
      description: >-
        Gets information about all the intent and entity models in a version of
        the application.
      operationId: microsoftAzureModelListmodels
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of application model infos.
          schema:
            $ref: '#/definitions/ModelsInfoResponseObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version Model Infos request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Models
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/models/{modelId}/examples:
    get:
      description: >-
        Gets the example utterances for the given intent or entity model in a
        version of the application.
      operationId: microsoftAzureModelExamples
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: modelId
          in: path
          required: true
          type: string
          description: The ID (GUID) of the model.
          x-ms-parameter-location: method
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of example utterances for the model.
          schema:
            $ref: '#/definitions/ExamplesPerModelResponseObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Examples Per Model Request:
          $ref: ./examples/model/SuccessfulGetExamplesPerModelRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Models Modelid Examples
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/intents/{intentId}:
    get:
      description: Gets information about the intent model in a version of the application.
      operationId: microsoftAzureModelGetintent
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
      responses:
        '200':
          description: An intent model info.
          schema:
            $ref: '#/definitions/IntentClassifier'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Intent Info request:
          $ref: ./examples/model/SuccessfulGetIntentInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Intents Intentid
      tags:
        - Apps
    put:
      description: Updates the name of an intent in a version of the application.
      operationId: microsoftAzureModelUpdateintent
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - name: modelUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelUpdateObject'
          description: A model object containing the new intent name.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Rename Intent Model request:
          $ref: ./examples/model/SuccessfulRenameIntentModelRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Intents Intentid
      tags:
        - Apps
    delete:
      description: Deletes an intent from a version of the application.
      operationId: microsoftAzureModelDeleteintent
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - name: deleteUtterances
          in: query
          type: boolean
          description: >-
            If true, deletes the intent's example utterances. If false, moves
            the example utterances to the None intent. The default value is
            false.
          default: false
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Intent Model request:
          $ref: ./examples/model/SuccessfulDeleteIntentModelRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Intents Intentid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities/{entityId}:
    get:
      description: Gets information about an entity model in a version of the application.
      operationId: microsoftAzureModelGetentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity model info.
          schema:
            $ref: '#/definitions/NDepthEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Entity Info request:
          $ref: ./examples/model/SuccessfulGetEntityInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Entities Entityid
      tags:
        - Apps
    delete:
      description: Deletes an entity or a child from a version of the application.
      operationId: microsoftAzureModelDeleteentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity extractor or the child entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully deleted entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Entity Info request:
          $ref: ./examples/model/SuccessfulDeleteEntityExtractorRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Entities Entityid
      tags:
        - Apps
    patch:
      description: >-
        Updates the name of an entity extractor or the name and instanceOf model
        of a child entity extractor.
      operationId: microsoftAzureModelUpdateentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity extractor or the child entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: entityModelUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/EntityModelUpdateObject'
          description: >-
            A model object containing the name new entity extractor or the name
            and instance of model of a child entity extractor 
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Entity Extractor request:
          $ref: ./examples/model/SuccessfulUpdateEntityExtractorRequest.json
      summary: Microsoft Azure Patch Apps Appid Versions Versionid Entities Entityid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/intents/{intentId}/features:
    post:
      description: >-
        Adds a new feature relation to be used by the intent in a version of the
        application.
      operationId: microsoftAzureFeaturesAddintentfeature
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - name: featureRelationCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelFeatureInformation'
          description: A Feature relation information object.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Feature Relation request:
          $ref: ./examples/model/SuccessfulAddIntentFeatureRelationRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Intents Intentid Features
      tags:
        - Apps
    get:
      description: >-
        Gets the information of the features used by the intent in a version of
        the application.
      operationId: microsoftAzureModelGetintentfeatures
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
      responses:
        '200':
          description: A list of feature information objects for the intent.
          schema:
            $ref: '#/definitions/FeaturesPerModelResponseObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Features information request:
          $ref: ./examples/model/SuccessfulGetIntentFeaturesInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Intents Intentid Features
      tags:
        - Apps
    put:
      description: >-
        Updates the information of the features used by the intent in a version
        of the application.
      operationId: microsoftAzureModelReplaceintentfeatures
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - name: featureRelationsUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/FeaturesPerModelResponseObject'
          description: >-
            A list of feature information objects containing the new feature
            relations.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Replace Features request:
          $ref: ./examples/model/SuccessfulReplaceIntentFeaturesRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Intents Intentid Features
      tags:
        - Apps
    delete:
      description: >-
        Deletes a relation from the feature relations used by the intent in a
        version of the application.
      operationId: microsoftAzureModelDeleteintentfeature
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - name: featureRelationDeleteObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelFeatureInformation'
          description: >-
            A feature information object containing the feature relation to
            delete.
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete feature relation request:
          $ref: ./examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Intents Intentid Features
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities/{entityId}/features:
    post:
      description: >-
        Adds a new feature relation to be used by the entity in a version of the
        application.
      operationId: microsoftAzureFeaturesAddentityfeature
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/EntityIdInPath'
        - name: featureRelationCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelFeatureInformation'
          description: A Feature relation information object.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Feature Relation request:
          $ref: ./examples/model/SuccessfulAddEntityFeatureRelationRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Entities Entityid Features
      tags:
        - Apps
    get:
      description: >-
        Gets the information of the features used by the entity in a version of
        the application.
      operationId: microsoftAzureModelGetentityfeatures
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/EntityIdInPath'
      responses:
        '200':
          description: A list of feature information objects for the entity.
          schema:
            $ref: '#/definitions/FeaturesPerModelResponseObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Features information request:
          $ref: ./examples/model/SuccessfulGetEntityFeaturesInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Entities Entityid Features
      tags:
        - Apps
    put:
      description: >-
        Updates the information of the features used by the entity in a version
        of the application.
      operationId: microsoftAzureModelReplaceentityfeatures
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/EntityIdInPath'
        - name: featureRelationsUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/FeaturesPerModelResponseObject'
          description: >-
            A list of feature information objects containing the new feature
            relations.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Replace Features request:
          $ref: ./examples/model/SuccessfulReplaceEntityFeaturesRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Entities Entityid Features
      tags:
        - Apps
    delete:
      description: >-
        Deletes a relation from the feature relations used by the entity in a
        version of the application.
      operationId: microsoftAzureModelDeleteentityfeature
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/EntityIdInPath'
        - name: featureRelationDeleteObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelFeatureInformation'
          description: >-
            A feature information object containing the feature relation to
            delete.
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete feature relation request:
          $ref: ./examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Entities Entityid Features
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}:
    get:
      description: >-
        Gets information about a hierarchical entity in a version of the
        application.
      operationId: microsoftAzureModelGethierarchicalentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
      responses:
        '200':
          description: A hierarchical entity model info.
          schema:
            $ref: '#/definitions/HierarchicalEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Hierarchical Entity Info request:
          $ref: ./examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Hierarchicalentities Hentityid
      tags:
        - Apps
    patch:
      description: >-
        Updates the name of a hierarchical entity model in a version of the
        application.
      operationId: microsoftAzureModelUpdatehierarchicalentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: modelUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ModelUpdateObject'
          description: Model containing names of the hierarchical entity.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Hierarchical Entity Info request:
          $ref: ./examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json
      summary: Microsoft Azure Patch Apps Appid Versions Versionid Hierarchicalentities Hentityid
      tags:
        - Apps
    delete:
      description: Deletes a hierarchical entity from a version of the application.
      operationId: microsoftAzureModelDeletehierarchicalentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
      responses:
        '200':
          description: Successfully deleted entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Hierarchical Entity Model request:
          $ref: ./examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Hierarchicalentities Hentityid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}:
    get:
      description: >-
        Gets information about a composite entity in a version of the
        application.
      operationId: microsoftAzureModelGetcompositeentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
      responses:
        '200':
          description: The composite entity model info.
          schema:
            $ref: '#/definitions/CompositeEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Composite Entity Info request:
          $ref: ./examples/model/SuccessfulGetCompositeEntityInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Compositeentities Centityid
      tags:
        - Apps
    put:
      description: Updates a composite entity in a version of the application.
      operationId: microsoftAzureModelUpdatecompositeentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: compositeModelUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/CompositeEntityModel'
          description: >-
            A model object containing the new entity extractor name and
            children.
      consumes:
        - application/json
      x-ms-examples:
        Successful Update Composite Entity Extractor request:
          $ref: ./examples/model/SuccessfulUpdateCompositeEntityModelRequest.json
      produces:
        - application/json
      responses:
        '200':
          description: Successfully updated composite entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Apps Appid Versions Versionid Compositeentities Centityid
      tags:
        - Apps
    delete:
      description: Deletes a composite entity from a version of the application.
      operationId: microsoftAzureModelDeletecompositeentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
      responses:
        '200':
          description: Successfully deleted composite entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Entity Info request:
          $ref: ./examples/model/SuccessfulDeleteCompositeEntityModelRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Compositeentities Centityid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/closedlists/{clEntityId}:
    get:
      description: Gets information about a list entity in a version of the application.
      operationId: microsoftAzureModelGetclosedlist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list model ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: The list model info.
          schema:
            $ref: '#/definitions/ClosedListEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Closed List Entity Info request:
          $ref: ./examples/model/SuccessfulGetClosedListEntityInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Closedlists Clentityid
      tags:
        - Apps
    put:
      description: Updates the list entity in a version of the application.
      operationId: microsoftAzureModelUpdateclosedlist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list model ID.
          required: true
          type: string
          format: uuid
        - name: closedListModelUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ClosedListModelUpdateObject'
          description: The new list entity name and words list.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated list entity name and words list.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Closed List Entity Info request:
          $ref: ./examples/model/SuccessfulUpdateClosedListEntityModelRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Closedlists Clentityid
      tags:
        - Apps
    patch:
      description: >-
        Adds a batch of sublists to an existing list entity in a version of the
        application.
      operationId: microsoftAzureModelPatchclosedlist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list entity model ID.
          required: true
          type: string
          format: uuid
        - name: closedListModelPatchObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ClosedListModelPatchObject'
          description: A words list batch.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully added sublists to the list entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add SubLists to Closed List Entity request:
          $ref: ./examples/model/SuccessfulPatchClosedListEntityModelRequest.json
      summary: Microsoft Azure Patch Apps Appid Versions Versionid Closedlists Clentityid
      tags:
        - Apps
    delete:
      description: Deletes a list entity model from a version of the application.
      operationId: microsoftAzureModelDeleteclosedlist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list entity model ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully delete list entity from a version of application.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Closed List Entity Info request:
          $ref: ./examples/model/SuccessfulDeleteClosedListEntityModelRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Closedlists Clentityid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}:
    get:
      description: >-
        Gets information about a prebuilt entity model in a version of the
        application.
      operationId: microsoftAzureModelGetprebuilt
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: prebuiltId
          in: path
          description: The prebuilt entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A prebuilt entity models info.
          schema:
            $ref: '#/definitions/PrebuiltEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Prebuilt Info request:
          $ref: ./examples/model/SuccessfulGetPrebuiltInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Prebuilts Prebuiltid
      tags:
        - Apps
    delete:
      description: Deletes a prebuilt entity extractor from a version of the application.
      operationId: microsoftAzureModelDeleteprebuilt
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: prebuiltId
          in: path
          description: The prebuilt entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Prebuilt Info request:
          $ref: ./examples/model/SuccessfulDeletePrebuiltEntityRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Prebuilts Prebuiltid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}:
    delete:
      description: >-
        Deletes a sublist of a specific list entity model from a version of the
        application.
      operationId: microsoftAzureModelDeletesublist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: subListId
          in: path
          description: The sublist ID.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Successfully deleted sublist.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Sublist request:
          $ref: ./examples/model/SuccessfulDeleteSublistRequest.json
      summary: >-
        Microsoft Azure Delete Apps Appid Versions Versionid Closedlists Clentityid Sublists Sublistid
      tags:
        - Apps
    put:
      description: >-
        Updates one of the list entity's sublists in a version of the
        application.
      operationId: microsoftAzureModelUpdatesublist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: subListId
          in: path
          description: The sublist ID.
          required: true
          type: integer
          format: int64
        - name: wordListBaseUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/WordListBaseUpdateObject'
          description: >-
            A sublist update object containing the new canonical form and the
            list of words.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated sublist.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Sublist request:
          $ref: ./examples/model/SuccessfulUpdateSublistRequest.json
      summary: >-
        Microsoft Azure Put Apps Appid Versions Versionid Closedlists Clentityid Sublists Sublistid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/intents/{intentId}/suggest:
    get:
      description: >-
        Suggests example utterances that would improve the accuracy of the
        intent model in a version of the application.
      operationId: microsoftAzureModelListintentsuggestions
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - $ref: '#/parameters/TakeInPath'
        - $ref: '#/parameters/EnableNestedChildren'
      responses:
        '200':
          description: >-
            If there's no trained intent model, nothing is returned in the
            response. If there's a trained model and active learning finds any
            relevant queries, they are returned with the intent model
            predictions. If there's a trained model but active learning didn't
            find any relevant queries, an empty list is returned in the
            response.
          schema:
            $ref: '#/definitions/IntentsSuggestionExamples'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Intents Suggestion Examples:
          $ref: ./examples/model/SuccessfulGetIntentsSuggestionExamples.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Intents Intentid Suggest
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities/{entityId}/suggest:
    get:
      description: >-
        Get suggested example utterances that would improve the accuracy of the
        entity model in a version of the application.
      operationId: microsoftAzureModelListentitysuggestions
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The target entity extractor model to enhance.
          required: true
          type: string
          format: uuid
        - $ref: '#/parameters/TakeInPath'
        - $ref: '#/parameters/EnableNestedChildren'
      responses:
        '200':
          description: >-
            If there's no trained entity model, nothing is returned in the
            response. If there's a trained model and active learning finds any
            relevant queries, they are returned with the entity model
            predictions. If there's a trained model but active learning didn't
            find any relevant queries, an empty list is returned in the
            response.
          schema:
            $ref: '#/definitions/EntitiesSuggestionExamples'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Entity Suggestion Examples:
          $ref: ./examples/model/SuccessfulGetEntitySuggestionExamples.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Entities Entityid Suggest
      tags:
        - Apps
  /apps/:
    post:
      description: Creates a new LUIS app.
      operationId: microsoftAzureAppsAdd
      parameters:
        - name: applicationCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ApplicationCreateObject'
          description: >-
            An application containing Name, Description (optional), Culture,
            Usage Scenario (optional), Domain (optional) and initial version ID
            (optional) of the application. Default value for the version ID is
            "0.1". Note: the culture cannot be changed after the app is created.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created application.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Application Creation:
          $ref: ./examples/apps/SuccessfulAddApplicationRequest.json
      summary: 'Microsoft Azure Post Apps'
      tags:
        - Apps
    get:
      description: Lists all of the user's applications.
      operationId: microsoftAzureAppsList
      parameters:
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of the user applications.
          schema:
            $ref: '#/definitions/ApplicationsInfoList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Applications List request:
          $ref: ./examples/apps/SuccessfulGetApplicationsListRequest.json
      summary: 'Microsoft Azure Get Apps'
      tags:
        - Apps
  /apps/import:
    post:
      description: >-
        Imports an application to LUIS, the application's structure is included
        in the request body.
      operationId: microsoftAzureAppsImport
      parameters:
        - name: appName
          in: query
          description: >-
            The application name to create. If not specified, the application
            name will be read from the imported object. If the application name
            already exists, an error is returned.
          type: string
        - name: luisApp
          in: body
          required: true
          schema:
            $ref: '#/definitions/LuisApp'
          description: A LUIS application structure.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the imported application.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Import Application:
          $ref: ./examples/apps/SuccessfulImportApplicationRequest.json
      summary: Microsoft Azure Post Apps Import
      tags:
        - Apps
  /apps/assistants:
    get:
      description: Gets the endpoint URLs for the prebuilt Cortana applications.
      operationId: microsoftAzureAppsListcortanaendpoints
      responses:
        '200':
          description: >-
            A personal assistant apps JSON object containing the endpoint URLs
            for Cortana applications and the user's endpoint keys.
          schema:
            $ref: '#/definitions/PersonalAssistantsResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Personal Assistant Applications:
          $ref: ./examples/apps/SuccessfulGetPersonalAssistantApplications.json
      summary: Microsoft Azure Get Apps Assistants
      tags:
        - Apps
  /apps/domains:
    get:
      description: Gets the available application domains.
      operationId: microsoftAzureAppsListdomains
      responses:
        '200':
          description: A list object containing the available application domains.
          schema:
            $ref: '#/definitions/AvailableDomains'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Domains request:
          $ref: ./examples/apps/SuccessfulGetApplicationDomainsRequest.json
      summary: Microsoft Azure Get Apps Domains
      tags:
        - Apps
  /apps/usagescenarios:
    get:
      description: Gets the application available usage scenarios.
      operationId: microsoftAzureAppsListusagescenarios
      responses:
        '200':
          description: A list object containing the available application usage scenarios.
          schema:
            $ref: '#/definitions/ApplicationUsageScenarios'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Usage Scenarios request:
          $ref: >-
            ./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json
      summary: Microsoft Azure Get Apps Usagescenarios
      tags:
        - Apps
  /apps/cultures:
    get:
      description: >-
        Gets a list of supported cultures. Cultures are equivalent to the
        written language and locale. For example,"en-us" represents the U.S.
        variation of English.
      operationId: microsoftAzureAppsListsupportedcultures
      responses:
        '200':
          description: A list object containing the supported application cultures.
          schema:
            $ref: '#/definitions/AvailableCultures'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Cultures request:
          $ref: ./examples/apps/SuccessfulGetApplicationCulturesRequest.json
      summary: Microsoft Azure Get Apps Cultures
      tags:
        - Apps
  /apps/{appId}/querylogs:
    get:
      description: Gets the logs of the past month's endpoint queries for the application.
      operationId: microsoftAzureAppsDownloadquerylogs
      parameters:
        - $ref: '#/parameters/AppIdInPath'
      responses:
        '200':
          description: A CSV file containing the query logs for the past month.
          schema:
            type: object
            format: file
            description: The query logs of an application for the past month in CSV format.
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/octet-stream
      x-ms-examples:
        Successful Download Application Query logs request:
          $ref: ./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json
      summary: Microsoft Azure Get Apps Appid Querylogs
      tags:
        - Apps
  /apps/{appId}:
    get:
      description: Gets the application info.
      operationId: microsoftAzureAppsGet
      parameters:
        - $ref: '#/parameters/AppIdInPath'
      responses:
        '200':
          description: The application info.
          schema:
            $ref: '#/definitions/ApplicationInfoResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Info request:
          $ref: ./examples/apps/SuccessfulGetApplicationInfoRequest.json
      summary: Microsoft Azure Get Apps Appid
      tags:
        - Apps
    put:
      description: Updates the name or description of the application.
      operationId: microsoftAzureAppsUpdate
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: applicationUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ApplicationUpdateObject'
          description: A model containing Name and Description of the application.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated application name and description.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Rename Application request:
          $ref: ./examples/apps/SuccessfulRenameApplicationRequest.json
      summary: Microsoft Azure Put Apps Appid
      tags:
        - Apps
    delete:
      description: Deletes an application.
      operationId: microsoftAzureAppsDelete
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/ForcePath'
      responses:
        '200':
          description: Successfully deleted application.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Rename Application request:
          $ref: ./examples/apps/SuccessfulDeleteApplicationRequest.json
      summary: Microsoft Azure Delete Apps Appid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/clone:
    post:
      description: Creates a new version from the selected version.
      operationId: microsoftAzureVersionsClone
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: versionCloneObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/TaskUpdateObject'
          description: A model containing the new version ID.
      consumes:
        - application/json
      responses:
        '201':
          description: The new version ID.
          schema:
            type: string
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Clone Application Version request:
          $ref: ./examples/versions/SuccessfulCloneApplicatioVersionRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Clone
      tags:
        - Apps
  /apps/{appId}/publish:
    post:
      description: Publishes a specific version of the application.
      operationId: microsoftAzureAppsPublish
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: applicationPublishObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ApplicationPublishObject'
          description: >-
            The application publish object. The region is the target region that
            the application is published to.
      consumes:
        - application/json
      responses:
        '201':
          description: >-
            An object containing the application endpoint URL, its assigned
            endpoint key and publishing status.
          schema:
            $ref: '#/definitions/ProductionOrStagingEndpointInfo'
        '207':
          description: >-
            An object containing the application endpoint URL, its assigned
            endpoint key and publishing status in case that publishing one or
            more regions failed.
          schema:
            $ref: '#/definitions/ProductionOrStagingEndpointInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Publish Application request:
          $ref: ./examples/apps/SuccessfulPublishApplicationRequest.json
      summary: Microsoft Azure Post Apps Appid Publish
      tags:
        - Apps
  /apps/{appId}/versions:
    get:
      description: Gets a list of versions for this application ID.
      operationId: microsoftAzureVersionsList
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of all versions of the application.
          schema:
            type: array
            items:
              $ref: '#/definitions/VersionInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Versions info request:
          $ref: ./examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json
      summary: Microsoft Azure Get Apps Appid Versions
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/:
    get:
      description: >-
        Gets the version information such as date created, last modified date,
        endpoint URL, count of intents and entities, training and publishing
        status.
      operationId: microsoftAzureVersionsGet
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: A model containing the version info.
          schema:
            $ref: '#/definitions/VersionInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version info request:
          $ref: ./examples/versions/SuccessfulGetApplicationVersionInfoRequest.json
      summary: 'Microsoft Azure Get Apps Appid Versions Versionid'
      tags:
        - Apps
    put:
      description: Updates the name or description of the application version.
      operationId: microsoftAzureVersionsUpdate
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: versionUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/TaskUpdateObject'
          description: A model containing Name and Description of the application.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Rename Application Version request:
          $ref: ./examples/versions/SuccessfulRenameApplicationVersionRequest.json
      summary: 'Microsoft Azure Put Apps Appid Versions Versionid'
      tags:
        - Apps
    delete:
      description: Deletes an application version.
      operationId: microsoftAzureVersionsDelete
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Application Version request:
          $ref: ./examples/versions/SuccessfulDeleteApplicationVersionRequest.json
      summary: 'Microsoft Azure Delete Apps Appid Versions Versionid'
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/export:
    get:
      description: Exports a LUIS application to JSON format.
      operationId: microsoftAzureVersionsExport
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          schema:
            $ref: '#/definitions/LuisApp'
          description: The LUIS application structure in JSON format.
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Export Application Version:
          $ref: ./examples/versions/SuccessfulExportApplicationVersionRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Export
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/train:
    post:
      description: >-
        Sends a training request for a version of a specified LUIS app. This
        POST request initiates a request asynchronously. To determine whether
        the training request is successful, submit a GET request to get training
        status. Note: The application version is not fully trained unless all
        the models (intents and entities) are trained successfully or are up to
        date. To verify training success, get the training status at least once
        after training is complete.
      operationId: microsoftAzureTrainTrainversion
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - in: query
          name: mode
          description: An enum value specifying mode of training.
          type: string
      responses:
        '202':
          description: This response indicates the initial training status.
          schema:
            $ref: '#/definitions/EnqueueTrainingResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Train Application Version request:
          $ref: ./examples/train/SuccessfulTrainApplicationVersionRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Train
      tags:
        - Apps
    get:
      description: >-
        Gets the training status of all models (intents and entities) for the
        specified LUIS app. You must call the train API to train the LUIS app
        before you call this API to get training status. "appID" specifies the
        LUIS app ID. "versionId" specifies the version number of the LUIS app.
        For example, "0.1".
      operationId: microsoftAzureTrainGetstatus
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: >-
            A successful response provides an array of training status details
            for a LUIS app that you submitted for training. Each element in the
            response array provides training status for a model (intent or
            entity) in the LUIS app. Note: Training status is not provided for
            prebuilt entities because they are pretrained. The "modelId"
            property identifies which intent or entity the training status
            corresponds to. To get the name and type of each model, use the
            models API which has a request URL in this format:
            https://westus.api.cognitive.microsoft.com/luis/api/v3.0-preview/apps/{appId}/versions/{versionId}/models
            The details property for each model can contain the following
            fields: "statusId": An integer from 0 to 3 that corresponds to the
            value of the status field. "status": A string with one of the
            following values: "Success", "UpToDate", "InProgress", "Fail". If
            the status is "Fail", the "failureReason" property provides the
            reason for failure. "exampleCount": The number of examples used for
            training. In the case of the None intent or prebuilt domain intents
            and entities, this number includes example provided internally by
            the system as well as examples you added to your LUIS app.
            "failureReason": A string that indicates the reason training
            failed.  The value "FewLabels" means that no labeled example
            utterances were provided for training. "trainingDateTime": A string
            indicating the time the model was last trained. The value uses the
            ISO 8601 format for representing times in UTC (Coordinated Universal
            Time) with a UTC designator ("Z"), for example:
            "2017-08-10T01:08:34Z".
          schema:
            $ref: '#/definitions/ModelTrainingInfoList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
        - JSON
      x-ms-examples:
        Successful Get Application Version Training Status request:
          $ref: >-
            ./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Train
      tags:
        - Apps
  /apps/{appId}/versions/import:
    post:
      description: Imports a new version into a LUIS application.
      operationId: microsoftAzureVersionsImport
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: versionId
          in: query
          description: >-
            The new versionId to import. If not specified, the versionId will be
            read from the imported object.
          type: string
        - name: luisApp
          in: body
          required: true
          schema:
            $ref: '#/definitions/LuisApp'
          description: A LUIS application structure.
      consumes:
        - application/json
      responses:
        '201':
          description: The created application version.
          schema:
            $ref: '#/definitions/VersionResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Import Application:
          $ref: ./examples/versions/SuccessfulImportApplicationVersionRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Import
      tags:
        - Apps
  /apps/{appId}/settings:
    get:
      description: Get the application settings including 'UseAllTrainingData'.
      operationId: microsoftAzureAppsGetsettings
      parameters:
        - $ref: '#/parameters/AppIdInPath'
      responses:
        '200':
          description: The application settings.
          schema:
            $ref: '#/definitions/ApplicationSettings'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Settings request:
          $ref: ./examples/apps/SuccessfulGetApplicationSettingsRequest.json
      summary: Microsoft Azure Get Apps Appid Settings
      tags:
        - Apps
    put:
      description: Updates the application settings including 'UseAllTrainingData'.
      operationId: microsoftAzureAppsUpdatesettings
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: applicationSettingUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ApplicationSettingUpdateObject'
          description: An object containing the new application settings.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated application settings.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Application Settings request:
          $ref: ./examples/apps/SuccessfulUpdateApplicationSettingsRequest.json
      summary: Microsoft Azure Put Apps Appid Settings
      tags:
        - Apps
  /apps/{appId}/publishsettings:
    get:
      description: Get the application publish settings including 'UseAllTrainingData'.
      operationId: microsoftAzureAppsGetpublishsettings
      parameters:
        - $ref: '#/parameters/AppIdInPath'
      responses:
        '200':
          description: The application publish settings.
          schema:
            $ref: '#/definitions/PublishSettings'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Publish Settings request:
          $ref: ./examples/apps/SuccessfulGetPublishSettingsRequest.json
      summary: Microsoft Azure Get Apps Appid Publishsettings
      tags:
        - Apps
    put:
      description: Updates the application publish settings including 'UseAllTrainingData'.
      operationId: microsoftAzureAppsUpdatepublishsettings
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: publishSettingUpdateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/PublishSettingUpdateObject'
          description: An object containing the new publish application settings.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated application settings.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Publish Settings request:
          $ref: ./examples/apps/SuccessfulUpdatePublishSettingsRequest.json
      summary: Microsoft Azure Put Apps Appid Publishsettings
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/suggest:
    delete:
      description: Deleted an unlabelled utterance in a version of the application.
      operationId: microsoftAzureVersionsDeleteunlabelledutterance
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: utterance
          in: body
          required: true
          schema:
            type: string
          description: The utterance text to delete.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Unlabelled Utterance:
          $ref: ./examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Suggest
      tags:
        - Apps
  /apps/{appId}/endpoints:
    get:
      description: Returns the available endpoint deployment regions and URLs.
      operationId: microsoftAzureAppsListendpoints
      parameters:
        - $ref: '#/parameters/AppIdInPath'
      responses:
        '200':
          description: >-
            Returns a list of endpoints regions and their corresponding endpoint
            URL.
          schema:
            $ref: '#/definitions/AvailableEndpoints'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Endpoints request:
          $ref: ./examples/apps/SuccessfulGetEndpointsRequest.json
      summary: Microsoft Azure Get Apps Appid Endpoints
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists:
    post:
      description: >-
        Adds a sublist to an existing list entity in a version of the
        application.
      operationId: microsoftAzureModelAddsublist
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: clEntityId
          in: path
          description: The list entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: wordListCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/WordListObject'
          description: Words list.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the newly created sublist.
          schema:
            type: integer
            format: int64
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Sublist request:
          $ref: >-
            ./examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Closedlists Clentityid Sublists
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltdomains:
    post:
      description: >-
        Adds a customizable prebuilt domain along with all of its intent and
        entity models in a version of the application.
      operationId: microsoftAzureModelAddcustomprebuiltdomain
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: prebuiltDomainObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/PrebuiltDomainCreateBaseObject'
          description: A prebuilt domain create object containing the name of the domain.
      consumes:
        - application/json
      responses:
        '201':
          description: >-
            An array of the created customizable prebuilt domain intent and
            entity model Ids.
          schema:
            $ref: '#/definitions/GuidList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Custom Prebuilt Domain to Application request:
          $ref: >-
            ./examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Customprebuiltdomains
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltintents:
    post:
      description: >-
        Adds a customizable prebuilt intent model to a version of the
        application.
      operationId: microsoftAzureModelAddcustomprebuiltintent
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: prebuiltDomainModelCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/PrebuiltDomainModelCreateObject'
          description: >-
            A model object containing the name of the customizable prebuilt
            intent and the name of the domain to which this model belongs.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created intent model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Custom Prebuilt Intent request:
          $ref: ./examples/model/SuccessfulAddCustomPrebuildIntentRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Customprebuiltintents
      tags:
        - Apps
    get:
      description: >-
        Gets information about customizable prebuilt intents added to a version
        of the application.
      operationId: microsoftAzureModelListcustomprebuiltintents
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: >-
            Returns a list of all customizable prebuilt intents and their
            representations in a version of the application.
          schema:
            $ref: '#/definitions/IntentClassifiersList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Custom Prebuilt Intent request:
          $ref: ./examples/model/SuccessfulGetCustomPrebuildIntentRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Customprebuiltintents
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltentities:
    post:
      description: Adds a prebuilt entity model to a version of the application.
      operationId: microsoftAzureModelAddcustomprebuiltentity
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: prebuiltDomainModelCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/PrebuiltDomainModelCreateObject'
          description: >-
            A model object containing the name of the prebuilt entity and the
            name of the domain to which this model belongs.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created prebuilt model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Custom Prebuilt Entity request:
          $ref: ./examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Customprebuiltentities
      tags:
        - Apps
    get:
      description: Gets all prebuilt entities used in a version of the application.
      operationId: microsoftAzureModelListcustomprebuiltentities
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: Returns a list of all prebuilt entities and their representations.
          schema:
            $ref: '#/definitions/EntityExtractorsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Custom Prebuilt Domain Entities request:
          $ref: >-
            ./examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Customprebuiltentities
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltmodels:
    get:
      description: >-
        Gets all prebuilt intent and entity model information used in a version
        of this application.
      operationId: microsoftAzureModelListcustomprebuiltmodels
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: Returns a list of all prebuilt models and their representations.
          schema:
            $ref: '#/definitions/CustomPrebuiltModelList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Custom Prebuilt Domain Models request:
          $ref: ./examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Customprebuiltmodels
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}:
    delete:
      description: Deletes a prebuilt domain's models in a version of the application.
      operationId: microsoftAzureModelDeletecustomprebuiltdomain
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: domainName
          in: path
          description: Domain name.
          required: true
          type: string
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Prebuilt Domain from Application request:
          $ref: >-
            ./examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json
      summary: Microsoft Azure Delete Apps Appid Versions Versionid Customprebuiltdomains Domainname
      tags:
        - Apps
  /apps/customprebuiltdomains:
    get:
      description: Gets all the available custom prebuilt domains for all cultures.
      operationId: microsoftAzureAppsListavailablecustomprebuiltdomains
      responses:
        '200':
          description: >-
            Returns a list of all custom prebuilt domains and their
            intents/entities representation.
          schema:
            $ref: '#/definitions/PrebuiltDomainsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Available Custom Prebuilt Domains request:
          $ref: >-
            ./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json
      summary: Microsoft Azure Get Apps Customprebuiltdomains
      tags:
        - Apps
    post:
      description: >-
        Adds a prebuilt domain along with its intent and entity models as a new
        application.
      operationId: microsoftAzureAppsAddcustomprebuiltdomain
      parameters:
        - name: prebuiltDomainCreateObject
          in: body
          required: true
          description: >-
            A prebuilt domain create object containing the name and culture of
            the domain.
          schema:
            $ref: '#/definitions/PrebuiltDomainCreateObject'
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created application.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Add Custom Prebuilt Application request:
          $ref: ./examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json
      summary: Microsoft Azure Post Apps Customprebuiltdomains
      tags:
        - Apps
  /apps/customprebuiltdomains/{culture}:
    get:
      description: Gets all the available prebuilt domains for a specific culture.
      operationId: microsoftAzureAppsListavailablecustomprebuiltdomainsforculture
      parameters:
        - name: culture
          in: path
          description: Culture.
          required: true
          type: string
      responses:
        '200':
          description: >-
            Returns a list of all domains and their intents and entities for a
            specific culture.
          schema:
            $ref: '#/definitions/PrebuiltDomainsList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get AvailableCustomPrebuiltDomainsForCulture request:
          $ref: >-
            ./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json
      summary: Microsoft Azure Get Apps Customprebuiltdomains Culture
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities/{entityId}/children:
    post:
      description: >-
        Creates a single child in an existing entity model hierarchy in a
        version of the application.
      operationId: microsoftAzureModelAddentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: childEntityModelCreateObject
          in: body
          required: true
          schema:
            $ref: '#/definitions/ChildEntityModelCreateObject'
          description: >-
            A model object containing the name of the new child model and its
            children.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Create Entity Child Model request:
          $ref: ./examples/model/SuccessfulCreateEntityChildModelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Entities Entityid Children
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}:
    get:
      description: >-
        Gets information about the child's model contained in an hierarchical
        entity child model in a version of the application.
      operationId: microsoftAzureModelGethierarchicalentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: hChildId
          in: path
          description: The hierarchical entity extractor child ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: The hierarchical entity child model info.
          schema:
            $ref: '#/definitions/HierarchicalChildEntity'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Hierarchical Entity Child Info request:
          $ref: >-
            ./examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json
      summary: >-
        Microsoft Azure Get Apps Appid Versions Versionid Hierarchicalentities Hentityid Children Hchildid
      tags:
        - Apps
    patch:
      description: >-
        Renames a single child in an existing hierarchical entity model in a
        version of the application.
      operationId: microsoftAzureModelUpdatehierarchicalentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: hChildId
          in: path
          required: true
          description: The hierarchical entity extractor child ID.
          type: string
          format: uuid
        - name: hierarchicalChildModelUpdateObject
          in: body
          required: true
          schema:
            type: object
            properties:
              name:
                type: string
          description: Model object containing new name of the hierarchical entity child.
      consumes:
        - application/json
      responses:
        '200':
          description: Successfully updated entity child.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Hierarchical Entity Child Model request:
          $ref: ./examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json
      summary: >-
        Microsoft Azure Patch Apps Appid Versions Versionid Hierarchicalentities Hentityid Children Hchildid
      tags:
        - Apps
    delete:
      description: >-
        Deletes a hierarchical entity extractor child in a version of the
        application.
      operationId: microsoftAzureModelDeletehierarchicalentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: hChildId
          in: path
          description: The hierarchical entity extractor child ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully deleted entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Hierarchical Entity Child Model request:
          $ref: ./examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json
      summary: >-
        Microsoft Azure Delete Apps Appid Versions Versionid Hierarchicalentities Hentityid Children Hchildid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children:
    post:
      description: >-
        Creates a single child in an existing composite entity model in a
        version of the application.
      operationId: microsoftAzureModelAddcompositeentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: compositeChildModelCreateObject
          in: body
          required: true
          schema:
            type: object
            properties:
              name:
                type: string
          description: A model object containing the name of the new composite child model.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Create Composite Entity Child Model request:
          $ref: ./examples/model/SuccessfulCreateCompositeChildModelRequest.json
      summary: Microsoft Azure Post Apps Appid Versions Versionid Compositeentities Centityid Children
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}:
    delete:
      description: >-
        Deletes a composite entity extractor child from a version of the
        application.
      operationId: microsoftAzureModelDeletecompositeentitychild
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: cChildId
          in: path
          description: The hierarchical entity extractor child ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully deleted entity.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Delete Composite Entity Child Model request:
          $ref: ./examples/model/SuccessfulDeleteCompositeChildModelRequest.json
      summary: >-
        Microsoft Azure Delete Apps Appid Versions Versionid Compositeentities Centityid Children Cchildid
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/regexentities:
    get:
      summary: >-
        Microsoft Azure Gets Information About The Regular Expression Entity Models In A Version Of The Application
      operationId: microsoftAzureModelListregexentityinfos
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of regular expression entity model infos.
          schema:
            $ref: '#/definitions/RegexEntityExtractorList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Regex Entity Models request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Adds A Regular Expression Entity Model To A Version Of The Application'
      operationId: microsoftAzureModelCreateregexentitymodel
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: regexEntityExtractorCreateObj
          in: body
          description: >-
            A model object containing the name and regex pattern for the new
            regular expression entity extractor.
          required: true
          schema:
            $ref: '#/definitions/RegexModelCreateObject'
      responses:
        '201':
          description: The ID of the created model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Regex Entity Model request:
          $ref: ./examples/model/SuccessfulCreateRegexEntityExtractorRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternanyentities:
    get:
      summary: >-
        Microsoft Azure Get Information About The Pattern Any Entity Models In A Version Of The Application
      operationId: microsoftAzureModelListpatternanyentityinfos
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: A list of Pattern.Any entity model infos.
          schema:
            $ref: '#/definitions/PatternAnyEntityExtractorList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Regex Entity Model request:
          $ref: >-
            ./examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Adds A Pattern Any Entity Extractor To A Version Of The Application'
      operationId: microsoftAzureModelCreatepatternanyentitymodel
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: extractorCreateObject
          in: body
          description: >-
            A model object containing the name and explicit list for the new
            Pattern.Any entity extractor.
          required: true
          schema:
            $ref: '#/definitions/PatternAnyModelCreateObject'
      responses:
        '201':
          description: The ID of the created Pattern.Any entity model.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Regex Entity Model request:
          $ref: >-
            ./examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities/{entityId}/roles:
    get:
      summary: Microsoft Azure Get All Roles For An Entity In A Version Of The Application
      operationId: microsoftAzureModelListentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity Id
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Entity Roles request:
          $ref: ./examples/model/SuccessfulGetEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Create An Entity Role In A Version Of The Application'
      operationId: microsoftAzureModelCreateentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity model ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Entity Role request:
          $ref: ./examples/model/SuccessfulCreateEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles:
    get:
      summary: 'Microsoft Azure Get A Prebuilt Entity S Roles In A Version Of The Application'
      operationId: microsoftAzureModelListprebuiltentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity Id
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Prebuilt Entity Roles request:
          $ref: ./examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Create A Role For A Prebuilt Entity In A Version Of The Application'
      operationId: microsoftAzureModelCreateprebuiltentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity model ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Prebuilt Entity Role request:
          $ref: ./examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles:
    get:
      summary: 'Microsoft Azure Get All Roles For A List Entity In A Version Of The Application'
      operationId: microsoftAzureModelListclosedlistentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity Id
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Closed List Entity Roles request:
          $ref: ./examples/model/SuccessfulGetClosedListEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Create A Role For A List Entity In A Version Of The Application'
      operationId: microsoftAzureModelCreateclosedlistentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity model ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Closed List Entity Role request:
          $ref: ./examples/model/SuccessfulCreateClosedListEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles:
    get:
      summary: >-
        Microsoft Azure Get All Roles For A Regular Expression Entity In A Version Of The Application
      operationId: microsoftAzureModelListregexentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity Id
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Regex Entity Roles request:
          $ref: ./examples/model/SuccessfulGetRegexEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: >-
        Microsoft Azure Create A Role For An Regular Expression Entity In A Version Of The Application
      operationId: microsoftAzureModelCreateregexentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity model ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Regex Entity Role request:
          $ref: ./examples/model/SuccessfulCreateRegexEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles:
    get:
      summary: Microsoft Azure Get All Roles For A Composite Entity In A Version Of The Application
      operationId: microsoftAzureModelListcompositeentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Composite Entity Roles request:
          $ref: ./examples/model/SuccessfulGetCompositeEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Create A Role For A Composite Entity In A Version Of The Application'
      operationId: microsoftAzureModelCreatecompositeentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Composite Entity Role request:
          $ref: ./examples/model/SuccessfulCreateCompositeEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles:
    get:
      summary: Microsoft Azure Get All Roles For A Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelListpatternanyentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity Id
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Pattern.Any Entity Roles request:
          $ref: ./examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Create A Role For An Pattern Any Entity In A Version Of The Application'
      operationId: microsoftAzureModelCreatepatternanyentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity model ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Pattern.Any Entity Role request:
          $ref: ./examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles:
    get:
      summary: Microsoft Azure Get All Roles For A Hierarchical Entity In A Version Of The Application
      operationId: microsoftAzureModelListhierarchicalentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Hierarchical Entity Roles request:
          $ref: ./examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: >-
        Microsoft Azure Create A Role For An Hierarchical Entity In A Version Of The Application
      operationId: microsoftAzureModelCreatehierarchicalentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Hierarchical Entity Role request:
          $ref: ./examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles:
    get:
      summary: Microsoft Azure Get All Roles For A Prebuilt Entity In A Version Of The Application
      operationId: microsoftAzureModelListcustomprebuiltentityroles
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity Id
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the entity roles
          schema:
            $ref: '#/definitions/EntityRoleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Custom Prebuilt Entity Roles request:
          $ref: ./examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Create A Role For A Prebuilt Entity In A Version Of The Application'
      operationId: microsoftAzureModelCreatecustomprebuiltentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity model ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleCreateObject
          in: body
          description: An entity role object containing the name of role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleCreateObject'
      responses:
        '201':
          description: The ID of the created entity role
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Custom Prebuilt Entity Role request:
          $ref: >-
            ./examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist:
    get:
      summary: >-
        Microsoft Azure Get The Explicit Exception List Of The Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelGetexplicitlist
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The Pattern.Any entity id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A list of the explicit list items
          schema:
            $ref: '#/definitions/ExplicitListItemList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Explicit List request:
          $ref: ./examples/model/SuccessfulGetPatternAnyExplicitListRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: >-
        Microsoft Azure Add A New Exception To The Explicit List For The Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelAddexplicitlistitem
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The Pattern.Any entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: item
          in: body
          description: The new explicit list item.
          required: true
          schema:
            $ref: '#/definitions/ExplicitListItemCreateObject'
      responses:
        '201':
          description: The ID of the created explicit list item.
          schema:
            $ref: '#/definitions/ExplicitListItemIDResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Create Custom Prebuilt Entity Role request:
          $ref: ./examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/regexentities/{regexEntityId}:
    get:
      summary: >-
        Microsoft Azure Gets Information About A Regular Expression Entity In A Version Of The Application
      operationId: microsoftAzureModelGetregexentityentityinfo
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: regexEntityId
          in: path
          description: The regular expression entity model ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A regular expression entity model info.
          schema:
            $ref: '#/definitions/RegexEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Regex Entity request:
          $ref: ./examples/model/SuccessfulGetRegexEntityInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: 'Microsoft Azure Updates The Regular Expression Entity In A Version Of The Application'
      operationId: microsoftAzureModelUpdateregexentitymodel
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: regexEntityId
          in: path
          description: The regular expression entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: regexEntityUpdateObject
          in: body
          description: An object containing the new entity name and regex pattern.
          required: true
          schema:
            $ref: '#/definitions/RegexModelUpdateObject'
      responses:
        '200':
          description: Successfully updated the regular expression entity extractor.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Regex Entity request:
          $ref: ./examples/model/SuccessfulUpdateRegexEntityModelRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: 'Microsoft Azure Deletes A Regular Expression Entity From A Version Of The Application'
      operationId: microsoftAzureModelDeleteregexentitymodel
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: regexEntityId
          in: path
          description: The regular expression entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Regex Entity request:
          $ref: ./examples/model/SuccessfulDeleteRegexEntityRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternanyentities/{entityId}:
    get:
      summary: >-
        Microsoft Azure Gets Information About The Pattern Any Model In A Version Of The Application
      operationId: microsoftAzureModelGetpatternanyentityinfo
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: A regular expression entity model info.
          schema:
            $ref: '#/definitions/PatternAnyEntityExtractor'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Pattern.Any Entity request:
          $ref: ./examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Updates The Name And Explicit Exception List Of A Pattern Any Entity Model In A Version Of The Application
      operationId: microsoftAzureModelUpdatepatternanyentitymodel
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The Pattern.Any entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: patternAnyUpdateObject
          in: body
          description: An object containing the explicit list of the Pattern.Any entity.
          required: true
          schema:
            $ref: '#/definitions/PatternAnyModelUpdateObject'
      responses:
        '200':
          description: Successfully updated the Pattern.Any entity extractor.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Pattern.Any Entity request:
          $ref: ./examples/model/SuccessfulUpdatePatternAnyEntityRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Deletes A Pattern Any Entity Extractor From A Version Of The Application
      operationId: microsoftAzureModelDeletepatternanyentitymodel
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The Pattern.Any entity extractor ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Pattern.Any Entity request:
          $ref: ./examples/model/SuccessfulDeletePatternAnyEntityRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/entities/{entityId}/roles/{roleId}:
    get:
      summary: Microsoft Azure Get One Role For A Given Entity In A Version Of The Application
      operationId: microsoftAzureModelGetentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulGetEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: 'Microsoft Azure Update A Role For A Given Entity In A Version Of The Application'
      operationId: microsoftAzureModelUpdateentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdateEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: 'Microsoft Azure Delete An Entity Role In A Version Of The Application'
      operationId: microsoftAzureModelDeleteentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulDeleteEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles/{roleId}:
    get:
      summary: Microsoft Azure Get One Role For A Given Prebuilt Entity In A Version Of The Application
      operationId: microsoftAzureModelGetprebuiltentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Prebuilt Entity Role request:
          $ref: ./examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Update A Role For A Given Prebuilt Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdateprebuiltentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Prebuilt Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: 'Microsoft Azure Delete A Role In A Prebuilt Entity In A Version Of The Application'
      operationId: microsoftAzureModelDeleteprebuiltentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Prebuilt Entity Role request:
          $ref: ./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}:
    get:
      summary: 'Microsoft Azure Get One Role For A Given List Entity In A Version Of The Application'
      operationId: microsoftAzureModelGetclosedlistentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Closed List Entity Role request:
          $ref: ./examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: 'Microsoft Azure Update A Role For A Given List Entity In A Version Of The Application'
      operationId: microsoftAzureModelUpdateclosedlistentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Closed List Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: 'Microsoft Azure Delete A Role For A Given List Entity In A Version Of The Application'
      operationId: microsoftAzureModelDeleteclosedlistentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Prebuilt Entity Role request:
          $ref: ./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles/{roleId}:
    get:
      summary: >-
        Microsoft Azure Get One Role For A Given Regular Expression Entity In A Version Of The Application
      operationId: microsoftAzureModelGetregexentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Regex Entity Role request:
          $ref: ./examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Update A Role For A Given Regular Expression Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdateregexentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Regex Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdateRegexEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Delete A Role For A Given Regular Expression In A Version Of The Application
      operationId: microsoftAzureModelDeleteregexentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Regex Entity Role request:
          $ref: ./examples/model/SuccessfulDeleteRegexEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}:
    get:
      summary: >-
        Microsoft Azure Get One Role For A Given Composite Entity In A Version Of The Application
      operationId: microsoftAzureModelGetcompositeentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Composite Entity Role request:
          $ref: ./examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Update A Role For A Given Composite Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdatecompositeentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Composite Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Delete A Role For A Given Composite Entity In A Version Of The Application
      operationId: microsoftAzureModelDeletecompositeentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/CEntityIdInPath'
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Composite Entity Role request:
          $ref: ./examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles/{roleId}:
    get:
      summary: >-
        Microsoft Azure Get One Role For A Given Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelGetpatternanyentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Pattern.Any Entity Role request:
          $ref: ./examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Update A Role For A Given Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdatepatternanyentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Pattern.Any Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Delete A Role For A Given Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelDeletepatternanyentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Pattern.Any Entity Role request:
          $ref: ./examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}:
    get:
      summary: >-
        Microsoft Azure Get One Role For A Given Hierarchical Entity In A Version Of The Application
      operationId: microsoftAzureModelGethierarchicalentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Hierarchical Entity Role request:
          $ref: ./examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Update A Role For A Given Hierarchical Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdatehierarchicalentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Hierarchical Entity Extractor Role request:
          $ref: ./examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Delete A Role For A Given Hierarchical Role In A Version Of The Application
      operationId: microsoftAzureModelDeletehierarchicalentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/HEntityIdInPath'
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Hierarchical Entity Role request:
          $ref: ./examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles/{roleId}:
    get:
      summary: >-
        Microsoft Azure Get One Role For A Given Prebuilt Entity In A Version Of The Application
      operationId: microsoftAzureModelGetcustomentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: entity role ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: An entity role
          schema:
            $ref: '#/definitions/EntityRole'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Custom Prebuilt Domain Entity Role request:
          $ref: >-
            ./examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Update A Role For A Given Prebuilt Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdatecustomprebuiltentityrole
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role ID.
          required: true
          type: string
          format: uuid
        - name: entityRoleUpdateObject
          in: body
          description: The new entity role.
          required: true
          schema:
            $ref: '#/definitions/EntityRoleUpdateObject'
      responses:
        '200':
          description: Successfully updated the entity role.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Custom Prebuilt Entity Extractor Role request:
          $ref: >-
            ./examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Delete A Role For A Given Prebuilt Entity In A Version Of The Application
      operationId: microsoftAzureModelDeletecustomentityrole
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The entity ID.
          required: true
          type: string
          format: uuid
        - name: roleId
          in: path
          description: The entity role Id.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Custom Prebuilt Entity Role request:
          $ref: >-
            ./examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist/{itemId}:
    get:
      summary: >-
        Microsoft Azure Get The Explicit Exception List Of The Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelGetexplicitlistitem
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The Pattern.Any entity Id.
          required: true
          type: string
          format: uuid
        - name: itemId
          in: path
          description: The explicit list item Id.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: An explicit list item info.
          schema:
            $ref: '#/definitions/ExplicitListItem'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Pattern.Any Explicit List Item request:
          $ref: ./examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: >-
        Microsoft Azure Updates An Explicit Exception List Item For A Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelUpdateexplicitlistitem
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The Pattern.Any entity extractor ID.
          required: true
          type: string
          format: uuid
        - name: itemId
          in: path
          description: The explicit list item ID.
          required: true
          type: integer
          format: int64
        - name: item
          in: body
          description: The new explicit list item.
          required: true
          schema:
            $ref: '#/definitions/ExplicitListItemUpdateObject'
      responses:
        '200':
          description: Successfully updated the explicit list item.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Pattern.Any Entity Explicit List Item request:
          $ref: >-
            ./examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Delete An Item From The Explicit Exception List For A Pattern Any Entity In A Version Of The Application
      operationId: microsoftAzureModelDeleteexplicitlistitem
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: entityId
          in: path
          description: The pattern.any entity id.
          required: true
          type: string
          format: uuid
        - name: itemId
          in: path
          description: The explicit list item which will be deleted.
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Pattern.Any Explicit List Item request:
          $ref: >-
            ./examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternrule:
    post:
      summary: 'Microsoft Azure Adds A Pattern To A Version Of The Application'
      operationId: microsoftAzurePatternAddpattern
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: pattern
          in: body
          description: The input pattern.
          required: true
          schema:
            $ref: '#/definitions/PatternRuleCreateObject'
      responses:
        '201':
          description: The created pattern
          schema:
            $ref: '#/definitions/PatternRuleInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Add Pattern request:
          $ref: ./examples/patterns/SuccessfulAddPatternRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternrules:
    get:
      summary: 'Microsoft Azure Gets Patterns In A Version Of The Application'
      operationId: microsoftAzurePatternListpatterns
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: The retrieved patterns
          schema:
            $ref: '#/definitions/PatternRuleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Application Version Patterns request:
          $ref: ./examples/patterns/SuccessfulGetPatternsRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    put:
      summary: 'Microsoft Azure Updates Patterns In A Version Of The Application'
      operationId: microsoftAzurePatternUpdatepatterns
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: patterns
          in: body
          description: An array represents the patterns.
          required: true
          schema:
            type: array
            items:
              $ref: '#/definitions/PatternRuleUpdateObject'
      responses:
        '200':
          description: The updated patterns
          schema:
            $ref: '#/definitions/PatternRuleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Batch Update Patterns request:
          $ref: ./examples/patterns/SuccessfulUpdatePatternsRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    post:
      summary: 'Microsoft Azure Adds A Batch Of Patterns In A Version Of The Application'
      operationId: microsoftAzurePatternBatchaddpatterns
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: patterns
          in: body
          description: A JSON array containing patterns.
          required: true
          schema:
            type: array
            items:
              $ref: '#/definitions/PatternRuleCreateObject'
      responses:
        '201':
          description: The created patterns
          schema:
            $ref: '#/definitions/PatternRuleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Batch Add Patterns request:
          $ref: ./examples/patterns/SuccessfulBatchAddLabelsRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: 'Microsoft Azure Deletes A List Of Patterns In A Version Of The Application'
      operationId: microsoftAzurePatternDeletepatterns
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: patternIds
          in: body
          description: The patterns IDs.
          required: true
          schema:
            type: array
            items:
              format: uuid
              type: string
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Batch Delete Patterns request:
          $ref: ./examples/patterns/SuccessfulDeletePatternsRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/patternrules/{patternId}:
    put:
      summary: 'Microsoft Azure Updates A Pattern In A Version Of The Application'
      operationId: microsoftAzurePatternUpdatepattern
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: patternId
          in: path
          description: The pattern ID.
          required: true
          type: string
          format: uuid
        - name: pattern
          in: body
          description: An object representing a pattern.
          required: true
          schema:
            $ref: '#/definitions/PatternRuleUpdateObject'
      responses:
        '200':
          description: The updated pattern
          schema:
            $ref: '#/definitions/PatternRuleInfo'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Update Pattern request:
          $ref: ./examples/patterns/SuccessfulUpdatePatternRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
    delete:
      summary: >-
        Microsoft Azure Deletes The Pattern With The Specified Id From A Version Of The Application
      operationId: microsoftAzurePatternDeletepattern
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: patternId
          in: path
          description: The pattern ID.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Delete Pattern request:
          $ref: ./examples/patterns/SuccessfulDeletePatternRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/intents/{intentId}/patternrules:
    get:
      summary: >-
        Microsoft Azure Returns Patterns For The Specific Intent In A Version Of The Application
      operationId: microsoftAzurePatternListintentpatterns
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - $ref: '#/parameters/IntentIdInPath'
        - $ref: '#/parameters/SkipInPath'
        - $ref: '#/parameters/TakeInPath'
      responses:
        '200':
          description: The retrieved patterns
          schema:
            $ref: '#/definitions/PatternRuleList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Get Intent Patterns request:
          $ref: ./examples/patterns/SuccessfulGetIntentPatternsRequest.json
      description: Needs a more full description created.
      tags:
        - Apps
  /apps/{appId}/versions/{versionId}/settings:
    get:
      description: Gets the settings in a version of the application.
      operationId: microsoftAzureSettingsList
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: A list of the application version settings.
          schema:
            type: array
            items:
              $ref: '#/definitions/AppVersionSettingObject'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get Application Version settings request:
          $ref: >-
            ./examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json
      summary: Microsoft Azure Get Apps Appid Versions Versionid Settings
      tags:
        - Apps
    put:
      description: Updates the settings in a version of the application.
      operationId: microsoftAzureSettingsUpdate
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
        - name: listOfAppVersionSettingObject
          in: body
          required: true
          schema:
            type: array
            items:
              $ref: '#/definitions/AppVersionSettingObject'
          description: A list of the updated application version settings.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Update Application Version settings request:
          $ref: >-
            ./examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json
      summary: Microsoft Azure Put Apps Appid Versions Versionid Settings
      tags:
        - Apps
  /apps/{appId}/azureaccounts:
    post:
      description: Assigns an Azure account to the application.
      operationId: microsoftAzureAzureaccountsAssigntoapp
      summary: Microsoft Azure Apps  Assign A Luis Azure Account To An Application
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/BearerAuthPath'
        - $ref: '#/parameters/ArmTokenParameter'
        - name: azureAccountInfoObject
          in: body
          schema:
            $ref: '#/definitions/AzureAccountInfoObject'
          description: The Azure account information object.
      consumes:
        - application/json
      responses:
        '201':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Assign azure account request:
          $ref: ./examples/stats/SuccessfulAssignAzureAccountRequest.json
      tags:
        - Apps
    get:
      description: >-
        Gets the LUIS Azure accounts assigned to the application for the user
        using his ARM token.
      operationId: microsoftAzureAzureaccountsGetassigned
      summary: Microsoft Azure Apps  Get Luis Azure Accounts Assigned To The Application
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/BearerAuthPath'
        - $ref: '#/parameters/ArmTokenParameter'
      responses:
        '200':
          description: A list of azure account information objects.
          schema:
            $ref: '#/definitions/AzureAccountInfoList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get assigned azure accounts request:
          $ref: ./examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json
      tags:
        - Apps
    delete:
      description: Removes assigned Azure account from the application.
      operationId: microsoftAzureAzureaccountsRemovefromapp
      summary: Microsoft Azure Apps  Removes An Assigned Luis Azure Account From An Application
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/BearerAuthPath'
        - $ref: '#/parameters/ArmTokenParameter'
        - name: azureAccountInfoObject
          in: body
          schema:
            $ref: '#/definitions/AzureAccountInfoObject'
          description: The Azure account information object.
      consumes:
        - application/json
      responses:
        '200':
          description: Successful operation.
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful delete assigned azure account request:
          $ref: ./examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json
      tags:
        - Apps
  /azureaccounts:
    get:
      description: Gets the LUIS Azure accounts for the user using his ARM token.
      operationId: microsoftAzureAzureaccountsListuserluisaccounts
      summary: Microsoft Azure User  Get Luis Azure Accounts
      parameters:
        - $ref: '#/parameters/BearerAuthPath'
        - $ref: '#/parameters/ArmTokenParameter'
      responses:
        '200':
          description: A list of Azure account information objects.
          schema:
            $ref: '#/definitions/AzureAccountInfoList'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Get azure accounts request:
          $ref: ./examples/stats/SuccessfulGetAzureAccountsRequest.json
      tags:
        - Azureaccounts
  /package/{appId}/slot/{slotName}/gzip:
    get:
      description: >-
        Packages a published LUIS application as a GZip file to be used in the
        LUIS container.
      operationId: microsoftAzureAppsPackagepublishedapplicationasgzip
      summary: >-
        Microsoft Azure Package  Gets Published Luis Application Package In Binary Stream Gzip Format
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/SlotNameInPath'
      responses:
        '200':
          description: The GZip binary stream of the published application package.
          schema:
            type: file
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/octet-stream
        - application/json
      x-ms-examples:
        Successful Get published application package request:
          $ref: >-
            ./examples/package/SuccessfulGetTrainedApplicationPackageRequest.json
      tags:
        - Package
  /package/{appId}/versions/{versionId}/gzip:
    get:
      description: >-
        Packages trained LUIS application as GZip file to be used in the LUIS
        container.
      operationId: microsoftAzureAppsPackagetrainedapplicationasgzip
      summary: >-
        Microsoft Azure Package  Gets Trained Luis Application Package In Binary Stream Gzip Format
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: The GZip binary stream of the trained application package.
          schema:
            type: file
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/octet-stream
        - application/json
      x-ms-examples:
        Successful Get published application package request:
          $ref: >-
            ./examples/package/SuccessfulGetPublishedApplicationPackageRequest.json
      tags:
        - Package
x-ms-paths:
  /apps/import?JsonVersion=V2:
    post:
      description: >-
        Imports an application to LUIS, the application's structure is included
        in the request body.
      operationId: Apps_ImportV2App
      parameters:
        - name: appName
          in: query
          description: >-
            The application name to create. If not specified, the application
            name will be read from the imported object. If the application name
            already exists, an error is returned.
          type: string
        - name: luisAppV2
          in: body
          required: true
          schema:
            $ref: '#/definitions/LuisAppV2'
          description: A LUIS application structure.
      consumes:
        - application/json
      responses:
        '201':
          description: The ID of the imported application.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Import Application:
          $ref: ./examples/apps/SuccessfulImportV2ApplicationRequest.json
  /apps/import?format=lu:
    post:
      description: >-
        Imports an application to LUIS, the application's structure is included
        in the request body.
      operationId: Apps_ImportLuFormat
      parameters:
        - name: appName
          in: query
          description: >-
            The application name to create. If not specified, the application
            name will be read from the imported object. If the application name
            already exists, an error is returned.
          type: string
        - name: luisAppLu
          in: body
          required: true
          schema:
            type: string
          description: A LUIS application structure.
      consumes:
        - text/plain
      responses:
        '201':
          description: The ID of the imported application.
          x-nullable: false
          schema:
            $ref: '#/definitions/GuidResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Import Application:
          $ref: ./examples/apps/SuccessfulImportLuApplicationRequest.json
  /apps/{appId}/versions/import?JsonVersion=V2:
    post:
      description: Imports a new version into a LUIS application.
      operationId: Versions_ImportV2App
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: versionId
          in: query
          description: >-
            The new versionId to import. If not specified, the versionId will be
            read from the imported object.
          type: string
        - name: luisAppV2
          in: body
          required: true
          schema:
            $ref: '#/definitions/LuisAppV2'
          description: A LUIS application structure.
      consumes:
        - application/json
      responses:
        '201':
          description: The created application version.
          schema:
            $ref: '#/definitions/VersionResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Import Application:
          $ref: ./examples/versions/SuccessfulImportV2ApplicationVersionRequest.json
  /apps/{appId}/versions/import?format=lu:
    post:
      description: Imports a new version into a LUIS application.
      operationId: Versions_ImportLuFormat
      parameters:
        - $ref: '#/parameters/AppIdInPath'
        - name: versionId
          in: query
          description: >-
            The new versionId to import. If not specified, the versionId will be
            read from the imported object.
          type: string
        - name: luisAppLu
          in: body
          required: true
          schema:
            type: string
          description: An LU representing the LUIS application structure.
      consumes:
        - text/plain
      responses:
        '201':
          description: The created application version.
          schema:
            $ref: '#/definitions/VersionResponse'
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/json
      x-ms-examples:
        Successful Import Application:
          $ref: ./examples/versions/SuccessfulImportLuApplicationVersionRequest.json
  /apps/{appId}/versions/{versionId}/export?format=lu:
    get:
      description: Exports a LUIS application to text format.
      operationId: Versions_ExportLuFormat
      parameters:
        - in: query
          name: format
          required: true
          description: Lu format extension
          type: string
          enum:
            - lu
        - $ref: '#/parameters/AppIdInPath'
        - $ref: '#/parameters/VersionIdInPath'
      responses:
        '200':
          description: The LUIS application structure in LU format.
          schema:
            description: The LUIS application structure in LU format.
            type: object
            format: file
        default:
          description: Error Response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
        - application/octet-stream
      x-ms-examples:
        Successful Export Application Version:
          $ref: ./examples/versions/SuccessfulExportLuApplicationVersionRequest.json
definitions:
  EntityLabelObject:
    description: >-
      Defines the entity type and position of the extracted entity within the
      example.
    type: object
    required:
      - entityName
      - startCharIndex
      - endCharIndex
    properties:
      entityName:
        description: The entity type.
        type: string
      startCharIndex:
        description: The index within the utterance where the extracted entity starts.
        type: integer
      endCharIndex:
        description: The index within the utterance where the extracted entity ends.
        type: integer
      role:
        description: The role the entity plays in the utterance.
        type: string
      children:
        description: The identified entities within the example utterance.
        items:
          type: object
          $ref: '#/definitions/EntityLabelObject'
        type: array
        example:
          - entityName: child
            startCharIndex: 0
            endCharIndex: 0
            children: []
  ApplicationCreateObject:
    description: Properties for creating a new LUIS Application
    type: object
    required:
      - culture
      - name
    properties:
      culture:
        description: >-
          The culture for the new application. It is the language that your app
          understands and speaks. E.g.: "en-us". Note: the culture cannot be
          changed after the app is created.
        type: string
      domain:
        description: 'The domain for the new application. Optional. E.g.: Comics.'
        type: string
      description:
        description: Description of the new application. Optional.
        type: string
      initialVersionId:
        description: 'The initial version ID. Optional. Default value is: "0.1"'
        type: string
      usageScenario:
        description: 'Defines the scenario for the new application. Optional. E.g.: IoT.'
        type: string
      name:
        description: The name for the new application.
        type: string
  PrebuiltDomainCreateBaseObject:
    description: >-
      A model object containing the name of the custom prebuilt entity and the
      name of the domain to which this model belongs.
    type: object
    properties:
      domainName:
        description: The domain name.
        type: string
  PrebuiltDomainCreateObject:
    description: >-
      A prebuilt domain create object containing the name and culture of the
      domain.
    type: object
    properties:
      domainName:
        description: The domain name.
        type: string
      culture:
        description: The culture of the new domain.
        type: string
  PrebuiltDomainModelCreateObject:
    description: >-
      A model object containing the name of the custom prebuilt intent or entity
      and the name of the domain to which this model belongs.
    type: object
    properties:
      domainName:
        description: The domain name.
        type: string
      modelName:
        description: The intent name or entity name.
        type: string
  CompositeEntityModel:
    description: A composite entity extractor.
    type: object
    properties:
      children:
        description: Child entities.
        items:
          type: string
        type: array
      name:
        description: Entity name.
        type: string
  EntityModelCreateObject:
    description: An entity extractor create object.
    type: object
    properties:
      children:
        description: Child entities.
        items:
          type: object
          $ref: '#/definitions/ChildEntityModelCreateObject'
        type: array
      name:
        description: Entity name.
        type: string
  ChildEntityModelCreateObject:
    description: A child entity extractor create object.
    type: object
    properties:
      children:
        description: Child entities.
        items:
          type: object
          $ref: '#/definitions/ChildEntityModelCreateObject'
        type: array
      name:
        description: Entity name.
        type: string
      instanceOf:
        description: The instance of model name
        type: string
  EntityModelUpdateObject:
    description: An entity extractor update object.
    type: object
    properties:
      name:
        description: Entity name.
        type: string
      instanceOf:
        description: The instance of model name
        type: string
  JSONEntity:
    description: Exported Model - Extracted Entity from utterance.
    type: object
    required:
      - startPos
      - endPos
      - entity
    properties:
      startPos:
        description: The index within the utterance where the extracted entity starts.
        type: integer
      endPos:
        description: The index within the utterance where the extracted entity ends.
        type: integer
      entity:
        description: The entity name.
        type: string
      role:
        description: The role the entity plays in the utterance.
        type: string
      children:
        type: array
        items:
          type: object
          $ref: '#/definitions/JSONEntity'
        example:
          - entity: child1
            startPos: 0
            endPos: 0
            children: []
  ApplicationSettingUpdateObject:
    description: Object model for updating an application's settings.
    type: object
    properties:
      public:
        description: >-
          Setting your application as public allows other people to use your
          application's endpoint using their own keys.
        type: boolean
        x-nullable: false
        x-ms-client-name: isPublic
  PublishSettingUpdateObject:
    description: Object model for updating an application's publish settings.
    type: object
    properties:
      sentimentAnalysis:
        description: >-
          Setting sentiment analysis as true returns the Sentiment of the input
          utterance along with the response
        type: boolean
        x-nullable: false
      speech:
        description: Setting speech as public enables speech priming in your app
        type: boolean
        x-nullable: false
      spellChecker:
        description: >-
          Setting spell checker as public enables spell checking the input
          utterance.
        type: boolean
        x-nullable: false
  ExampleLabelObject:
    description: A labeled example utterance.
    type: object
    properties:
      text:
        description: The example utterance.
        type: string
      entityLabels:
        description: The identified entities within the example utterance.
        items:
          type: object
          $ref: '#/definitions/EntityLabelObject'
        type: array
      intentName:
        description: The identified intent representing the example utterance.
        type: string
  PhraselistCreateObject:
    description: Object model for creating a phraselist model.
    type: object
    properties:
      phrases:
        description: List of comma-separated phrases that represent the Phraselist.
        type: string
      name:
        description: The Phraselist name.
        type: string
      isExchangeable:
        description: >-
          An interchangeable phrase list feature serves as a list of synonyms
          for training. A non-exchangeable phrase list serves as separate
          features for training. So, if your non-interchangeable phrase list
          contains 5 phrases, they will be mapped to 5 separate features. You
          can think of the non-interchangeable phrase list as an additional bag
          of words to add to LUIS existing vocabulary features. It is used as a
          lexicon lookup feature where its value is 1 if the lexicon contains a
          given word or 0 if it doesn’t.  Default value is true.
        default: true
        type: boolean
      enabledForAllModels:
        description: >-
          Indicates if the Phraselist is enabled for all models in the
          application.
        default: true
        type: boolean
  SubClosedList:
    description: Sublist of items for a list entity.
    type: object
    properties:
      canonicalForm:
        description: The standard form that the list represents.
        type: string
      list:
        description: List of synonym words.
        items:
          type: string
        type: array
  SubClosedListResponse:
    description: Sublist of items for a list entity.
    type: object
    allOf:
      - $ref: '#/definitions/SubClosedList'
    properties:
      id:
        description: The sublist ID
        type: integer
        x-nullable: false
  ApplicationUpdateObject:
    description: Object model for updating the name or description of an application.
    type: object
    properties:
      name:
        description: The application's new name.
        type: string
      description:
        description: The application's new description.
        type: string
  PrebuiltExtractorNames:
    description: Object model for adding a prebuilt entity to the application.
    type: array
    items:
      type: string
  JSONRegexFeature:
    description: Exported Model - A Pattern feature.
    type: object
    properties:
      pattern:
        description: The Regular Expression to match.
        type: string
      activated:
        description: Indicates if the Pattern feature is enabled.
        type: boolean
      name:
        description: Name of the feature.
        type: string
  ClosedList:
    description: Exported Model - A list entity.
    type: object
    properties:
      name:
        description: Name of the list entity.
        type: string
      subLists:
        description: Sublists for the list entity.
        items:
          type: object
          $ref: '#/definitions/SubClosedList'
        type: array
      roles:
        items:
          type: string
        type: array
  ClosedListModelPatchObject:
    description: Object model for adding a batch of sublists to an existing list entity.
    type: object
    properties:
      subLists:
        description: Sublists to add.
        items:
          type: object
          $ref: '#/definitions/WordListObject'
        type: array
  JSONModelFeature:
    description: Exported Model - Phraselist Model Feature.
    type: object
    properties:
      activated:
        description: Indicates if the feature is enabled.
        type: boolean
      name:
        description: The Phraselist name.
        type: string
      words:
        description: List of comma-separated phrases that represent the Phraselist.
        type: string
      mode:
        description: >-
          An interchangeable phrase list feature serves as a list of synonyms
          for training. A non-exchangeable phrase list serves as separate
          features for training. So, if your non-interchangeable phrase list
          contains 5 phrases, they will be mapped to 5 separate features. You
          can think of the non-interchangeable phrase list as an additional bag
          of words to add to LUIS existing vocabulary features. It is used as a
          lexicon lookup feature where its value is 1 if the lexicon contains a
          given word or 0 if it doesn’t.  Default value is true.
        type: boolean
      enabledForAllModels:
        description: >-
          Indicates if the Phraselist is enabled for all models in the
          application.
        default: true
        type: boolean
  ModelCreateObject:
    description: Object model for creating a new entity extractor.
    type: object
    properties:
      name:
        description: Name of the new entity extractor.
        type: string
  WordListObject:
    description: Sublist of items for a list entity.
    type: object
    properties:
      canonicalForm:
        description: The standard form that the list represents.
        type: string
      list:
        description: List of synonym words.
        items:
          type: string
        type: array
  WordListBaseUpdateObject:
    description: Object model for updating one of the list entity's sublists.
    type: object
    properties:
      canonicalForm:
        description: The standard form that the list represents.
        type: string
      list:
        description: List of synonym words.
        items:
          type: string
        type: array
  JSONUtterance:
    description: Exported Model - Utterance that was used to train the model.
    type: object
    properties:
      text:
        description: The utterance.
        type: string
      intent:
        description: The matched intent.
        type: string
      entities:
        description: The matched entities.
        items:
          type: object
          $ref: '#/definitions/JSONEntity'
        type: array
  ModelUpdateObject:
    description: Object model for updating an intent classifier.
    type: object
    properties:
      name:
        description: The entity's new name.
        type: string
  ClosedListModelUpdateObject:
    description: Object model for updating a list entity.
    type: object
    properties:
      subLists:
        description: The new sublists for the feature.
        items:
          type: object
          $ref: '#/definitions/WordListObject'
        type: array
      name:
        description: The new name of the list entity.
        type: string
  ClosedListModelCreateObject:
    description: Object model for creating a list entity.
    type: object
    properties:
      subLists:
        description: Sublists for the feature.
        items:
          type: object
          $ref: '#/definitions/WordListObject'
        type: array
      name:
        description: Name of the list entity.
        type: string
  ExampleLabelObjectArray:
    description: Object model for adding a batch of labeled examples.
    items:
      type: object
      $ref: '#/definitions/ExampleLabelObject'
    type: array
  VersionInfo:
    description: Object model of an application version.
    type: object
    required:
      - version
      - trainingStatus
    properties:
      version:
        description: 'The version ID. E.g.: "0.1"'
        type: string
      createdDateTime:
        description: The version's creation timestamp.
        type: string
        format: date-time
      lastModifiedDateTime:
        description: Timestamp of the last update.
        type: string
        format: date-time
      lastTrainedDateTime:
        description: Timestamp of the last time the model was trained.
        type: string
        format: date-time
      lastPublishedDateTime:
        description: Timestamp when was last published.
        type: string
        format: date-time
      endpointUrl:
        description: The Runtime endpoint URL for this model version.
        type: string
      assignedEndpointKey:
        description: The endpoint key.
        type: object
        additionalProperties:
          type: string
      externalApiKeys:
        description: External keys.
        type: object
      intentsCount:
        description: Number of intents in this model.
        type: integer
      entitiesCount:
        description: Number of entities in this model.
        type: integer
      endpointHitsCount:
        description: Number of calls made to this endpoint.
        type: integer
      trainingStatus:
        description: The current training status.
        type: string
        enum:
          - NeedsTraining
          - InProgress
          - Trained
        x-ms-enum:
          name: TrainingStatus
  TaskUpdateObject:
    description: Object model for cloning an application's version.
    type: object
    properties:
      version:
        description: The new version for the cloned model.
        type: string
  PhraselistUpdateObject:
    description: Object model for updating a Phraselist.
    type: object
    properties:
      phrases:
        description: List of comma-separated phrases that represent the Phraselist.
        type: string
      name:
        description: The Phraselist name.
        type: string
      isActive:
        description: Indicates if the Phraselist is enabled.
        default: true
        type: boolean
      isExchangeable:
        description: >-
          An exchangeable phrase list feature are serves as single feature to
          the LUIS underlying training algorithm. It is used as a lexicon lookup
          feature where its value is 1 if the lexicon contains a given word or 0
          if it doesn’t. Think of an exchangeable as a synonyms list. A
          non-exchangeable phrase list feature has all the phrases in the list
          serve as separate features to the underlying training algorithm. So,
          if you your phrase list feature contains 5 phrases, they will be
          mapped to 5 separate features. You can think of the non-exchangeable
          phrase list feature as an additional bag of words that you are willing
          to add to LUIS existing vocabulary features. Think of a
          non-exchangeable as set of different words. Default value is true.
        default: true
        type: boolean
      enabledForAllModels:
        description: >-
          Indicates if the Phraselist is enabled for all models in the
          application.
        default: true
        type: boolean
  PrebuiltDomainObject:
    type: object
    properties:
      domain_name:
        type: string
      model_name:
        type: string
  JsonChild:
    type: object
    properties:
      name:
        type: string
      instanceOf:
        type: string
      children:
        items:
          type: object
          $ref: '#/definitions/JsonChild'
        type: array
      features:
        items:
          type: object
          $ref: '#/definitions/JsonModelFeatureInformation'
        type: array
  HierarchicalModel:
    type: object
    properties:
      name:
        type: string
      children:
        items:
          type: object
          $ref: '#/definitions/JsonChild'
        type: array
      features:
        items:
          type: object
          $ref: '#/definitions/JsonModelFeatureInformation'
        type: array
      roles:
        type: array
        items:
          type: string
      inherits:
        type: object
        $ref: '#/definitions/PrebuiltDomainObject'
  HierarchicalModelV2:
    type: object
    properties:
      name:
        type: string
      children:
        items:
          type: string
        type: array
      inherits:
        type: object
        $ref: '#/definitions/PrebuiltDomainObject'
      roles:
        type: array
        items:
          type: string
  ApplicationPublishObject:
    description: Object model for publishing a specific application version.
    type: object
    properties:
      versionId:
        description: The version ID to publish.
        type: string
      isStaging:
        description: >-
          Indicates if the staging slot should be used, instead of the
          Production one.
        default: false
        type: boolean
  LuisAppV2:
    description: Exported Model - An exported LUIS Application.
    additionalProperties: true
    type: object
    properties:
      luis_schema_version:
        description: Luis schema deserialization version.
        type: string
      name:
        description: The name of the application.
        type: string
      versionId:
        description: The version ID of the application that was exported.
        type: string
      desc:
        description: The description of the application.
        type: string
      culture:
        description: 'The culture of the application. E.g.: en-us.'
        type: string
      intents:
        description: List of intents.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModelV2'
        type: array
      entities:
        description: List of entities.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModelV2'
        type: array
      closedLists:
        description: List of list entities.
        items:
          type: object
          $ref: '#/definitions/ClosedList'
        type: array
      composites:
        description: List of composite entities.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModelV2'
        type: array
      patternAnyEntities:
        description: List of Pattern.Any entities.
        items:
          type: object
          $ref: '#/definitions/PatternAny'
        type: array
      regex_entities:
        description: List of regular expression entities.
        items:
          type: object
          $ref: '#/definitions/RegexEntity'
        type: array
      prebuiltEntities:
        description: List of prebuilt entities.
        items:
          type: object
          $ref: '#/definitions/PrebuiltEntity'
        type: array
      regex_features:
        description: List of pattern features.
        items:
          type: object
          $ref: '#/definitions/JSONRegexFeature'
        type: array
      model_features:
        description: List of model features.
        items:
          type: object
          $ref: '#/definitions/JSONModelFeature'
        type: array
      patterns:
        description: List of patterns.
        items:
          type: object
          $ref: '#/definitions/PatternRule'
        type: array
      utterances:
        description: List of example utterances.
        items:
          type: object
          $ref: '#/definitions/JSONUtterance'
        type: array
  LuisApp:
    description: Exported Model - An exported LUIS Application.
    additionalProperties: true
    type: object
    properties:
      name:
        description: The name of the application.
        type: string
      versionId:
        description: The version ID of the application that was exported.
        type: string
      desc:
        description: The description of the application.
        type: string
      culture:
        description: 'The culture of the application. E.g.: en-us.'
        type: string
      intents:
        description: List of intents.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModel'
        type: array
      entities:
        description: List of entities.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModel'
        type: array
      closedLists:
        description: List of list entities.
        items:
          type: object
          $ref: '#/definitions/ClosedList'
        type: array
      composites:
        description: List of composite entities.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModel'
        type: array
      hierarchicals:
        description: List of hierarchical entities.
        items:
          type: object
          $ref: '#/definitions/HierarchicalModel'
        type: array
      patternAnyEntities:
        description: List of Pattern.Any entities.
        items:
          type: object
          $ref: '#/definitions/PatternAny'
        type: array
      regex_entities:
        description: List of regular expression entities.
        items:
          type: object
          $ref: '#/definitions/RegexEntity'
        type: array
      prebuiltEntities:
        description: List of prebuilt entities.
        items:
          type: object
          $ref: '#/definitions/PrebuiltEntity'
        type: array
      regex_features:
        description: List of pattern features.
        items:
          type: object
          $ref: '#/definitions/JSONRegexFeature'
        type: array
      phraselists:
        description: List of model features.
        items:
          type: object
          $ref: '#/definitions/JSONModelFeature'
        type: array
      patterns:
        description: List of patterns.
        items:
          type: object
          $ref: '#/definitions/PatternRule'
        type: array
      utterances:
        description: List of example utterances.
        items:
          type: object
          $ref: '#/definitions/JSONUtterance'
        type: array
  GuidResponse:
    description: The ID (GUID) returned by an operation.
    type: string
    format: uuid
  VersionResponse:
    description: The new version ID returned by when importing a model version.
    type: string
  FeatureIDResponse:
    description: The ID of the created feature.
    type: integer
    x-nullable: false
  LabeledUtterances:
    description: >-
      A list of predictions and label pairs for every example in the
      application.
    type: array
    items:
      $ref: '#/definitions/LabeledUtterance'
  LabeledUtterance:
    description: A prediction and label pair of an example.
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: ID of Labeled Utterance.
      text:
        type: string
        description: The utterance. For example, "What's the weather like in seattle?"
      tokenizedText:
        type: array
        description: The utterance tokenized.
        items:
          type: string
      intentLabel:
        description: The intent matching the example.
        type: string
      entityLabels:
        description: The entities matching the example.
        type: array
        items:
          $ref: '#/definitions/EntityLabel'
      intentPredictions:
        description: List of suggested intents.
        type: array
        items:
          $ref: '#/definitions/IntentPrediction'
      entityPredictions:
        description: List of suggested entities.
        type: array
        items:
          $ref: '#/definitions/EntityPrediction'
  IntentsSuggestionExamples:
    description: List of predicted/suggested intents.
    type: array
    items:
      $ref: '#/definitions/IntentsSuggestionExample'
  IntentsSuggestionExample:
    description: Predicted/suggested intent.
    type: object
    properties:
      text:
        type: string
        description: The utterance. For example, "What's the weather like in seattle?"
      tokenizedText:
        type: array
        description: The tokenized utterance.
        items:
          type: string
      intentPredictions:
        description: Predicted/suggested intents.
        type: array
        items:
          $ref: '#/definitions/IntentPrediction'
      entityPredictions:
        description: Predicted/suggested entities.
        type: array
        items:
          $ref: '#/definitions/EntityPrediction'
  EntitiesSuggestionExamples:
    description: List of predicted/suggested entities.
    type: array
    items:
      $ref: '#/definitions/EntitiesSuggestionExample'
  EntitiesSuggestionExample:
    description: Predicted/suggested entity.
    type: object
    properties:
      text:
        type: string
        description: The utterance. For example, "What's the weather like in seattle?"
      tokenizedText:
        type: array
        description: The utterance tokenized.
        items:
          type: string
      intentPredictions:
        description: Predicted/suggested intents.
        type: array
        items:
          $ref: '#/definitions/IntentPrediction'
      entityPredictions:
        description: Predicted/suggested entities.
        type: array
        items:
          $ref: '#/definitions/EntityPrediction'
  EntityLabel:
    description: >-
      Defines the entity type and position of the extracted entity within the
      example.
    type: object
    properties:
      entityName:
        description: The entity type.
        type: string
      startTokenIndex:
        description: The index within the utterance where the extracted entity starts.
        type: integer
      endTokenIndex:
        description: The index within the utterance where the extracted entity ends.
        type: integer
      role:
        type: string
        description: The role of the predicted entity.
      roleId:
        type: string
        format: uuid
        description: The role id for the predicted entity.
      children:
        type: array
        items:
          type: object
          $ref: '#/definitions/EntityLabel'
        example:
          - entityName: child
            startTokenIndex: 0
            endTokenIndex: 0
            children: []
    required:
      - entityName
      - startTokenIndex
      - endTokenIndex
  IntentPrediction:
    description: A suggested intent.
    type: object
    properties:
      name:
        description: The intent's name
        type: string
      score:
        description: The intent's score, based on the prediction model.
        type: number
  EntityPrediction:
    description: A suggested entity.
    type: object
    required:
      - entityName
      - startTokenIndex
      - endTokenIndex
      - phrase
    properties:
      entityName:
        description: The entity's name
        type: string
      startTokenIndex:
        description: The index within the utterance where the extracted entity starts.
        type: integer
      endTokenIndex:
        description: The index within the utterance where the extracted entity ends.
        type: integer
      phrase:
        type: string
        description: The actual token(s) that comprise the entity.
      children:
        type: array
        items:
          type: object
          $ref: '#/definitions/EntityPrediction'
        example:
          - entityName: child
            startTokenIndex: 0
            endTokenIndex: 0
            phrase: string
  PersonalAssistantsResponse:
    type: object
    description: >-
      Response containing user's endpoint keys and the endpoint URLs of the
      prebuilt Cortana applications.
    properties:
      endpointKeys:
        $ref: '#/definitions/EndpointKeys'
      endpointUrls:
        $ref: '#/definitions/PersonalAssistantUrls'
  EndpointKeys:
    type: array
    description: >-
      An a array of GUIDs, comprised of Azure Endpoint Keys and the Authoring
      API key.
    items:
      type: string
      format: uuid
  PersonalAssistantUrls:
    type: object
    description: Endpoint URLs for prebuilt Cortana applications.
    additionalProperties:
      type: string
  ModelInfo:
    description: Base type used in entity types.
    type: object
    properties:
      id:
        type: string
        format: uuid
        description: The ID of the Entity Model.
      name:
        type: string
        description: Name of the Entity Model.
      typeId:
        type: integer
        description: The type ID of the Entity Model.
      readableType:
        $ref: '#/definitions/ReadableType'
    required:
      - id
      - readableType
  ModelsInfoResponseObject:
    description: A list of application model infos.
    type: array
    items:
      $ref: '#/definitions/ModelInfoResponse'
  ModelInfoResponse:
    description: An application model info.
    type: object
    properties:
      id:
        type: string
        format: uuid
        description: The ID of the Entity Model.
      name:
        type: string
        description: Name of the Entity Model.
      typeId:
        type: integer
        description: The type ID of the Entity Model.
      readableType:
        $ref: '#/definitions/ReadableType'
    required:
      - id
      - readableType
    allOf:
      - $ref: '#/definitions/HierarchicalEntityExtractor'
      - $ref: '#/definitions/CompositeEntityExtractor'
      - $ref: '#/definitions/ClosedListEntityExtractor'
      - $ref: '#/definitions/IntentClassifier'
      - $ref: '#/definitions/EntityExtractor'
      - $ref: '#/definitions/RegexEntityExtractor'
      - $ref: '#/definitions/PatternAnyEntityExtractor'
      - $ref: '#/definitions/NDepthEntityExtractor'
  EntityModelInfo:
    description: An Entity Extractor model info.
    type: object
    properties:
      roles:
        $ref: '#/definitions/EntityRoleList'
    allOf:
      - $ref: '#/definitions/ModelInfo'
  ReadableType:
    description: Full name of the entity type.
    type: string
    enum:
      - Entity Extractor
      - Child Entity Extractor
      - Hierarchical Entity Extractor
      - Hierarchical Child Entity Extractor
      - Composite Entity Extractor
      - List Entity Extractor
      - Prebuilt Entity Extractor
      - Intent Classifier
      - Pattern.Any Entity Extractor
      - Closed List Entity Extractor
      - Regex Entity Extractor
  HierarchicalEntityExtractor:
    description: Hierarchical Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      children:
        description: List of child entities.
        type: array
        items:
          $ref: '#/definitions/ChildEntity'
  HierarchicalEntityExtractorsList:
    description: List of Hierarchical Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/HierarchicalEntityExtractor'
  CompositeEntityExtractor:
    description: A Composite Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      children:
        description: List of child entities.
        type: array
        items:
          $ref: '#/definitions/ChildEntity'
  CompositeEntityExtractorsList:
    description: List of Composite Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/CompositeEntityExtractor'
  ClosedListEntityExtractor:
    description: List Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      subLists:
        description: List of sublists.
        type: array
        items:
          $ref: '#/definitions/SubClosedListResponse'
  ClosedListEntityExtractorsList:
    description: List of List Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/ClosedListEntityExtractor'
  PrebuiltEntityExtractor:
    description: Prebuilt Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
  PrebuiltEntityExtractorsList:
    description: List of Prebuilt Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/PrebuiltEntityExtractor'
  ChildEntity:
    type: object
    description: The base child entity type.
    properties:
      id:
        type: string
        format: uuid
        description: The ID (GUID) belonging to a child entity.
      name:
        type: string
        description: The name of a child entity.
      instanceOf:
        description: Instance of Model.
        type: string
      typeId:
        description: The type ID of the Entity Model.
        type: integer
      readableType:
        $ref: '#/definitions/ReadableType'
      children:
        description: List of children
        type: array
        items:
          $ref: '#/definitions/ChildEntity'
    required:
      - id
  HierarchicalChildEntity:
    description: A Hierarchical Child Entity.
    type: object
    properties:
      typeId:
        description: The type ID of the Entity Model.
        type: integer
      readableType:
        $ref: '#/definitions/ReadableType'
    allOf:
      - $ref: '#/definitions/ChildEntity'
  CustomPrebuiltModel:
    description: A Custom Prebuilt model.
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/IntentClassifier'
      - $ref: '#/definitions/EntityExtractor'
  CustomPrebuiltModelList:
    description: A List of Custom Prebuilt models.
    type: array
    items:
      $ref: '#/definitions/CustomPrebuiltModel'
  IntentClassifier:
    description: Intent Classifier.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
    properties:
      customPrebuiltDomainName:
        description: The domain name.
        type: string
      customPrebuiltModelName:
        description: The intent name or entity name.
        type: string
  EntityExtractor:
    description: Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      customPrebuiltDomainName:
        description: The domain name.
        type: string
      customPrebuiltModelName:
        description: The intent name or entity name.
        type: string
  NDepthEntityExtractor:
    description: N-Depth Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      customPrebuiltDomainName:
        description: The domain name.
        type: string
      customPrebuiltModelName:
        description: The intent name or entity name.
        type: string
      children:
        type: array
        items:
          $ref: '#/definitions/ChildEntity'
  IntentClassifiersList:
    description: List of Intent Classifiers.
    type: array
    items:
      $ref: '#/definitions/IntentClassifier'
  EntityExtractorsList:
    description: List of Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/EntityExtractor'
  NDepthEntityExtractorsList:
    description: List of N-Depth Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/NDepthEntityExtractor'
  FeaturesResponseObject:
    description: Model Features, including Patterns and Phraselists.
    type: object
    properties:
      phraselistFeatures:
        $ref: '#/definitions/PhraseListFeatureInfoList'
      patternFeatures:
        $ref: '#/definitions/PatternFeatureInfoList'
  FeatureInfoObject:
    description: The base class Features-related response objects inherit from.
    type: object
    properties:
      id:
        type: integer
        description: A six-digit ID used for Features.
      name:
        type: string
        description: The name of the Feature.
      isActive:
        description: Indicates if the feature is enabled.
        type: boolean
      enabledForAllModels:
        description: Indicates if the feature is enabled for all models in the application.
        type: boolean
  PatternFeatureInfo:
    description: Pattern feature.
    type: object
    properties:
      pattern:
        description: The Regular Expression to match.
        type: string
    allOf:
      - $ref: '#/definitions/FeatureInfoObject'
  PatternFeatureInfoList:
    description: List of Pattern features.
    type: array
    items:
      $ref: '#/definitions/PatternFeatureInfo'
  PhraseListFeatureInfo:
    description: Phraselist Feature.
    type: object
    properties:
      phrases:
        type: string
        description: A list of comma-separated values.
      isExchangeable:
        description: >-
          An exchangeable phrase list feature are serves as single feature to
          the LUIS underlying training algorithm. It is used as a lexicon lookup
          feature where its value is 1 if the lexicon contains a given word or 0
          if it doesn’t. Think of an exchangeable as a synonyms list. A
          non-exchangeable phrase list feature has all the phrases in the list
          serve as separate features to the underlying training algorithm. So,
          if you your phrase list feature contains 5 phrases, they will be
          mapped to 5 separate features. You can think of the non-exchangeable
          phrase list feature as an additional bag of words that you are willing
          to add to LUIS existing vocabulary features. Think of a
          non-exchangeable as set of different words. Default value is true.
        type: boolean
    allOf:
      - $ref: '#/definitions/FeatureInfoObject'
  PhraseListFeatureInfoList:
    description: List of Phraselist Features.
    type: array
    items:
      $ref: '#/definitions/PhraseListFeatureInfo'
  LabelExampleResponse:
    description: Response when adding a labeled example utterance.
    type: object
    properties:
      UtteranceText:
        description: The example utterance.
        type: string
      ExampleId:
        description: The newly created example ID.
        type: integer
        format: int64
  BatchLabelExample:
    description: Response when adding a batch of labeled example utterances.
    type: object
    properties:
      value:
        $ref: '#/definitions/LabelExampleResponse'
      hasError:
        type: boolean
      error:
        $ref: '#/definitions/OperationStatus'
  BatchLabelExampleResponse:
    description: Response when adding a batch of labeled example utterances.
    type: array
    items:
      $ref: '#/definitions/BatchLabelExample'
  ApplicationInfoResponse:
    description: Response containing the Application Info.
    type: object
    properties:
      id:
        type: string
        format: uuid
        description: The ID (GUID) of the application.
      name:
        description: The name of the application.
        type: string
      description:
        description: The description of the application.
        type: string
      culture:
        description: The culture of the application. For example, "en-us".
        type: string
      usageScenario:
        description: >-
          Defines the scenario for the new application. Optional. For example,
          IoT.
        type: string
      domain:
        description: The domain for the new application. Optional. For example, Comics.
        type: string
      versionsCount:
        description: Amount of model versions within the application.
        type: integer
      createdDateTime:
        description: The version's creation timestamp.
        type: string
      endpoints:
        description: The Runtime endpoint URL for this model version.
        type: object
      endpointHitsCount:
        description: Number of calls made to this endpoint.
        type: integer
      activeVersion:
        description: The version ID currently marked as active.
        type: string
  ApplicationsInfoList:
    description: List of Application Infos.
    type: array
    items:
      $ref: '#/definitions/ApplicationInfoResponse'
  ProductionOrStagingEndpointInfo:
    type: object
    allOf:
      - $ref: '#/definitions/EndpointInfo'
  EndpointInfo:
    type: object
    description: The base class "ProductionOrStagingEndpointInfo" inherits from.
    properties:
      versionId:
        description: The version ID to publish.
        type: string
      isStaging:
        description: >-
          Indicates if the staging slot should be used, instead of the
          Production one.
        type: boolean
      endpointUrl:
        description: The Runtime endpoint URL for this model version.
        type: string
      region:
        description: The target region that the application is published to.
        type: string
      assignedEndpointKey:
        description: The endpoint key.
        type: string
      endpointRegion:
        type: string
        description: The endpoint's region.
      failedRegions:
        type: string
        description: Regions where publishing failed.
      publishedDateTime:
        description: Timestamp when was last published.
        type: string
  AvailableEndpoints:
    type: object
    description: Collection of endpoint URLs where the selected application is deployed to.
    additionalProperties:
      type: string
  AvailableCulture:
    description: Available culture for using in a new application.
    type: object
    properties:
      name:
        description: The language name.
        type: string
      code:
        description: The ISO value for the language.
        type: string
  AvailableCultures:
    type: array
    description: A list of available application cultures.
    items:
      $ref: '#/definitions/AvailableCulture'
  AvailableDomains:
    description: A list of available application domains.
    type: array
    items:
      type: string
  ApplicationUsageScenarios:
    description: A list of possible application usage scenarios.
    type: array
    items:
      type: string
  ApplicationSettings:
    description: The application settings.
    type: object
    properties:
      id:
        description: The application ID.
        type: string
        format: uuid
      public:
        description: >-
          Setting your application as public allows other people to use your
          application's endpoint using their own keys for billing purposes.
        type: boolean
        x-nullable: false
        x-ms-client-name: isPublic
    required:
      - id
      - public
  PublishSettings:
    description: The application publish settings.
    type: object
    properties:
      id:
        description: The application ID.
        type: string
        format: uuid
      sentimentAnalysis:
        description: >-
          Setting sentiment analysis as true returns the sentiment of the input
          utterance along with the response
        type: boolean
        x-nullable: false
        x-ms-client-name: IsSentimentAnalysisEnabled
      speech:
        description: Enables speech priming in your app
        type: boolean
        x-nullable: false
        x-ms-client-name: IsSpeechEnabled
      spellChecker:
        description: Enables spell checking of the utterance.
        type: boolean
        x-nullable: false
        x-ms-client-name: IsSpellCheckerEnabled
    required:
      - id
      - sentimentAnalysis
      - speech
      - spellChecker
  AvailablePrebuiltEntityModel:
    description: Available Prebuilt entity model for using in an application.
    type: object
    properties:
      name:
        description: The entity name.
        type: string
      description:
        description: The entity description and usage information.
        type: string
      examples:
        description: Usage examples.
        type: string
  AvailablePrebuiltEntityModels:
    description: List of Available Prebuilt entity models.
    type: array
    items:
      $ref: '#/definitions/AvailablePrebuiltEntityModel'
  EnqueueTrainingResponse:
    description: Response model when requesting to train the model.
    type: object
    properties:
      statusId:
        description: The train request status ID.
        type: integer
      status:
        $ref: '#/definitions/TrainingStatus'
  TrainingStatus:
    description: The Training status.
    type: string
    enum:
      - Queued
      - InProgress
      - UpToDate
      - Fail
      - Success
  ModelTrainingInfo:
    description: Model Training Info.
    type: object
    properties:
      modelId:
        type: string
        format: uuid
        description: The ID (GUID) of the model.
      details:
        $ref: '#/definitions/ModelTrainingDetails'
  ModelTrainingDetails:
    description: Model Training Details.
    type: object
    properties:
      statusId:
        description: The train request status ID.
        type: integer
      status:
        $ref: '#/definitions/TrainingStatus'
      exampleCount:
        description: The count of examples used to train the model.
        type: integer
      trainingDateTime:
        description: When the model was trained.
        type: string
        format: date-time
      failureReason:
        description: Reason for the training failure.
        type: string
  ModelTrainingInfoList:
    description: List of Model Training Infos.
    type: array
    items:
      $ref: '#/definitions/ModelTrainingInfo'
  UserAccessList:
    description: List of user permissions.
    type: object
    properties:
      owner:
        type: string
        description: The email address of owner of the application.
      emails:
        type: array
        items:
          type: string
  UserCollaborator:
    type: object
    properties:
      email:
        type: string
        description: The email address of the user.
  CollaboratorsArray:
    type: object
    properties:
      emails:
        type: array
        description: The email address of the users.
        items:
          type: string
  OperationStatus:
    description: Response of an Operation status.
    type: object
    properties:
      code:
        type: string
        description: Status Code.
        enum:
          - Failed
          - FAILED
          - Success
        x-ms-enum:
          modelAsString: true
          name: OperationStatusType
      message:
        type: string
        description: Status details.
  ErrorResponse:
    description: Error response when invoking an operation on the API.
    type: object
    properties:
      errorType:
        type: string
    additionalProperties:
      type: object
  OperationError:
    description: Operation error details when invoking an operation on the API.
    type: object
    properties:
      code:
        type: string
      message:
        type: string
  PrebuiltDomainsList:
    description: List of Prebuilt Domains.
    type: array
    items:
      $ref: '#/definitions/PrebuiltDomain'
  PrebuiltDomain:
    description: Prebuilt Domain.
    type: object
    properties:
      name:
        type: string
      culture:
        type: string
      description:
        type: string
      examples:
        type: string
      intents:
        type: array
        items:
          $ref: '#/definitions/PrebuiltDomainItem'
      entities:
        type: array
        items:
          $ref: '#/definitions/PrebuiltDomainItem'
  PrebuiltDomainItem:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      examples:
        type: string
  GuidList:
    description: List of IDs (GUID)
    type: array
    items:
      $ref: '#/definitions/GuidResponse'
  EntityRoleCreateObject:
    description: Object model for creating an entity role.
    type: object
    properties:
      name:
        description: The entity role name.
        type: string
  RegexModelCreateObject:
    description: Model object for creating a regular expression entity model.
    type: object
    properties:
      regexPattern:
        description: The regular expression entity pattern.
        type: string
      name:
        description: The model name.
        type: string
  PatternAnyModelCreateObject:
    description: Model object for creating a Pattern.Any entity model.
    type: object
    properties:
      name:
        description: The model name.
        type: string
      explicitList:
        description: The Pattern.Any explicit list.
        type: array
        items:
          type: string
  ExplicitListItemCreateObject:
    description: Object model for creating an explicit (exception) list item.
    type: object
    properties:
      explicitListItem:
        description: The explicit list item.
        type: string
  RegexModelUpdateObject:
    description: Model object for updating a regular expression entity model.
    type: object
    properties:
      regexPattern:
        description: The regular expression entity pattern.
        type: string
      name:
        description: The model name.
        type: string
  PatternAnyModelUpdateObject:
    description: Model object for updating a Pattern.Any entity model.
    type: object
    properties:
      name:
        description: The model name.
        type: string
      explicitList:
        description: The Pattern.Any explicit list.
        type: array
        items:
          type: string
  EntityRoleUpdateObject:
    description: Object model for updating an entity role.
    type: object
    properties:
      name:
        description: The entity role name.
        type: string
  ExplicitListItemUpdateObject:
    description: Model object for updating an explicit (exception) list item.
    type: object
    properties:
      explicitListItem:
        description: The explicit list item.
        type: string
  PatternRuleCreateObject:
    description: Object model for creating a pattern
    type: object
    properties:
      pattern:
        description: The pattern text.
        type: string
      intent:
        description: The intent's name which the pattern belongs to.
        type: string
  PatternRuleUpdateObject:
    description: Object model for updating a pattern.
    type: object
    properties:
      id:
        format: uuid
        description: The pattern ID.
        type: string
      pattern:
        description: The pattern text.
        type: string
      intent:
        description: The intent's name which the pattern belongs to.
        type: string
  RegexEntityExtractor:
    description: Regular Expression Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      regexPattern:
        description: The Regular Expression entity pattern.
        type: string
  RegexEntityExtractorList:
    description: List of Regular Expression Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/RegexEntityExtractor'
  PatternAnyEntityExtractor:
    description: Pattern.Any Entity Extractor.
    type: object
    allOf:
      - $ref: '#/definitions/ModelInfo'
      - $ref: '#/definitions/EntityModelInfo'
    properties:
      explicitList:
        $ref: '#/definitions/ExplicitListItemList'
  PatternAnyEntityExtractorList:
    description: List of Pattern.Any Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/PatternAnyEntityExtractor'
  EntityRole:
    description: Entity extractor role
    type: object
    properties:
      id:
        format: uuid
        description: The entity role ID.
        type: string
      name:
        description: The entity role name.
        type: string
  EntityRoleList:
    description: List of Pattern.Any Entity Extractors.
    type: array
    items:
      $ref: '#/definitions/EntityRole'
  ExplicitListItem:
    description: Explicit (exception) list item
    type: object
    properties:
      id:
        format: int64
        description: The explicit list item ID.
        type: integer
      explicitListItem:
        description: The explicit list item value.
        type: string
  ExplicitListItemList:
    description: List of explicit (exception) list items
    type: array
    items:
      $ref: '#/definitions/ExplicitListItem'
  ExplicitListItemIDResponse:
    description: The ID of the created explicit list item.
    type: integer
    x-nullable: false
  PatternRuleInfo:
    description: Pattern rule
    type: object
    properties:
      id:
        format: uuid
        description: The pattern ID.
        type: string
      pattern:
        description: The pattern text.
        type: string
      intent:
        description: The intent's name where the pattern belongs to.
        type: string
  PatternRuleList:
    description: List of patterns
    type: array
    items:
      $ref: '#/definitions/PatternRuleInfo'
  ExamplesPerModelResponseObject:
    description: A list of example utterances per model.
    type: array
    items:
      $ref: '#/definitions/LabelTextObject'
  LabelTextObject:
    description: An object containing the example utterance's text.
    type: object
    properties:
      id:
        type: integer
        description: The ID of the Label.
      text:
        type: string
        description: The text of the label.
  FeaturesPerModelResponseObject:
    description: A list of feature information objects per model.
    type: array
    items:
      $ref: '#/definitions/ModelFeatureInformation'
  ModelFeatureInformation:
    description: >-
      An object containing the model feature information either the model name
      or feature name.
    type: object
    properties:
      modelName:
        type: string
        description: The name of the model used.
      featureName:
        type: string
        description: The name of the feature used.
      isRequired:
        type: boolean
  JsonModelFeatureInformation:
    description: >-
      An object containing the model feature information either the model name
      or feature name.
    type: object
    properties:
      modelName:
        type: string
        description: The name of the model used.
      featureName:
        type: string
        description: The name of the feature used.
  PatternAny:
    description: Pattern.Any Entity Extractor.
    type: object
    properties:
      name:
        type: string
      explicitList:
        items:
          type: string
        type: array
      roles:
        items:
          type: string
        type: array
  RegexEntity:
    description: Regular Expression Entity Extractor.
    type: object
    properties:
      name:
        type: string
      regexPattern:
        type: string
      roles:
        items:
          type: string
        type: array
  PrebuiltEntity:
    description: Prebuilt Entity Extractor.
    type: object
    properties:
      name:
        type: string
      roles:
        items:
          type: string
        type: array
  PatternRule:
    description: Pattern
    type: object
    properties:
      pattern:
        description: The pattern text.
        type: string
      intent:
        description: The intent's name where the pattern belongs to.
        type: string
  AppVersionSettingObject:
    description: Object model of an application version setting.
    type: object
    properties:
      name:
        description: The application version setting name.
        type: string
      value:
        description: The application version setting value.
        type: string
  AzureAccountInfoList:
    description: List of Azure account info objects.
    type: array
    items:
      $ref: '#/definitions/AzureAccountInfoObject'
  AzureAccountInfoObject:
    description: Defines the Azure account information object.
    type: object
    required:
      - azureSubscriptionId
      - resourceGroup
      - accountName
    properties:
      azureSubscriptionId:
        description: The id for the Azure subscription.
        type: string
      resourceGroup:
        description: The Azure resource group name.
        type: string
      accountName:
        description: The Azure account name.
        type: string
parameters:
  AppIdInPath:
    name: appId
    in: path
    required: true
    type: string
    format: uuid
    description: The application ID.
    x-ms-parameter-location: method
  VersionIdInPath:
    name: versionId
    in: path
    description: The version ID.
    required: true
    type: string
    x-ms-parameter-location: method
  CEntityIdInPath:
    name: cEntityId
    in: path
    description: The composite entity extractor ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  HEntityIdInPath:
    name: hEntityId
    in: path
    description: The hierarchical entity extractor ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  IntentIdInPath:
    name: intentId
    in: path
    description: The intent classifier ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  EntityIdInPath:
    name: entityId
    in: path
    description: The entity extractor ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  SlotNameInPath:
    name: slotName
    in: path
    description: The publishing slot name.
    required: true
    type: string
    x-ms-parameter-location: method
  SkipInPath:
    name: skip
    in: query
    description: The number of entries to skip. Default value is 0.
    type: integer
    default: 0
    minimum: 0
    x-ms-parameter-location: method
  TakeInPath:
    name: take
    in: query
    description: The number of entries to return. Maximum page size is 500. Default is 100.
    type: integer
    default: 100
    minimum: 0
    maximum: 500
    x-ms-parameter-location: method
  ForcePath:
    name: force
    in: query
    description: A flag to indicate whether to force an operation.
    type: boolean
    default: false
    x-ms-parameter-location: method
  BearerAuthPath:
    name: Authorization
    in: header
    description: >-
      The bearer authorization header to use; containing the user's ARM token
      used to validate Azure accounts information.
    required: true
    type: string
    x-ms-parameter-location: method
  ArmTokenParameter:
    in: header
    name: ArmToken
    required: false
    description: >-
      The custom arm token header to use; containing the user's ARM token used
      to validate azure accounts information.
    type: string
    x-ms-parameter-location: method
  Endpoint:
    name: Endpoint
    description: >-
      Supported Cognitive Services endpoints (protocol and hostname, for
      example: https://westus.api.cognitive.microsoft.com).
    x-ms-parameter-location: client
    required: true
    type: string
    in: path
    x-ms-skip-url-encoding: true
  EnableNestedChildren:
    name: enableNestedChildren
    in: query
    type: boolean
    default: false
    description: Toggles nested/flat format
    x-ms-parameter-location: method
tags:
  - name: Apps
  - name: Azureaccounts
  - name: Package