SearchIndexer Klasa

  • Odwołanie

Reprezentuje indeksator.

Aby wysyłać na platformę Azure wszystkie wymagane parametry, należy wypełnić wszystkie wymagane parametry.

Dziedziczenie
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)

Parametry Tylko słowo kluczowe

Nazwa Opis
name
str

Nazwa indeksatora. Wymagane.
description
str

Opis indeksatora.
data_source_name
str

Nazwa źródła danych, z którego ten indeksator odczytuje dane. Wymagane.
skillset_name
str

Nazwa zestawu umiejętności wykonywanego za pomocą tego indeksatora.
target_index_name
str

Nazwa indeksu, do którego ten indeksator zapisuje dane. Wymagane.
schedule
<xref:search_service_client.models.IndexingSchedule>

Harmonogram dla tego indeksatora.
parameters
<xref:search_service_client.models.IndexingParameters>

Parametry wykonywania indeksatora.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Definiuje mapowania między polami w źródle danych i odpowiadającymi im polami docelowymi w indeksie.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Mapowania pól wyjściowych są stosowane po wzbogaceniu i bezpośrednio przed indeksowaniem.
is_disabled
bool

Wartość wskazująca, czy indeksator jest wyłączony. Wartość domyślna to false.
e_tag
str

Element ETag indeksatora.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji indeksatora (a także stanu wykonywania indeksatora), gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może ich odszyfrować. Po zaszyfrowaniu definicji indeksatora będzie ona zawsze szyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Tę właściwość można zmienić zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję indeksatora (i stan wykonywania indeksatora). Szyfrowanie przy użyciu kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po tym, jak 1 stycznia 2019 r.

Zmienne

Nazwa Opis
name
str

Nazwa indeksatora. Wymagane.
description
str

Opis indeksatora.
data_source_name
str

Nazwa źródła danych, z którego ten indeksator odczytuje dane. Wymagane.
skillset_name
str

Nazwa zestawu umiejętności wykonywanego za pomocą tego indeksatora.
target_index_name
str

Nazwa indeksu, do którego ten indeksator zapisuje dane. Wymagane.
schedule
<xref:search_service_client.models.IndexingSchedule>

Harmonogram dla tego indeksatora.
parameters
<xref:search_service_client.models.IndexingParameters>

Parametry wykonywania indeksatora.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Definiuje mapowania między polami w źródle danych i odpowiadającymi im polami docelowymi w indeksie.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Mapowania pól wyjściowych są stosowane po wzbogaceniu i bezpośrednio przed indeksowaniem.
is_disabled
bool

Wartość wskazująca, czy indeksator jest wyłączony. Wartość domyślna to false.
e_tag
str

Element ETag indeksatora.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji indeksatora (a także stanu wykonywania indeksatora), gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może ich odszyfrować. Po zaszyfrowaniu definicji indeksatora będzie ona zawsze szyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Tę właściwość można zmienić zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję indeksatora (i stan wykonywania indeksatora). Szyfrowanie przy użyciu kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po tym, jak 1 stycznia 2019 r.

Metody

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym w interfejsie RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uważane za hierarchiczne dykt wyniku.

Zobacz trzy przykłady w tym pliku:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
enable_additional_properties_sending
from_dict

Przeanalizuj dykt przy użyciu danego wyodrębniającego klucz zwraca model.

Domyślnie należy wziąć pod uwagę wyodrębniacze kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict(full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym w interfejsie RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uważane za hierarchiczne dykt wyniku.

Zobacz trzy przykłady w tym pliku:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać 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

Nazwa Opis
key_transformer
<xref:function>

Funkcja przekształcania klucza.
keep_readonly
wartość domyślna: True

Zwraca

Typ Opis
dict

Obiekt zgodny z JSON w formacie JSON

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

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

Parametry

Nazwa Opis
data
Wymagane
str

Str używający struktury RestAPI. Domyślnie kod JSON.
content_type
str

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

wartość domyślna: None

Zwraca

Typ Opis

Wystąpienie tego modelu

Wyjątki

Typ Opis
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Przeanalizuj dykt przy użyciu danego wyodrębniającego klucz zwraca model.

Domyślnie należy wziąć pod uwagę wyodrębniacze kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i 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

Nazwa Opis
data
Wymagane
dict

Dykt używający struktury RESTAPI
content_type
str

Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML.

wartość domyślna: None
key_extractors
wartość domyślna: None

Zwraca

Typ Opis

Wystąpienie tego modelu

Wyjątki

Typ Opis
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict(full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

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

Parametry

Nazwa Opis
keep_readonly
bool

Jeśli chcesz serializować atrybuty readonly

wartość domyślna: False

Zwraca

Typ Opis
dict

Obiekt zgodny z JSON w formacie JSON