LuisAppV2 Class

  • Reference

Exported Model - An exported LUIS Application.

Inheritance
msrest.serialization.Model
LuisAppV2

Constructor

LuisAppV2(*, additional_properties=None, luis_schema_version: str = 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)

Parameters

Name Description
additional_properties
Required
dict[str, object]

Unmatched properties from the message are deserialized this collection
luis_schema_version
Required
str

Luis schema deserialization version.
name
Required
str

The name of the application.
version_id
Required
str

The version ID of the application that was exported.
desc
Required
str

The description of the application.
culture
Required
str

The culture of the application. E.g.: en-us.
intents
Required
list[HierarchicalModelV2]

List of intents.
entities
Required
list[HierarchicalModelV2]

List of entities.
closed_lists
Required
list[ClosedList]

List of list entities.
composites
Required
list[HierarchicalModelV2]

List of composite entities.
pattern_any_entities
Required
list[PatternAny]

List of Pattern.Any entities.
regex_entities
Required
list[RegexEntity]

List of regular expression entities.
prebuilt_entities
Required
list[PrebuiltEntity]

List of prebuilt entities.
regex_features
Required
list[JSONRegexFeature]

List of pattern features.
model_features
Required
list[JSONModelFeature]

List of model features.
patterns
Required
list[PatternRule]

List of patterns.
utterances
Required
list[JSONUtterance]

List of example utterances.

Keyword-Only Parameters

Name Description
additional_properties
Required
luis_schema_version
Required
name
Required
version_id
Required
desc
Required
culture
Required
intents
Required
entities
Required
closed_lists
Required
composites
Required
pattern_any_entities
Required
regex_entities
Required
prebuilt_entities
Required
regex_features
Required
model_features
Required
patterns
Required
utterances
Required

Methods

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize

Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.
validate

Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name Description
key_transformer
<xref:function>

A key transformer function.
keep_readonly
Default value: True

Returns

Type Description
dict

A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name Description
data
Required
str

A str using RestAPI structure. JSON by default.
content_type
str

JSON by default, set application/xml if XML.

Default value: None

Returns

Type Description

An instance of this model

Exceptions

Type Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name Description
data
Required
dict

A dict using RestAPI structure
content_type
str

JSON by default, set application/xml if XML.

Default value: None
key_extractors
Default value: None

Returns

Type Description

An instance of this model

Exceptions

Type Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name Description
keep_readonly
bool

If you want to serialize the readonly attributes

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type Description
list

A list of validation error