CustomEntityAlias Klas
Een complex object dat kan worden gebruikt voor het opgeven van alternatieve spelling of synoniemen voor de naam van de hoofdentiteit.
Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.
- Overname
-
azure.search.documents.indexes._generated._serialization.ModelCustomEntityAlias
Constructor
CustomEntityAlias(*, text: str, case_sensitive: bool | None = None, accent_sensitive: bool | None = None, fuzzy_edit_distance: int | None = None, **kwargs: Any)
Keyword-Only Parameters
Name | Description |
---|---|
text
|
De tekst van de alias. Vereist. |
case_sensitive
|
Bepaal of de alias hoofdlettergevoelig is. |
accent_sensitive
|
Bepaal of de alias accentgevoelig is. |
fuzzy_edit_distance
|
Bepaal de fuzzy bewerkingsafstand van de alias. |
Variabelen
Name | Description |
---|---|
text
|
De tekst van de alias. Vereist. |
case_sensitive
|
Bepaal of de alias hoofdlettergevoelig is. |
accent_sensitive
|
Bepaal of de alias accentgevoelig is. |
fuzzy_edit_distance
|
Bepaal de fuzzy bewerkingsafstand van de alias. |
Methoden
as_dict |
Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan eventueel een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de RestAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object. De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiƫrarchische resultaatdicteerfunctie. Bekijk de drie voorbeelden in dit bestand:
Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven. |
deserialize |
Parseert een str met behulp van de RestAPI-syntaxis en retourneer een model. |
enable_additional_properties_sending | |
from_dict |
Een dicteren met behulp van de opgegeven sleutelextractor retourneert een model. Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Retourneer de JSON die vanuit dit model naar de server wordt verzonden. Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False). Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven. |
as_dict
Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump.
Geavanceerd gebruik kan eventueel een callback gebruiken als parameter:
Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de RestAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.
De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiƫrarchische resultaatdicteerfunctie.
Bekijk de drie voorbeelden in dit bestand:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.
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]
Parameters
Name | Description |
---|---|
key_transformer
|
<xref:function>
Een sleuteltransformatorfunctie. |
keep_readonly
|
standaardwaarde: True
|
Retouren
Type | Description |
---|---|
Een dict JSON-compatibel object |
deserialize
Parseert een str met behulp van de RestAPI-syntaxis en retourneer een model.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Parameters
Name | Description |
---|---|
data
Vereist
|
Een str met behulp van restAPI-structuur. JSON standaard. |
content_type
|
JSON stelt standaard toepassing/xml in als XML. standaardwaarde: None
|
Retouren
Type | Description |
---|---|
Een exemplaar van dit model |
Uitzonderingen
Type | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Een dicteren met behulp van de opgegeven sleutelextractor retourneert een model.
Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en 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
Parameters
Name | Description |
---|---|
data
Vereist
|
Een dicteerfunctie met restAPI-structuur |
content_type
|
JSON stelt standaard toepassing/xml in als XML. standaardwaarde: None
|
key_extractors
|
standaardwaarde: None
|
Retouren
Type | Description |
---|---|
Een exemplaar van dit model |
Uitzonderingen
Type | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Retourneer de JSON die vanuit dit model naar de server wordt verzonden.
Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).
Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parameters
Name | Description |
---|---|
keep_readonly
|
Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False
|
Retouren
Type | Description |
---|---|
Een dict JSON-compatibel object |
Azure SDK for Python