SearchIndexer Classe

Rappresenta un indicizzatore.

Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.

Ereditarietà

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

SearchIndexer

Costruttore

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)

Parametri solo parole chiave

Nome	Descrizione
name	str Nome dell'indicizzatore. Obbligatorio.
description	str Descrizione dell'indicizzatore.
data_source_name	str Nome dell'origine dati da cui questo indicizzatore legge i dati. Obbligatorio.
skillset_name	str Nome del set di competenze in esecuzione con questo indicizzatore.
target_index_name	str Nome dell'indice in cui questo indicizzatore scrive i dati. Obbligatorio.
schedule	<xref:search_service_client.models.IndexingSchedule> Pianificazione per questo indicizzatore.
parameters	<xref:search_service_client.models.IndexingParameters> Parametri per l'esecuzione dell'indicizzatore.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Definisce i mapping tra i campi nell'origine dati e i campi di destinazione corrispondenti nell'indice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] I mapping dei campi di output vengono applicati dopo l'arricchimento e immediatamente prima dell'indicizzazione.
is_disabled	bool Valore che indica se l'indicizzatore è disabilitato. L'impostazione predefinita è false.
e_tag	str ETag dell'indicizzatore.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia inattivo per la definizione dell'indicizzatore (nonché lo stato di esecuzione dell'indicizzatore) quando si vuole garantire che nessuno, non nemmeno Microsoft, possa decrittografarli. Dopo aver crittografato la definizione dell'indicizzatore, rimarrà sempre crittografato. Il servizio di ricerca ignora i tentativi di impostare questa proprietà su Null. È possibile modificare questa proprietà in base alle esigenze se si vuole ruotare la chiave di crittografia; La definizione dell'indicizzatore (e lo stato di esecuzione dell'indicizzatore) non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati o dopo il 1° gennaio 2019.

Variabili

Nome	Descrizione
name	str Nome dell'indicizzatore. Obbligatorio.
description	str Descrizione dell'indicizzatore.
data_source_name	str Nome dell'origine dati da cui questo indicizzatore legge i dati. Obbligatorio.
skillset_name	str Nome del set di competenze in esecuzione con questo indicizzatore.
target_index_name	str Nome dell'indice in cui questo indicizzatore scrive i dati. Obbligatorio.
schedule	<xref:search_service_client.models.IndexingSchedule> Pianificazione per questo indicizzatore.
parameters	<xref:search_service_client.models.IndexingParameters> Parametri per l'esecuzione dell'indicizzatore.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Definisce i mapping tra i campi nell'origine dati e i campi di destinazione corrispondenti nell'indice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] I mapping dei campi di output vengono applicati dopo l'arricchimento e immediatamente prima dell'indicizzazione.
is_disabled	bool Valore che indica se l'indicizzatore è disabilitato. L'impostazione predefinita è false.
e_tag	str ETag dell'indicizzatore.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia inattivo per la definizione dell'indicizzatore (nonché lo stato di esecuzione dell'indicizzatore) quando si vuole garantire che nessuno, non nemmeno Microsoft, possa decrittografarli. Dopo aver crittografato la definizione dell'indicizzatore, rimarrà sempre crittografato. Il servizio di ricerca ignora i tentativi di impostare questa proprietà su Null. È possibile modificare questa proprietà in base alle esigenze se si vuole ruotare la chiave di crittografia; La definizione dell'indicizzatore (e lo stato di esecuzione dell'indicizzatore) non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati o dopo il 1° gennaio 2019.

Metodi

as_dict	Restituisce un dict che può essere serializzato usando json.dump. L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro: La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto. La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico. Vedere i tre esempi in questo file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize	Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict	Analizzare un dict usando un estrattore chiave specificato restituisce un modello. Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Restituire il codice JSON che verrà inviato al server da questo modello. Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i 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]

Parametri

Nome	Descrizione
key_transformer	<xref:function> Funzione di trasformatore chiave.
keep_readonly	valore predefinito: True

Restituisce

Tipo	Descrizione
dict	Oggetto compatibile con JSON dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

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

Parametri

Nome	Descrizione
data Necessario	str Str usando la struttura RestAPI. JSON per impostazione predefinita.
content_type	str JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None

Restituisce

Tipo	Descrizione
	Istanza di questo modello

Eccezioni

Tipo	Descrizione
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parametri

Nome	Descrizione
data Necessario	dict Dict using RestAPI structure
content_type	str JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
key_extractors	valore predefinito: None

Restituisce

Tipo	Descrizione
	Istanza di questo modello

Eccezioni

Tipo	Descrizione
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

Nome	Descrizione
keep_readonly	bool Se si vuole serializzare gli attributi readonly valore predefinito: False

Restituisce

Tipo	Descrizione
dict	Oggetto compatibile con JSON dict