The Microsoft Azure Luis Authoring Client is a tool used for building and managing Language Understanding (LUIS) applications. LUIS is a cloud-based service that allows developers to create natural language understanding models to interpret user input and extract relevant information. With the Authoring Client, users can easily define intents and entities, train models, and test how well their application understands and processes different types of input.
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
# --- truncated at 32 KB (255 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/luis-authoring-client-openapi-original.yml