Share via


SuggestedTagAndRegionQueryToken Classe

Contiene proprietà per cui è necessario recuperare i tag suggeriti. Per la prima chiamata, Sessione e continuazione impostata su Null. Quindi, nelle chiamate successive, usa la sessione/continuazione del risultato suggestedTagAndRegionQuery precedente per recuperare risultati aggiuntivi.

Ereditarietà
SuggestedTagAndRegionQueryToken

Costruttore

SuggestedTagAndRegionQueryToken(*, tag_ids=None, threshold: float = None, session: str = None, continuation: str = None, max_count: int = None, sort_by=None, **kwargs)

Parametri

tag_ids
list[str]
Necessario

TagId esistenti nel progetto per filtrare i tag suggeriti.

threshold
float
Necessario

Soglia di confidenza per filtrare i tag suggeriti.

session
str
Necessario

SessionId per la query del database. Inizialmente impostato su Null, ma successivamente usato per impaginare.

continuation
str
Necessario

ID di continuazione per la paginazione del database. Inizialmente Null, ma successivamente usato per impaginare.

max_count
int
Necessario

Numero massimo di risultati da restituire nella risposta.

sort_by
str oppure SortBy
Necessario

Orderby. Meccanismo di ordinamento per i risultati. I valori possibili includono: 'IncertezzaAscending', 'Incertezza Decrescente'

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

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

validate

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

validate()

Restituisce

Elenco di errori di convalida

Tipo restituito