CustomEntity Klas

Een object dat informatie bevat over de gevonden overeenkomsten en gerelateerde metagegevens.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname

azure.search.documents.indexes._generated._serialization.Model

CustomEntity

Constructor

CustomEntity(*, name: str, description: str | None = None, type: str | None = None, subtype: str | None = None, id: str | None = None, case_sensitive: bool | None = None, accent_sensitive: bool | None = None, fuzzy_edit_distance: int | None = None, default_case_sensitive: bool | None = None, default_accent_sensitive: bool | None = None, default_fuzzy_edit_distance: int | None = None, aliases: List[_models.CustomEntityAlias] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str De entiteitsdescriptor op het hoogste niveau. Overeenkomsten in de uitvoer van de vaardigheid worden gegroepeerd op deze naam en moeten de 'genormaliseerde' vorm van de gevonden tekst vertegenwoordigen. Vereist.
description	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
type	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
subtype	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
id	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
case_sensitive	bool De standaardinstelling is false. Booleaanse waarde die aangeeft of vergelijkingen met de entiteitsnaam gevoelig moeten zijn voor hoofdletters. Voorbeeld van niet-hoofdlettergevoelige overeenkomsten van 'Microsoft' kunnen zijn: microsoft, microSoft, MICROSOFT.
accent_sensitive	bool De standaardinstelling is false. Booleaanse waarde die aangeeft of vergelijkingen met de entiteitsnaam gevoelig moeten zijn voor accenten.
fuzzy_edit_distance	int De standaardwaarde is 0. Maximumwaarde van 5. Geeft het acceptabele aantal afwijkende tekens aan dat nog steeds overeenkomt met de naam van de entiteit. De kleinst mogelijke fuzziness voor een bepaalde overeenkomst wordt geretourneerd. Als de bewerkingsafstand bijvoorbeeld is ingesteld op 3, komt 'Windows10' nog steeds overeen met 'Windows', 'Windows10' en 'Windows 7'. Wanneer de hoofdlettergevoeligheid is ingesteld op onwaar, tellen verschillen in hoofdletters NIET mee voor de fuzziness-tolerantie, maar anders wel.
default_case_sensitive	bool Hiermee wijzigt u de standaardwaarde voor hoofdlettergevoeligheid voor deze entiteit. Het wordt gebruikt om de standaardwaarde van alle aliassen hoofdlettergevoelige waarden te wijzigen.
default_accent_sensitive	bool Hiermee wijzigt u de standaardwaarde voor accentgevoeligheid voor deze entiteit. Dit wordt gebruikt om de standaardwaarde van alle aliassen accentSensitive waarden te wijzigen.
default_fuzzy_edit_distance	int Hiermee wijzigt u de standaardwaarde voor fuzzy bewerkingsafstand voor deze entiteit. Het kan worden gebruikt om de standaardwaarde van alle aliassen fuzzyEditDistance-waarden te wijzigen.
aliases	list[<xref:search_service_client.models.CustomEntityAlias>] Een matrix met complexe objecten die kunnen worden gebruikt om alternatieve spellingen of synoniemen voor de naam van de hoofdentiteit op te geven.

Variabelen

Name	Description
name	str De entiteitsdescriptor op het hoogste niveau. Overeenkomsten in de uitvoer van de vaardigheid worden gegroepeerd op deze naam en moeten de 'genormaliseerde' vorm van de gevonden tekst vertegenwoordigen. Vereist.
description	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
type	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
subtype	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
id	str Dit veld kan worden gebruikt als een passthrough voor aangepaste metagegevens over de overeenkomende tekst(en). De waarde van dit veld wordt weergegeven bij elke overeenkomst van de entiteit in de uitvoer van de vaardigheid.
case_sensitive	bool De standaardinstelling is false. Booleaanse waarde die aangeeft of vergelijkingen met de entiteitsnaam gevoelig moeten zijn voor hoofdletters. Voorbeeld van niet-hoofdlettergevoelige overeenkomsten van 'Microsoft' kunnen zijn: microsoft, microSoft, MICROSOFT.
accent_sensitive	bool De standaardinstelling is false. Booleaanse waarde die aangeeft of vergelijkingen met de entiteitsnaam gevoelig moeten zijn voor accenten.
fuzzy_edit_distance	int De standaardwaarde is 0. Maximumwaarde van 5. Geeft het acceptabele aantal afwijkende tekens aan dat nog steeds overeenkomt met de naam van de entiteit. De kleinst mogelijke fuzziness voor een bepaalde overeenkomst wordt geretourneerd. Als de bewerkingsafstand bijvoorbeeld is ingesteld op 3, komt 'Windows10' nog steeds overeen met 'Windows', 'Windows10' en 'Windows 7'. Wanneer de hoofdlettergevoeligheid is ingesteld op onwaar, tellen verschillen in hoofdletters NIET mee voor de fuzziness-tolerantie, maar anders wel.
default_case_sensitive	bool Hiermee wijzigt u de standaardwaarde voor hoofdlettergevoeligheid voor deze entiteit. Het wordt gebruikt om de standaardwaarde van alle aliassen hoofdlettergevoelige waarden te wijzigen.
default_accent_sensitive	bool Hiermee wijzigt u de standaardwaarde voor accentgevoeligheid voor deze entiteit. Dit wordt gebruikt om de standaardwaarde van alle aliassen accentSensitive waarden te wijzigen.
default_fuzzy_edit_distance	int Hiermee wijzigt u de standaardwaarde voor fuzzy bewerkingsafstand voor deze entiteit. Het kan worden gebruikt om de standaardwaarde van alle aliassen fuzzyEditDistance-waarden te wijzigen.
aliases	list[<xref:search_service_client.models.CustomEntityAlias>] Een matrix met complexe objecten die kunnen worden gebruikt om alternatieve spellingen of synoniemen voor de naam van de hoofdentiteit op te geven.

Methoden

as_dict	Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict 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ërarchisch resultaatdicteren. 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.
deserialize	Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.
enable_additional_properties_sending
from_dict	Een dict parseren 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	Retourneert 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 desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict 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ërarchisch resultaatdicteren.

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
dict	Een dict JSON-compatibel object

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Vereist	str Een str met behulp van restAPI-structuur. JSON standaard.
content_type	str JSON standaard: stel application/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 dict parseren 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	dict Een dict met behulp van de RestAPI-structuur
content_type	str JSON standaard: stel application/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

Retourneert 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	bool Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False

Retouren

Type	Description
dict	Een dict JSON-compatibel object