azure.cognitiveservices.language.luis.authoring.models module

exception azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject(*, entity_name: str, start_char_index: int, end_char_index: int, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the entity type and position of the extracted entity within the example.

All required parameters must be populated in order to send to Azure.

Parameters:
  • entity_name (str) – Required. The entity type.
  • start_char_index (int) – Required. The index within the utterance where the extracted entity starts.
  • end_char_index (int) – Required. The index within the utterance where the extracted entity ends.
class azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject(*, culture: str, name: str, domain: str = None, description: str = None, initial_version_id: str = None, usage_scenario: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties for creating a new LUIS Application.

All required parameters must be populated in order to send to Azure.

Parameters:
  • culture (str) – Required. 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.
  • domain (str) – The domain for the new application. Optional. E.g.: Comics.
  • description (str) – Description of the new application. Optional.
  • initial_version_id (str) – The initial version ID. Optional. Default value is: “0.1”
  • usage_scenario (str) – Defines the scenario for the new application. Optional. E.g.: IoT.
  • name (str) – Required. The name for the new application.
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject(*, domain_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs.

Parameters:domain_name (str) – The domain name.
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject(*, domain_name: str = None, culture: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A prebuilt domain create object containing the name and culture of the domain.

Parameters:
  • domain_name (str) – The domain name.
  • culture (str) – The culture of the new domain.
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject(*, domain_name: str = None, model_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.

Parameters:
  • domain_name (str) – The domain name.
  • model_name (str) – The intent name or entity name.
class azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityModel(*, children=None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A Hierarchical Entity Extractor.

Parameters:
  • children (list[str]) – Child entities.
  • name (str) – Entity name.
class azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel(*, children=None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A composite entity.

Parameters:
  • children (list[str]) – Child entities.
  • name (str) – Entity name.
class azure.cognitiveservices.language.luis.authoring.models.JSONEntity(*, start_pos: int, end_pos: int, entity: str, **kwargs)[source]

Bases: msrest.serialization.Model

Exported Model - Extracted Entity from utterance.

All required parameters must be populated in order to send to Azure.

Parameters:
  • start_pos (int) – Required. The index within the utterance where the extracted entity starts.
  • end_pos (int) – Required. The index within the utterance where the extracted entity ends.
  • entity (str) – Required. The entity name.
class azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject(*, public: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating an application’s settings.

Parameters:public (bool) – Setting your application as public allows other people to use your application’s endpoint using their own keys.
class azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject(*, sentiment_analysis: bool = None, speech: bool = None, spell_checker: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating an application’s publish settings.

Parameters:
  • sentiment_analysis (bool) – Setting sentiment analysis as true returns the Sentiment of the input utterance along with the resopnse
  • speech (bool) – Setting speech as public enables speech priming in your app
  • spell_checker (bool) – Setting spell checker as public enables spell checking the input utterance.
class azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject(*, text: str = None, entity_labels=None, intent_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A labeled example.

Parameters:
  • text (str) – The sample’s utterance.
  • entity_labels (list[EntityLabelObject]) – The idenfied entities within the utterance.
  • intent_name (str) – The idenfitied intent representing the utterance.
class azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject(*, phrases: str = None, name: str = None, is_exchangeable: bool = True, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating a phraselist model.

Parameters:
  • phrases (str) – List of comma-separated phrases that represent the Phraselist.
  • name (str) – The Phraselist name.
  • is_exchangeable (bool) – 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 value: True .
class azure.cognitiveservices.language.luis.authoring.models.SubClosedList(*, canonical_form: str = None, list=None, **kwargs)[source]

Bases: msrest.serialization.Model

Sublist of items for a Closed list.

Parameters:
  • canonical_form (str) – The standard form that the list represents.
  • list (list[str]) – List of synonym words.
class azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse(*, canonical_form: str = None, list=None, id: int = None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.sub_closed_list_py3.SubClosedList

Sublist of items for a Closed list.

Parameters:
  • canonical_form (str) – The standard form that the list represents.
  • list (list[str]) – List of synonym words.
  • id (int) – The sublist ID
class azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject(*, name: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating the name or description of an application.

Parameters:
  • name (str) – The application’s new name.
  • description (str) – The application’s new description.
class azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature(*, pattern: str = None, activated: bool = None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Exported Model - A Pattern feature.

Parameters:
  • pattern (str) – The Regular Expression to match.
  • activated (bool) – Indicates if the Pattern feature is enabled.
  • name (str) – Name of the feature.
class azure.cognitiveservices.language.luis.authoring.models.PatternUpdateObject(*, pattern: str = None, name: str = None, is_active: bool = True, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating an existing Pattern feature.

Parameters:
  • pattern (str) – The Regular Expression to match.
  • name (str) – Name of the feature.
  • is_active (bool) – Indicates if the Pattern feature is enabled. Default value: True .
class azure.cognitiveservices.language.luis.authoring.models.ClosedList(*, name: str = None, sub_lists=None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exported Model - A Closed List.

Parameters:
  • name (str) – Name of the closed list feature.
  • sub_lists (list[SubClosedList]) – Sublists for the feature.
  • roles (list[str]) –
class azure.cognitiveservices.language.luis.authoring.models.WordListObject(*, canonical_form: str = None, list=None, **kwargs)[source]

Bases: msrest.serialization.Model

Sublist of items for a Closed list.

Parameters:
  • canonical_form (str) – The standard form that the list represents.
  • list (list[str]) – List of synonym words.
class azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject(*, sub_lists=None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for adding a batch of sublists to an existing closedlist.

Parameters:sub_lists (list[WordListObject]) – Sublists to add.
class azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature(*, activated: bool = None, name: str = None, words: str = None, mode: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Exported Model - Phraselist Model Feature.

Parameters:
  • activated (bool) – Indicates if the feature is enabled.
  • name (str) – The Phraselist name.
  • words (str) – List of comma-separated phrases that represent the Phraselist.
  • mode (bool) – 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.
class azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating a new entity extractor.

Parameters:name (str) – Name of the new entity extractor.
class azure.cognitiveservices.language.luis.authoring.models.PatternCreateObject(*, pattern: str = None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating a Pattern feature.

Parameters:
  • pattern (str) – The Regular Expression to match.
  • name (str) – Name of the feature.
class azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject(*, canonical_form: str = None, list=None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating one of the closed list’s sublists.

Parameters:
  • canonical_form (str) – The standard form that the list represents.
  • list (list[str]) – List of synonym words.
class azure.cognitiveservices.language.luis.authoring.models.JSONUtterance(*, text: str = None, intent: str = None, entities=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exported Model - Utterance that was used to train the model.

Parameters:
  • text (str) – The utterance.
  • intent (str) – The matched intent.
  • entities (list[JSONEntity]) – The matched entities.
class azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating an intent classifier.

Parameters:name (str) – The entity’s new name.
class azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject(*, sub_lists=None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating a closed list.

Parameters:
  • sub_lists (list[WordListObject]) – The new sublists for the feature.
  • name (str) – The new name of the closed list feature.
class azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject(*, sub_lists=None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating a closed list.

Parameters:
  • sub_lists (list[WordListObject]) – Sublists for the feature.
  • name (str) – Name of the closed list feature.
class azure.cognitiveservices.language.luis.authoring.models.VersionInfo(*, version: str, training_status, created_date_time=None, last_modified_date_time=None, last_trained_date_time=None, last_published_date_time=None, endpoint_url: str = None, assigned_endpoint_key=None, external_api_keys=None, intents_count: int = None, entities_count: int = None, endpoint_hits_count: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model of an application version.

All required parameters must be populated in order to send to Azure.

Parameters:
  • version (str) – Required. The version ID. E.g.: “0.1”
  • created_date_time (datetime) – The version’s creation timestamp.
  • last_modified_date_time (datetime) – Timestamp of the last update.
  • last_trained_date_time (datetime) – Timestamp of the last time the model was trained.
  • last_published_date_time (datetime) – Timestamp when was last published.
  • endpoint_url (str) – The Runtime endpoint URL for this model version.
  • assigned_endpoint_key (dict[str, str]) – The endpoint key.
  • external_api_keys (object) – External keys.
  • intents_count (int) – Number of intents in this model.
  • entities_count (int) – Number of entities in this model.
  • endpoint_hits_count (int) – Number of calls made to this endpoint.
  • training_status (str or TrainingStatus) – Required. The current training status. Possible values include: ‘NeedsTraining’, ‘InProgress’, ‘Trained’
class azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject(*, version: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for cloning an application’s version.

Parameters:version (str) – The new version for the cloned model.
class azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject(*, phrases: str = None, name: str = None, is_active: bool = True, is_exchangeable: bool = True, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating a Phraselist.

Parameters:
  • phrases (str) – List of comma-separated phrases that represent the Phraselist.
  • name (str) – The Phraselist name.
  • is_active (bool) – Indicates if the Phraselist is enabled. Default value: True .
  • is_exchangeable (bool) – 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 value: True .
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject(*, domain_name: str = None, model_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

PrebuiltDomainObject.

Parameters:
  • domain_name (str) –
  • model_name (str) –
class azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel(*, name: str = None, children=None, inherits=None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

HierarchicalModel.

Parameters:
class azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject(*, version_id: str = None, is_staging: bool = False, region: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for publishing a specific application version.

Parameters:
  • version_id (str) – The version ID to publish.
  • is_staging (bool) – Indicates if the staging slot should be used, instead of the Production one. Default value: False .
  • region (str) – The target region that the application is published to.
class azure.cognitiveservices.language.luis.authoring.models.PatternAny(*, name: str = None, explicit_list=None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

Pattern.Any Entity Extractor.

Parameters:
  • name (str) –
  • explicit_list (list[str]) –
  • roles (list[str]) –
class azure.cognitiveservices.language.luis.authoring.models.RegexEntity(*, name: str = None, regex_pattern: str = None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

Regular Expression Entity Extractor.

Parameters:
  • name (str) –
  • regex_pattern (str) –
  • roles (list[str]) –
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity(*, name: str = None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

Prebuilt Entity Extractor.

Parameters:
  • name (str) –
  • roles (list[str]) –
class azure.cognitiveservices.language.luis.authoring.models.PatternRule(*, pattern: str = None, intent: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Pattern.

Parameters:
  • pattern (str) – The pattern text.
  • intent (str) – The intent’s name where the pattern belongs to.
class azure.cognitiveservices.language.luis.authoring.models.LuisApp(*, additional_properties=None, name: str = None, version_id: str = None, desc: str = None, culture: str = None, intents=None, entities=None, closed_lists=None, composites=None, pattern_any_entities=None, regex_entities=None, prebuilt_entities=None, regex_features=None, model_features=None, patterns=None, utterances=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exported Model - An exported LUIS Application.

Parameters:
  • additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
  • name (str) – The name of the application.
  • version_id (str) – The version ID of the application that was exported.
  • desc (str) – The description of the application.
  • culture (str) – The culture of the application. E.g.: en-us.
  • intents (list[HierarchicalModel]) – List of intents.
  • entities (list[HierarchicalModel]) – List of entities.
  • closed_lists (list[ClosedList]) – List of closed lists.
  • composites (list[HierarchicalModel]) – List of composite entities.
  • pattern_any_entities (list[PatternAny]) – List of Pattern.Any entities.
  • regex_entities (list[RegexEntity]) – List of regular expression entities.
  • prebuilt_entities (list[PrebuiltEntity]) – List of prebuilt entities.
  • regex_features (list[JSONRegexFeature]) – List of pattern features.
  • model_features (list[JSONModelFeature]) – List of model features.
  • patterns (list[PatternRule]) – List of patterns.
  • utterances (list[JSONUtterance]) – List of sample utterances.
class azure.cognitiveservices.language.luis.authoring.models.EntityLabel(*, entity_name: str, start_token_index: int, end_token_index: int, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the entity type and position of the extracted entity within the example.

All required parameters must be populated in order to send to Azure.

Parameters:
  • entity_name (str) – Required. The entity type.
  • start_token_index (int) – Required. The index within the utterance where the extracted entity starts.
  • end_token_index (int) – Required. The index within the utterance where the extracted entity ends.
class azure.cognitiveservices.language.luis.authoring.models.IntentPrediction(*, name: str = None, score: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

A suggested intent.

Parameters:
  • name (str) – The intent’s name
  • score (float) – The intent’s score, based on the prediction model.
class azure.cognitiveservices.language.luis.authoring.models.EntityPrediction(*, entity_name: str, start_token_index: int, end_token_index: int, phrase: str, **kwargs)[source]

Bases: msrest.serialization.Model

A suggested entity.

All required parameters must be populated in order to send to Azure.

Parameters:
  • entity_name (str) – Required. The entity’s name
  • start_token_index (int) – Required. The index within the utterance where the extracted entity starts.
  • end_token_index (int) – Required. The index within the utterance where the extracted entity ends.
  • phrase (str) – Required. The actual token(s) that comprise the entity.
class azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance(*, id: int = None, text: str = None, tokenized_text=None, intent_label: str = None, entity_labels=None, intent_predictions=None, entity_predictions=None, **kwargs)[source]

Bases: msrest.serialization.Model

A prediction and label pair of an example.

Parameters:
  • id (int) – ID of Labeled Utterance.
  • text (str) – The utterance. E.g.: what’s the weather like in seattle?
  • tokenized_text (list[str]) – The utterance tokenized.
  • intent_label (str) – The intent matching the example.
  • entity_labels (list[EntityLabel]) – The entities matching the example.
  • intent_predictions (list[IntentPrediction]) – List of suggested intents.
  • entity_predictions (list[EntityPrediction]) – List of suggested entities.
class azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample(*, text: str = None, tokenized_text=None, intent_predictions=None, entity_predictions=None, **kwargs)[source]

Bases: msrest.serialization.Model

Predicted/suggested intent.

Parameters:
  • text (str) – The utterance. E.g.: what’s the weather like in seattle?
  • tokenized_text (list[str]) – The utterance tokenized.
  • intent_predictions (list[IntentPrediction]) – Predicted/suggested intents.
  • entity_predictions (list[EntityPrediction]) – Predicted/suggested entities.
class azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample(*, text: str = None, tokenized_text=None, intent_predictions=None, entity_predictions=None, **kwargs)[source]

Bases: msrest.serialization.Model

Predicted/suggested entity.

Parameters:
  • text (str) – The utterance. E.g.: what’s the weather like in seattle?
  • tokenized_text (list[str]) – The utterance tokenized.
  • intent_predictions (list[IntentPrediction]) – Predicted/suggested intents.
  • entity_predictions (list[EntityPrediction]) – Predicted/suggested entities.
class azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse(*, endpoint_keys=None, endpoint_urls=None, **kwargs)[source]

Bases: msrest.serialization.Model

Response containing user’s endpoint keys and the endpoint URLs of the prebuilt Cortana applications.

Parameters:
  • endpoint_keys (list[str]) –
  • endpoint_urls (dict[str, str]) –
class azure.cognitiveservices.language.luis.authoring.models.ModelInfo(*, id: str, readable_type, name: str = None, type_id: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Base type used in entity types.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
class azure.cognitiveservices.language.luis.authoring.models.EntityRole(*, id: str = None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Entity extractor role.

Parameters:
  • id (str) – The entity role ID.
  • name (str) – The entity role name.
class azure.cognitiveservices.language.luis.authoring.models.ChildEntity(*, id: str, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The base child entity type.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID (GUID) belonging to a child entity.
  • name (str) – The name of a child entity.
class azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem(*, id: int = None, explicit_list_item: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Explicit list item.

Parameters:
  • id (long) – The explicit list item ID.
  • explicit_list_item (str) – The explicit list item value.
class azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, children=None, sub_lists=None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: str = None, regex_pattern: str = None, explicit_list=None, **kwargs)[source]

Bases: msrest.serialization.Model

An application model info.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • children (list[ChildEntity]) – List of child entities.
  • sub_lists (list[SubClosedListResponse]) – List of sub-lists.
  • custom_prebuilt_domain_name (str) – The domain name.
  • custom_prebuilt_model_name (str) – The intent name or entity name.
  • regex_pattern (str) – The Regex entity pattern.
  • explicit_list (list[ExplicitListItem]) –
class azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.model_info_py3.ModelInfo

An Entity Extractor model info.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
class azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, children=None, **kwargs)[source]

Bases: msrest.serialization.Model

Hierarchical Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • children (list[ChildEntity]) – List of child entities.
class azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, children=None, **kwargs)[source]

Bases: msrest.serialization.Model

A Composite Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • children (list[ChildEntity]) – List of child entities.
class azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, sub_lists=None, **kwargs)[source]

Bases: msrest.serialization.Model

Closed List Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • sub_lists (list[SubClosedListResponse]) – List of sub-lists.
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

Prebuilt Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
class azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity(*, id: str, name: str = None, type_id: int = None, readable_type=None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.child_entity_py3.ChildEntity

A Hierarchical Child Entity.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID (GUID) belonging to a child entity.
  • name (str) – The name of a child entity.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
class azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel(*, id: str, readable_type, name: str = None, type_id: int = None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: str = None, roles=None, **kwargs)[source]

Bases: msrest.serialization.Model

A Custom Prebuilt model.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • custom_prebuilt_domain_name (str) – The domain name.
  • custom_prebuilt_model_name (str) – The intent name or entity name.
  • roles (list[EntityRole]) –
class azure.cognitiveservices.language.luis.authoring.models.IntentClassifier(*, id: str, readable_type, name: str = None, type_id: int = None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: str = None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.model_info_py3.ModelInfo

Intent Classifier.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • custom_prebuilt_domain_name (str) – The domain name.
  • custom_prebuilt_model_name (str) – The intent name or entity name.
class azure.cognitiveservices.language.luis.authoring.models.EntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • custom_prebuilt_domain_name (str) – The domain name.
  • custom_prebuilt_model_name (str) – The intent name or entity name.
class azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo(*, id: int = None, name: str = None, is_active: bool = None, phrases: str = None, is_exchangeable: bool = None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.feature_info_object_py3.FeatureInfoObject

Phraselist Feature.

Parameters:
  • id (int) – A six-digit ID used for Features.
  • name (str) – The name of the Feature.
  • is_active (bool) – Indicates if the feature is enabled.
  • phrases (str) – A list of comma-separated values.
  • is_exchangeable (bool) – 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.
class azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo(*, id: int = None, name: str = None, is_active: bool = None, pattern: str = None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.feature_info_object_py3.FeatureInfoObject

Pattern feature.

Parameters:
  • id (int) – A six-digit ID used for Features.
  • name (str) – The name of the Feature.
  • is_active (bool) – Indicates if the feature is enabled.
  • pattern (str) – The Regular Expression to match.
class azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject(*, phraselist_features=None, pattern_features=None, **kwargs)[source]

Bases: msrest.serialization.Model

Model Features, including Patterns and Phraselists.

Parameters:
class azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject(*, id: int = None, name: str = None, is_active: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

The base class Features-related response objects inherit from.

Parameters:
  • id (int) – A six-digit ID used for Features.
  • name (str) – The name of the Feature.
  • is_active (bool) – Indicates if the feature is enabled.
class azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse(*, utterance_text: str = None, example_id: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response when adding a labeled example.

Parameters:
  • utterance_text (str) – The sample’s utterance.
  • example_id (int) – The newly created sample ID.
class azure.cognitiveservices.language.luis.authoring.models.OperationStatus(*, code=None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response of an Operation status.

Parameters:
  • code (str or OperationStatusType) – Status Code. Possible values include: ‘Failed’, ‘FAILED’, ‘Success’
  • message (str) – Status details.
class azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample(*, value=None, has_error: bool = None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

Response when adding a batch of labeled examples.

Parameters:
class azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse(*, id: str = None, name: str = None, description: str = None, culture: str = None, usage_scenario: str = None, domain: str = None, versions_count: int = None, created_date_time: str = None, endpoints=None, endpoint_hits_count: int = None, active_version: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response containing the Application Info.

Parameters:
  • id (str) – The ID (GUID) of the application.
  • name (str) – The name of the application.
  • description (str) – The description of the application.
  • culture (str) – The culture of the application. E.g.: en-us.
  • usage_scenario (str) – Defines the scenario for the new application. Optional. E.g.: IoT.
  • domain (str) – The domain for the new application. Optional. E.g.: Comics.
  • versions_count (int) – Amount of model versions within the application.
  • created_date_time (str) – The version’s creation timestamp.
  • endpoints (object) – The Runtime endpoint URL for this model version.
  • endpoint_hits_count (int) – Number of calls made to this endpoint.
  • active_version (str) – The version ID currently marked as active.
class azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo(*, version_id: str = None, is_staging: bool = None, endpoint_url: str = None, region: str = None, assigned_endpoint_key: str = None, endpoint_region: str = None, published_date_time: str = None, **kwargs)[source]

Bases: azure.cognitiveservices.language.luis.authoring.models.endpoint_info_py3.EndpointInfo

ProductionOrStagingEndpointInfo.

Parameters:
  • version_id (str) – The version ID to publish.
  • is_staging (bool) – Indicates if the staging slot should be used, instead of the Production one.
  • endpoint_url (str) – The Runtime endpoint URL for this model version.
  • region (str) – The target region that the application is published to.
  • assigned_endpoint_key (str) – The endpoint key.
  • endpoint_region (str) – The endpoint’s region.
  • published_date_time (str) – Timestamp when was last published.
class azure.cognitiveservices.language.luis.authoring.models.EndpointInfo(*, version_id: str = None, is_staging: bool = None, endpoint_url: str = None, region: str = None, assigned_endpoint_key: str = None, endpoint_region: str = None, published_date_time: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The base class “ProductionOrStagingEndpointInfo” inherits from.

Parameters:
  • version_id (str) – The version ID to publish.
  • is_staging (bool) – Indicates if the staging slot should be used, instead of the Production one.
  • endpoint_url (str) – The Runtime endpoint URL for this model version.
  • region (str) – The target region that the application is published to.
  • assigned_endpoint_key (str) – The endpoint key.
  • endpoint_region (str) – The endpoint’s region.
  • published_date_time (str) – Timestamp when was last published.
class azure.cognitiveservices.language.luis.authoring.models.AvailableCulture(*, name: str = None, code: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Available culture for using in a new application.

Parameters:
  • name (str) – The language name.
  • code (str) – The ISO value for the language.
class azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings(*, id: str, is_public: bool, **kwargs)[source]

Bases: msrest.serialization.Model

The application settings.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The application ID.
  • is_public (bool) – Required. Setting your application as public allows other people to use your application’s endpoint using their own keys.
class azure.cognitiveservices.language.luis.authoring.models.PublishSettings(*, id: str, is_sentiment_analysis_enabled: bool, is_speech_enabled: bool, is_spell_checker_enabled: bool, **kwargs)[source]

Bases: msrest.serialization.Model

The application publish settings.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The application ID.
  • is_sentiment_analysis_enabled (bool) – Required. Setting sentiment analysis as true returns the Sentiment of the input utterance along with the resopnse
  • is_speech_enabled (bool) – Required. Setting speech as public enables speech priming in your app
  • is_spell_checker_enabled (bool) – Required. Setting spell checker as public enables spell checking the input utterance.
class azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel(*, name: str = None, description: str = None, examples: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Available Prebuilt entity model for using in an application.

Parameters:
  • name (str) – The entity name.
  • description (str) – The entity description and usage information.
  • examples (str) – Usage examples.
class azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse(*, status_id: int = None, status=None, **kwargs)[source]

Bases: msrest.serialization.Model

Response model when requesting to train the model.

Parameters:
  • status_id (int) – The train request status ID.
  • status (str or enum) – Possible values include: ‘Queued’, ‘InProgress’, ‘UpToDate’, ‘Fail’, ‘Success’
class azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails(*, status_id: int = None, status=None, example_count: int = None, training_date_time=None, failure_reason: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Model Training Details.

Parameters:
  • status_id (int) – The train request status ID.
  • status (str or enum) – Possible values include: ‘Queued’, ‘InProgress’, ‘UpToDate’, ‘Fail’, ‘Success’
  • example_count (int) – The count of examples used to train the model.
  • training_date_time (datetime) – When the model was trained.
  • failure_reason (str) – Reason for the training failure.
class azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo(*, model_id: str = None, details=None, **kwargs)[source]

Bases: msrest.serialization.Model

Model Training Info.

Parameters:
class azure.cognitiveservices.language.luis.authoring.models.UserAccessList(*, owner: str = None, emails=None, **kwargs)[source]

Bases: msrest.serialization.Model

List of user permissions.

Parameters:
  • owner (str) – The email address of owner of the application.
  • emails (list[str]) –
class azure.cognitiveservices.language.luis.authoring.models.UserCollaborator(*, email: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

UserCollaborator.

Parameters:email (str) – The email address of the user.
class azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray(*, emails=None, **kwargs)[source]

Bases: msrest.serialization.Model

CollaboratorsArray.

Parameters:emails (list[str]) – The email address of the users.
class azure.cognitiveservices.language.luis.authoring.models.ErrorResponse(*, additional_properties=None, error_type: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error response when invoking an operation on the API.

Parameters:
  • additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
  • error_type (str) –
class azure.cognitiveservices.language.luis.authoring.models.OperationError(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Operation error details when invoking an operation on the API.

Parameters:
  • code (str) –
  • message (str) –
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem(*, name: str = None, description: str = None, examples: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

PrebuiltDomainItem.

Parameters:
  • name (str) –
  • description (str) –
  • examples (str) –
class azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain(*, name: str = None, culture: str = None, description: str = None, examples: str = None, intents=None, entities=None, **kwargs)[source]

Bases: msrest.serialization.Model

Prebuilt Domain.

Parameters:
class azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating an entity role.

Parameters:name (str) – The entity role name.
class azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject(*, regex_pattern: str = None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Model object for creating a regex entity model.

Parameters:
  • regex_pattern (str) – The regex entity pattern.
  • name (str) – The model name.
class azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject(*, name: str = None, explicit_list=None, **kwargs)[source]

Bases: msrest.serialization.Model

Model object for creating a Pattern.Any entity model.

Parameters:
  • name (str) – The model name.
  • explicit_list (list[str]) – The Pattern.Any explicit list.
class azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject(*, explicit_list_item: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating an explicit list item.

Parameters:explicit_list_item (str) – The explicit list item.
class azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject(*, regex_pattern: str = None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Model object for updating a regex entity model.

Parameters:
  • regex_pattern (str) – The regex entity pattern.
  • name (str) – The model name.
class azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject(*, name: str = None, explicit_list=None, **kwargs)[source]

Bases: msrest.serialization.Model

Model object for updating a Pattern.Any entity model.

Parameters:
  • name (str) – The model name.
  • explicit_list (list[str]) – The Pattern.Any explicit list.
class azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating an entity role.

Parameters:name (str) – The entity role name.
class azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject(*, explicit_list_item: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Model object for updating an explicit list item.

Parameters:explicit_list_item (str) – The explicit list item.
class azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject(*, pattern: str = None, intent: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for creating a pattern.

Parameters:
  • pattern (str) – The pattern text.
  • intent (str) – The intent’s name which the pattern belongs to.
class azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject(*, id: str = None, pattern: str = None, intent: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Object model for updating a pattern.

Parameters:
  • id (str) – The pattern ID.
  • pattern (str) – The pattern text.
  • intent (str) – The intent’s name which the pattern belongs to.
class azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, regex_pattern: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Regex Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • regex_pattern (str) – The Regex entity pattern.
class azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor(*, id: str, readable_type, name: str = None, type_id: int = None, roles=None, explicit_list=None, **kwargs)[source]

Bases: msrest.serialization.Model

Pattern.Any Entity Extractor.

All required parameters must be populated in order to send to Azure.

Parameters:
  • id (str) – Required. The ID of the Entity Model.
  • name (str) – Name of the Entity Model.
  • type_id (int) – The type ID of the Entity Model.
  • readable_type (str or enum) – Required. Possible values include: ‘Entity Extractor’, ‘Hierarchical Entity Extractor’, ‘Hierarchical Child Entity Extractor’, ‘Composite Entity Extractor’, ‘Closed List Entity Extractor’, ‘Prebuilt Entity Extractor’, ‘Intent Classifier’, ‘Pattern.Any Entity Extractor’, ‘Regex Entity Extractor’
  • roles (list[EntityRole]) –
  • explicit_list (list[ExplicitListItem]) –
class azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo(*, id: str = None, pattern: str = None, intent: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Pattern rule.

Parameters:
  • id (str) – The pattern ID.
  • pattern (str) – The pattern text.
  • intent (str) – The intent’s name where the pattern belongs to.
class azure.cognitiveservices.language.luis.authoring.models.LabelTextObject(*, id: int = None, text: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

An object containing the example’s text.

Parameters:
  • id (int) – The ID of the Label.
  • text (str) – The text of the label.
class azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

HierarchicalChildModelUpdateObject.

Parameters:name (str) –
class azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelCreateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

HierarchicalChildModelCreateObject.

Parameters:name (str) –
class azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

CompositeChildModelCreateObject.

Parameters:name (str) –
class azure.cognitiveservices.language.luis.authoring.models.TrainingStatus[source]

Bases: str, enum.Enum

An enumeration.

in_progress = 'InProgress'
needs_training = 'NeedsTraining'
trained = 'Trained'
class azure.cognitiveservices.language.luis.authoring.models.OperationStatusType[source]

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'
success = 'Success'