Partager via

VersionInfo Class

  • Reference

Object model of an application version.

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

Inheritance
msrest.serialization.Model
VersionInfo

Constructor

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)

Parameters

Name Description
version
Required
str

Required. The version ID. E.g.: "0.1"
created_date_time
Required
datetime

The version's creation timestamp.
last_modified_date_time
Required
datetime

Timestamp of the last update.
last_trained_date_time
Required
datetime

Timestamp of the last time the model was trained.
last_published_date_time
Required
datetime

Timestamp when was last published.
endpoint_url
Required
str

The Runtime endpoint URL for this model version.
assigned_endpoint_key
Required
dict[str, str]

The endpoint key.
external_api_keys
Required
object

External keys.
intents_count
Required
int

Number of intents in this model.
entities_count
Required
int

Number of entities in this model.
endpoint_hits_count
Required
int

Number of calls made to this endpoint.
training_status
Required
str or TrainingStatus

Required. The current training status. Possible values include: 'NeedsTraining', 'InProgress', 'Trained'

Keyword-Only Parameters

Name Description
version
Required
training_status
Required
created_date_time
Required
last_modified_date_time
Required
last_trained_date_time
Required
last_published_date_time
Required
endpoint_url
Required
assigned_endpoint_key
Required
external_api_keys
Required
intents_count
Required
entities_count
Required
endpoint_hits_count
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