TokenFilter Classe
Tipo di base per i filtri token.
È probabile che si voglia usare le sottoclassi e non direttamente questa classe. Le sottoclassi note sono: AsciiFoldingTokenFilter, CjkBigramTokenFilter, CommonGramTokenFilter, DictionaryDecompounderTokenFilter, EdgeNGramTokenFilter, EdgeNGramTokenFilterV2, ElisionTokenFilter, KeepTokenFilter, KeywordMarkerTokenFilter, LengthTokenFilter, LimitTokenFilter, NGramTokenFilter, NGramTokenFilterV2, PatternCaptureTokenFilter, PatternReplaceTokenFilter, PhoneticTokenFilter, ShingleTokenFilter, SnowballTokenFilter, StemmerOverrideTokenFilter, StemmerTokenFilter, StopwordsTokenFilter, SynonymTokenFilter, TruncateTokenFilter, UniqueTokenFilter, WordDelimiterTokenFilter
Tutti i parametri obbligatori devono essere popolati per l'invio ad Azure.
- Ereditarietà
-
azure.search.documents.indexes._generated._serialization.ModelTokenFilter
TokenFilter(*, name: str, **kwargs: Any)
Nome | Descrizione |
---|---|
name
|
Nome del filtro del token. Può contenere solo lettere, numeri, spazi, trattini o caratteri di sottolineatura, deve iniziare e terminare con caratteri alfanumerici e non può contenere più di 128 caratteri. Obbligatorio. |
Nome | Descrizione |
---|---|
odata_type
|
Frammento URI che specifica il tipo di filtro del token. Obbligatorio. |
name
|
Nome del filtro del token. Può contenere solo lettere, numeri, spazi, trattini o caratteri di sottolineatura, deve iniziare e terminare con caratteri alfanumerici e non può contenere più di 128 caratteri. Obbligatorio. |
as_dict |
Restituisce un dict che può essere serializzato 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:
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 |
Restituisce il codice JSON che verrebbe inviato al server 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. |
Restituisce un dict che può essere serializzato 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: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]
Parametri
Nome | Descrizione |
---|---|
key_transformer
|
<xref:function>
Funzione di trasformatore di tasti. |
keep_readonly
|
valore predefinito: True
|
Restituisce
Tipo | Descrizione |
---|---|
Oggetto compatibile con JSON dict |
Analizzare uno str usando la sintassi RestAPI e restituire un modello.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Parametri
Nome | Descrizione |
---|---|
data
Necessario
|
Str che usa la struttura RestAPI. JSON per impostazione predefinita. |
content_type
|
JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Istanza di questo modello |
Eccezioni
Tipo | Descrizione |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending() -> None
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: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType
Parametri
Nome | Descrizione |
---|---|
data
Necessario
|
Oggetto dict using RestAPI structure (Struttura RESTAPI) |
content_type
|
JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
|
key_extractors
|
valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Istanza di questo modello |
Eccezioni
Tipo | Descrizione |
---|---|
DeserializationError if something went wrong
|
is_xml_model() -> bool
Restituisce il codice JSON che verrebbe inviato al server 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: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parametri
Nome | Descrizione |
---|---|
keep_readonly
|
Se si desidera serializzare gli attributi readonly valore predefinito: False
|
Restituisce
Tipo | Descrizione |
---|---|
Oggetto compatibile con JSON dict |
Feedback su Azure SDK for Python
Azure SDK for Python è un progetto di open source. Selezionare un collegamento per fornire feedback: