ExternalEntity Classe

Definisce un'entità stimata dall'utente che estende un'entità già esistente.

Tutti i parametri obbligatori devono essere popolati per l'invio ad Azure.

Ereditarietà

Model

ExternalEntity

Costruttore

ExternalEntity(*, entity_name: str, start_index: int, entity_length: int, resolution=None, score: float = None, **kwargs)

Parametri

entity_name

str

Necessario

Obbligatorio. Nome dell'entità da estendere.

start_index

int

Necessario

Obbligatorio. Indice dei caratteri iniziale dell'entità stimata.

entity_length

int

Necessario

Obbligatorio. Lunghezza dell'entità stimata.

resolution

object

Necessario

Un utente ha fornito una risoluzione personalizzata da restituire come stima dell'entità.

score

float

Necessario

Un utente ha fornito un punteggio da restituire come punteggio di stima dell'entità.

Metodi

as_dict	Restituire un dict che può essere JSONify usando json.dump. L'utilizzo avanzato può facoltativamente usare un callback come parametro: Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto. La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict. Vedere i tre esempi in questo file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize	Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict	Analizzare un dict usando un estrattore di chiave specificato restituisce un modello. Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Restituire il codice JSON che verrebbe inviato ad Azure da questo modello. Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False). Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
validate	Convalidare questo modello in modo ricorsivo e restituire un elenco di ValidationError.

as_dict

Restituire un dict che può essere JSONify usando json.dump.

L'utilizzo avanzato può facoltativamente usare un callback come parametro:

Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto.

La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict.

Vedere i tre esempi in questo file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

key_transformer

<xref:function>

Funzione di trasformatore di tasti.

keep_readonly

valore predefinito: True

Restituisce

Oggetto compatibile con JSON dict

Tipo restituito

dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

deserialize(data, content_type=None)

Parametri

data

str

Necessario

Str che usa la struttura RestAPI. JSON per impostazione predefinita.

content_type

str

valore predefinito: None

JSON per impostazione predefinita, impostare application/xml se XML.

Restituisce

Istanza di questo modello

Eccezioni

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analizzare un dict usando un estrattore di chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

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

Parametri

data

dict

Necessario

Oggetto dict using RestAPI structure (Struttura RESTAPI)

content_type

str

valore predefinito: None

JSON per impostazione predefinita, impostare application/xml se XML.

key_extractors

valore predefinito: None

Restituisce

Istanza di questo modello

Eccezioni

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Restituire il codice JSON che verrebbe inviato ad Azure da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametri

keep_readonly

bool

valore predefinito: False

Se si desidera serializzare gli attributi readonly

Restituisce

Oggetto compatibile con JSON dict

Tipo restituito

dict

validate

Convalidare questo modello in modo ricorsivo e restituire un elenco di ValidationError.

validate()

Restituisce

Elenco di errori di convalida

Tipo restituito

list