SearchIndexer Klasse

Stellt einen Indexer dar.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.

Vererbung

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)

Keyword-Only Parameter

Name	Beschreibung
name	str Der Name des Indexers. Erforderlich.
description	str Die Beschreibung des Indexers.
data_source_name	str Der Name der Datenquelle, aus der dieser Indexer Daten liest. Erforderlich.
skillset_name	str Der Name des Skillsets, das mit diesem Indexer ausgeführt wird.
target_index_name	str Der Name des Indexes, in den dieser Indexer Daten schreibt. Erforderlich.
schedule	<xref:search_service_client.models.IndexingSchedule> Der Zeitplan für diesen Indexer.
parameters	<xref:search_service_client.models.IndexingParameters> Parameter für die Indexerausführung.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Definiert Zuordnungen zwischen Feldern in der Datenquelle und den entsprechenden Zielfeldern im Index.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Ausgabefeldzuordnungen werden nach der Anreicherung und unmittelbar vor der Indizierung angewendet.
is_disabled	bool Ein Wert, der angibt, ob der Indexer deaktiviert ist. Der Standardwert ist "false".
e_tag	str Das ETag des Indexers.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Indexerdefinition (sowie für die Indexerausführung status) bereitzustellen, wenn Sie sicher sein möchten, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Nachdem Sie Ihre Indexerdefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf NULL festzulegen. Sie können diese Eigenschaft bei Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Indexerdefinition (und die Indexerausführung status) ist nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

Variablen

Name	Beschreibung
name	str Der Name des Indexers. Erforderlich.
description	str Die Beschreibung des Indexers.
data_source_name	str Der Name der Datenquelle, aus der dieser Indexer Daten liest. Erforderlich.
skillset_name	str Der Name des Skillsets, das mit diesem Indexer ausgeführt wird.
target_index_name	str Der Name des Indexes, in den dieser Indexer Daten schreibt. Erforderlich.
schedule	<xref:search_service_client.models.IndexingSchedule> Der Zeitplan für diesen Indexer.
parameters	<xref:search_service_client.models.IndexingParameters> Parameter für die Indexerausführung.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Definiert Zuordnungen zwischen Feldern in der Datenquelle und den entsprechenden Zielfeldern im Index.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Ausgabefeldzuordnungen werden nach der Anreicherung und unmittelbar vor der Indizierung angewendet.
is_disabled	bool Ein Wert, der angibt, ob der Indexer deaktiviert ist. Der Standardwert ist "false".
e_tag	str Das ETag des Indexers.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Indexerdefinition (sowie für die Indexerausführung status) bereitzustellen, wenn Sie sicher sein möchten, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Nachdem Sie Ihre Indexerdefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf NULL festzulegen. Sie können diese Eigenschaft bei Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Indexerdefinition (und die Indexerausführung status) ist nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

Methoden

as_dict	Gibt ein Diktat zurück, das mit json.dump serialisiert werden kann. Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden: Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Diktat von Metadaten. Enthält derzeit "type" mit dem Msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt. Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchische Ergebnisdikt betrachtet. Sehen Sie sich die drei Beispiele in dieser Datei an: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.
deserialize	Analysieren Sie eine str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.
enable_additional_properties_sending
from_dict	Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück. Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet wird. Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False). Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

as_dict

Gibt ein Diktat zurück, das mit json.dump serialisiert werden kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Diktat von Metadaten. Enthält derzeit "type" mit dem Msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchische Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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]

Parameter

Name	Beschreibung
key_transformer	<xref:function> Eine Schlüsseltransformatorfunktion.
keep_readonly	Standardwert: True

Gibt zurück

Typ	Beschreibung
dict	Ein JSON-kompatibles Diktatobjekt

deserialize

Analysieren Sie eine str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

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

Parameter

Name	Beschreibung
data Erforderlich	str Eine str-Struktur, die die RestAPI-Struktur verwendet. Standardmäßig JSON.
content_type	str Json standardmäßig, legen Sie application/xml fest, wenn XML. Standardwert: None

Gibt zurück

Typ	Beschreibung
	Eine instance dieses Modells

Ausnahmen

Typ	Beschreibung
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analysieren eines Diktats mit dem angegebenen Schlüsselextraktor gibt ein Modell zurück.

Berücksichtigen Sie standardmäßig Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und 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

Parameter

Name	Beschreibung
data Erforderlich	dict Ein Diktat mithilfe der RestAPI-Struktur
content_type	str Json standardmäßig, legen Sie application/xml fest, wenn XML. Standardwert: None
key_extractors	Standardwert: None

Gibt zurück

Typ	Beschreibung
	Eine instance dieses Modells

Ausnahmen

Typ	Beschreibung
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Gibt den JSON-Code zurück, der von diesem Modell an den Server gesendet wird.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie eine XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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

Parameter

Name	Beschreibung
keep_readonly	bool Wenn Sie die schreibgeschützten Attribute serialisieren möchten Standardwert: False

Gibt zurück

Typ	Beschreibung
dict	Ein JSON-kompatibles Diktatobjekt