SearchIndexer Osztály

Indexelőt jelöl.

Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.

Öröklődés

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

SearchIndexer

Konstruktor

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)

Csak kulcsszavas paraméterek

Name	Description
name	str Az indexelő neve. Kötelező.
description	str Az indexelő leírása.
data_source_name	str Annak az adatforrásnak a neve, amelyből az indexelő adatokat olvas be. Kötelező.
skillset_name	str Az indexelővel végrehajtott képességcsoport neve.
target_index_name	str Annak az indexnek a neve, amelyre az indexelő adatokat ír. Kötelező.
schedule	<xref:search_service_client.models.IndexingSchedule> Az indexelő ütemezése.
parameters	<xref:search_service_client.models.IndexingParameters> Az indexelő végrehajtásának paraméterei.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Az adatforrás mezői és az index megfelelő célmezői közötti leképezéseket határozza meg.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] A kimeneti mezőleképezések a bővítés után és közvetlenül az indexelés előtt lesznek alkalmazva.
is_disabled	bool Érték, amely jelzi, hogy az indexelő le van-e tiltva. Az alapértelmezett érték a false (hamis).
e_tag	str Az indexelő ETagje.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Az Azure Key Vault-ben létrehozott titkosítási kulcs leírása. Ez a kulcs további inaktív titkosítási szintet biztosít az indexelő definíciójához (valamint az indexelő végrehajtási állapotához), ha teljes körű biztosítékot szeretne kapni arról, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az indexelő definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékűre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az indexelő definíciója (és az indexelő végrehajtási állapota) nem lesz hatással. Az ügyfél által felügyelt kulcsokkal történő titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.

Változók

Name	Description
name	str Az indexelő neve. Kötelező.
description	str Az indexelő leírása.
data_source_name	str Annak az adatforrásnak a neve, amelyből az indexelő adatokat olvas be. Kötelező.
skillset_name	str Az indexelővel végrehajtott képességcsoport neve.
target_index_name	str Annak az indexnek a neve, amelyre az indexelő adatokat ír. Kötelező.
schedule	<xref:search_service_client.models.IndexingSchedule> Az indexelő ütemezése.
parameters	<xref:search_service_client.models.IndexingParameters> Az indexelő végrehajtásának paraméterei.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Az adatforrás mezői és az index megfelelő célmezői közötti leképezéseket határozza meg.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] A kimeneti mezőleképezések a bővítés után és közvetlenül az indexelés előtt lesznek alkalmazva.
is_disabled	bool Érték, amely jelzi, hogy az indexelő le van-e tiltva. Az alapértelmezett érték a false (hamis).
e_tag	str Az indexelő ETagje.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Az Azure Key Vault-ben létrehozott titkosítási kulcs leírása. Ez a kulcs további inaktív titkosítási szintet biztosít az indexelő definíciójához (valamint az indexelő végrehajtási állapotához), ha teljes körű biztosítékot szeretne kapni arról, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az indexelő definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékűre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az indexelő definíciója (és az indexelő végrehajtási állapota) nem lesz hatással. Az ügyfél által felügyelt kulcsokkal történő titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.

Metódusok

as_dict	A json.dump használatával szerializálható diktálás visszaadása. A speciális használat opcionálisan visszahívást is használhat paraméterként: A kulcs a Pythonban használt attribútumnév. Attr_desc egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. Az érték az objektum aktuális értéke. A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor ez hierarchikus eredménydiktátumnak minősül. Tekintse meg a fájl három példáját: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.
deserialize	Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt.
enable_additional_properties_sending
from_dict	Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza. Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Adja vissza a modellből a kiszolgálónak küldendő JSON-t. Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa. Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.

as_dict

A json.dump használatával szerializálható diktálás visszaadása.

A speciális használat opcionálisan visszahívást is használhat paraméterként:

A kulcs a Pythonban használt attribútumnév. Attr_desc egy metaadat-diktálás. Jelenleg az msrest típust és a RestAPI kódolt kulcsot tartalmazó "típust" tartalmazza. Az érték az objektum aktuális értéke.

A visszaadott sztring a kulcs szerializálására szolgál. Ha a visszatérési típus lista, akkor ez hierarchikus eredménydiktátumnak minősül.

Tekintse meg a fájl három példáját:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.

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]

Paraméterek

Name	Description
key_transformer	<xref:function> Egy kulcsátalakító függvény.
keep_readonly	alapértelmezett érték: True

Válaszok

Típus	Description
dict	Diktátum JSON-kompatibilis objektum

deserialize

Elemezhet egy str értéket a RestAPI szintaxissal, és visszaad egy modellt.

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

Paraméterek

Name	Description
data Kötelező	str RestAPI-struktúrát használó struktúra. JSON alapértelmezés szerint.
content_type	str JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML. alapértelmezett érték: None

Válaszok

Típus	Description
	A modell egy példánya

Kivételek

Típus	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Egy diktálás elemzése adott kulcselszívó használatával egy modellt ad vissza.

Alapértelmezés szerint vegye figyelembe a kulcselszívókat (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor és 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

Paraméterek

Name	Description
data Kötelező	dict Egy restAPI-struktúrát használó diktálás
content_type	str JSON alapértelmezés szerint állítsa be az alkalmazást/xml-t, ha XML. alapértelmezett érték: None
key_extractors	alapértelmezett érték: None

Válaszok

Típus	Description
	A modell egy példánya

Kivételek

Típus	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Adja vissza a modellből a kiszolgálónak küldendő JSON-t.

Ez a as_dict (full_restapi_key_transformer, keep_readonly=False) aliasa.

Ha XML-szerializálást szeretne, a kwargs is_xml=True értéket is átadhatja.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Paraméterek

Name	Description
keep_readonly	bool Ha szerializálni szeretné az olvasható attribútumokat alapértelmezett érték: False

Válaszok

Típus	Description
dict	Diktátum JSON-kompatibilis objektum