SearchIndexer Klas

Vertegenwoordigt een indexeerfunctie.

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

Overname

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

SearchIndexer

Constructor

SearchIndexer(*, name: str, data_source_name: str, target_index_name: str, description: str | None = None, skillset_name: str | None = None, schedule: _models.IndexingSchedule | None = None, parameters: _models.IndexingParameters | None = None, field_mappings: List[_models.FieldMapping] | None = None, output_field_mappings: List[_models.FieldMapping] | None = None, is_disabled: bool = False, e_tag: str | None = None, encryption_key: _models.SearchResourceEncryptionKey | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str De naam van de indexeerfunctie. Vereist.
description	str De beschrijving van de indexeerfunctie.
data_source_name	str De naam van de gegevensbron waaruit deze indexeerfunctie gegevens leest. Vereist.
skillset_name	str De naam van de vaardighedenset die wordt uitgevoerd met deze indexeerfunctie.
target_index_name	str De naam van de index waarnaar deze indexeerfunctie gegevens schrijft. Vereist.
schedule	<xref:search_service_client.models.IndexingSchedule> Het schema voor deze indexeerfunctie.
parameters	<xref:search_service_client.models.IndexingParameters> Parameters voor het uitvoeren van de indexeerfunctie.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Hiermee definieert u toewijzingen tussen velden in de gegevensbron en de bijbehorende doelvelden in de index.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Toewijzingen van uitvoervelden worden toegepast na verrijking en direct vóór indexering.
is_disabled	bool Een waarde die aangeeft of de indexeerfunctie is uitgeschakeld. De standaardinstelling is onwaar.
e_tag	str De ETag van de indexeerfunctie.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor de definitie van uw indexeerfunctie (evenals de uitvoeringsstatus van de indexeerfunctie) als u volledige zekerheid wilt dat niemand, zelfs Microsoft, ze niet kan ontsleutelen. Nadat u de definitie van uw indexeerfunctie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; De definitie van de indexeerfunctie (en de uitvoeringsstatus van de indexeerfunctie) blijft ongewijzigd. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

Variabelen

Name	Description
name	str De naam van de indexeerfunctie. Vereist.
description	str De beschrijving van de indexeerfunctie.
data_source_name	str De naam van de gegevensbron waaruit deze indexeerfunctie gegevens leest. Vereist.
skillset_name	str De naam van de vaardighedenset die wordt uitgevoerd met deze indexeerfunctie.
target_index_name	str De naam van de index waarnaar deze indexeerfunctie gegevens schrijft. Vereist.
schedule	<xref:search_service_client.models.IndexingSchedule> Het schema voor deze indexeerfunctie.
parameters	<xref:search_service_client.models.IndexingParameters> Parameters voor het uitvoeren van de indexeerfunctie.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Hiermee definieert u toewijzingen tussen velden in de gegevensbron en de bijbehorende doelvelden in de index.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Toewijzingen van uitvoervelden worden toegepast na verrijking en direct vóór indexering.
is_disabled	bool Een waarde die aangeeft of de indexeerfunctie is uitgeschakeld. De standaardinstelling is onwaar.
e_tag	str De ETag van de indexeerfunctie.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor de definitie van uw indexeerfunctie (evenals de uitvoeringsstatus van de indexeerfunctie) als u volledige zekerheid wilt dat niemand, zelfs Microsoft, ze niet kan ontsleutelen. Nadat u de definitie van uw indexeerfunctie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; De definitie van de indexeerfunctie (en de uitvoeringsstatus van de indexeerfunctie) blijft ongewijzigd. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

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: 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 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
dict	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	str Een str met behulp van restAPI-structuur. JSON standaard.
content_type	str 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	dict Een dicteerfunctie met restAPI-structuur
content_type	str 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	bool Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False

Retouren

Type	Description
dict	Een dict JSON-compatibel object