Sdílet prostřednictvím

SearchIndexer Třída

  • Reference

Představuje indexer.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.

Dědičnost
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)

Výhradně parametry klíčových slov

Name Description
name
str

Název indexeru. Povinná hodnota.
description
str

Popis indexeru.
data_source_name
str

Název zdroje dat, ze kterého tento indexer čte data. Povinná hodnota.
skillset_name
str

Název sady dovedností spouštěné pomocí tohoto indexeru.
target_index_name
str

Název indexu, do kterého tento indexer zapisuje data. Povinná hodnota.
schedule
<xref:search_service_client.models.IndexingSchedule>

Plán pro tento indexer.
parameters
<xref:search_service_client.models.IndexingParameters>

Parametry pro provádění indexeru.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Definuje mapování mezi poli ve zdroji dat a odpovídajícími cílovými poli v indexu.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Mapování výstupních polí se použijí po rozšíření a bezprostředně před indexováním.
is_disabled
bool

Hodnota označující, zda je indexer zakázán. Výchozí hodnota je false.
e_tag
str

Značka ETag indexeru.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování neaktivních uložených uložených dat pro definici indexeru (stejně jako stav spuštění indexeru), pokud chcete mít plnou jistotu, že je nikdo, dokonce ani Microsoft, nemůže dešifrovat. Jakmile zašifrujete definici indexeru, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Definice indexeru (a stav spuštění indexeru) nebudou ovlivněny. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

Proměnné

Name Description
name
str

Název indexeru. Povinná hodnota.
description
str

Popis indexeru.
data_source_name
str

Název zdroje dat, ze kterého tento indexer čte data. Povinná hodnota.
skillset_name
str

Název sady dovedností spouštěné pomocí tohoto indexeru.
target_index_name
str

Název indexu, do kterého tento indexer zapisuje data. Povinná hodnota.
schedule
<xref:search_service_client.models.IndexingSchedule>

Plán pro tento indexer.
parameters
<xref:search_service_client.models.IndexingParameters>

Parametry pro provádění indexeru.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Definuje mapování mezi poli ve zdroji dat a odpovídajícími cílovými poli v indexu.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Mapování výstupních polí se použijí po rozšíření a bezprostředně před indexováním.
is_disabled
bool

Hodnota označující, zda je indexer zakázán. Výchozí hodnota je false.
e_tag
str

Značka ETag indexeru.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování neaktivních uložených uložených dat pro definici indexeru (stejně jako stav spuštění indexeru), pokud chcete mít plnou jistotu, že je nikdo, dokonce ani Microsoft, nemůže dešifrovat. Jakmile zašifrujete definici indexeru, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Definice indexeru (a stav spuštění indexeru) nebudou ovlivněny. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

Metody

as_dict

Vrátí dikt, který lze serializovat pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.
enable_additional_properties_sending
from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Vrátí kód JSON, který se odešle na server z tohoto modelu.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict

Vrátí dikt, který lze serializovat pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat 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]

Parametry

Name Description
key_transformer
<xref:function>

Funkce klíčového transformátoru.
keep_readonly
výchozí hodnota: True

Návraty

Typ Description
dict

Objekt kompatibilní s diktem JSON

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

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

Parametry

Name Description
data
Vyžadováno
str

Str používající strukturu RestAPI. Ve výchozím nastavení JSON.
content_type
str

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

výchozí hodnota: None

Návraty

Typ Description

Instance tohoto modelu

Výjimky

Typ Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a 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

Parametry

Name Description
data
Vyžadováno
dict

Diktování pomocí struktury RestAPI
content_type
str

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

výchozí hodnota: None
key_extractors
výchozí hodnota: None

Návraty

Typ Description

Instance tohoto modelu

Výjimky

Typ Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Vrátí kód JSON, který se odešle na server z tohoto modelu.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

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

Parametry

Name Description
keep_readonly
bool

Pokud chcete serializovat atributy readonly

výchozí hodnota: False

Návraty

Typ Description
dict

Objekt kompatibilní s diktem JSON