Поделиться через

SearchIndexer Класс

  • Ссылка

Представляет индексатор.

Все необходимые параметры должны быть заполнены для отправки в Azure.

Наследование
azure.search.documents.indexes._generated._serialization.Model
SearchIndexer

Конструктор

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

Имя Описание
name
str

Имя индексатора. Обязательный.
description
str

Описание индексатора.
data_source_name
str

Имя источника данных, из которого индексатор считывает данные. Обязательный.
skillset_name
str

Имя набора навыков, выполняемого с помощью этого индексатора.
target_index_name
str

Имя индекса, в который индексатор записывает данные. Обязательный.
schedule
<xref:search_service_client.models.IndexingSchedule>

Расписание для этого индексатора.
parameters
<xref:search_service_client.models.IndexingParameters>

Параметры для выполнения индексатора.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Определяет сопоставления между полями в источнике данных и соответствующими целевыми полями в индексе.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Сопоставления полей вывода применяются после обогащения и непосредственно перед индексированием.
is_disabled
bool

Значение , указывающее, отключен ли индексатор. Значение по умолчанию — false.
e_tag
str

ETag индексатора.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для предоставления дополнительного уровня шифрования неактивных данных для определения индексатора (а также состояния выполнения индексатора), если требуется полная гарантия того, что никто, даже корпорация Майкрософт, не может расшифровать их. После шифрования определения индексатора оно всегда будет оставаться зашифрованным. Служба поиска игнорирует попытки присвоить этому свойству значение NULL. Это свойство можно изменить при необходимости, если требуется сменить ключ шифрования. Определение индексатора (и состояние выполнения индексатора) не будут затронуты. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 года или позже.

Переменные

Имя Описание
name
str

Имя индексатора. Обязательный.
description
str

Описание индексатора.
data_source_name
str

Имя источника данных, из которого индексатор считывает данные. Обязательный.
skillset_name
str

Имя набора навыков, выполняемого с помощью этого индексатора.
target_index_name
str

Имя индекса, в который индексатор записывает данные. Обязательный.
schedule
<xref:search_service_client.models.IndexingSchedule>

Расписание для этого индексатора.
parameters
<xref:search_service_client.models.IndexingParameters>

Параметры для выполнения индексатора.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Определяет сопоставления между полями в источнике данных и соответствующими целевыми полями в индексе.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Сопоставления полей вывода применяются после обогащения и непосредственно перед индексированием.
is_disabled
bool

Значение , указывающее, отключен ли индексатор. Значение по умолчанию — false.
e_tag
str

ETag индексатора.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для предоставления дополнительного уровня шифрования неактивных данных для определения индексатора (а также состояния выполнения индексатора), если требуется полная гарантия того, что никто, даже корпорация Майкрософт, не может расшифровать их. После шифрования определения индексатора оно всегда будет оставаться зашифрованным. Служба поиска игнорирует попытки присвоить этому свойству значение NULL. Это свойство можно изменить при необходимости, если требуется сменить ключ шифрования. Определение индексатора (и состояние выполнения индексатора) не будут затронуты. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 года или позже.

Методы

as_dict

Возвращает диктовку, которую можно сериализовать с помощью json.dump.

При дополнительном использовании можно использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется сериализация XML, можно передать kwargs is_xml=True.
deserialize

Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
enable_additional_properties_sending
from_dict

Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Возвращает json, который будет отправлен на сервер из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется сериализация XML, можно передать kwargs is_xml=True.

as_dict

Возвращает диктовку, которую можно сериализовать с помощью json.dump.

При дополнительном использовании можно использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется сериализация XML, можно передать 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]

Параметры

Имя Описание
key_transformer
<xref:function>

Функция преобразователя ключей.
keep_readonly
значение по умолчанию: True

Возвращаемое значение

Тип Описание
dict

Объект, совместимый с JSON для диктовки

deserialize

Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.

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

Параметры

Имя Описание
data
Обязательно
str

Str, использующий структуру RestAPI. JSON по умолчанию.
content_type
str

JSON по умолчанию задайте значение application/xml, если XML.

значение по умолчанию: None

Возвращаемое значение

Тип Описание

Экземпляр этой модели

Исключения

Тип Описание
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и 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

Параметры

Имя Описание
data
Обязательно
dict

Диктовка, использующий структуру RestAPI
content_type
str

JSON по умолчанию задайте значение application/xml, если XML.

значение по умолчанию: None
key_extractors
значение по умолчанию: None

Возвращаемое значение

Тип Описание

Экземпляр этой модели

Исключения

Тип Описание
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Возвращает json, который будет отправлен на сервер из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется сериализация XML, можно передать kwargs is_xml=True.

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

Параметры

Имя Описание
keep_readonly
bool

Если вы хотите сериализовать атрибуты только для чтения

значение по умолчанию: False

Возвращаемое значение

Тип Описание
dict

Объект, совместимый с JSON для диктовки