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で作成する暗号化キーの説明。 このキーは、インデクサー定義 (およびインデクサーの実行状態) に対して保存時の追加レベルの暗号化を提供するために使用されます。これは、Microsoft であっても誰も暗号化を解除できないという完全な保証が必要な場合です。 インデクサー定義を暗号化すると、常に暗号化されたままになります。 このプロパティを null に設定しようとすると、検索サービスは無視されます。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。インデクサー定義 (およびインデクサーの実行状態) は影響を受けません。 カスタマー マネージド キーを使用した暗号化は無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

変数

名前 説明
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で作成する暗号化キーの説明。 このキーは、インデクサー定義 (およびインデクサーの実行状態) に対して保存時の追加レベルの暗号化を提供するために使用されます。これは、Microsoft であっても誰も暗号化を解除できないという完全な保証が必要な場合です。 インデクサー定義を暗号化すると、常に暗号化されたままになります。 このプロパティを null に設定しようとすると、検索サービスは無視されます。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。インデクサー定義 (およびインデクサーの実行状態) は影響を受けません。 カスタマー マネージド キーを使用した暗号化は無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

メソッド

as_dict

json.dump を使用してシリアル化できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。
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 を使用してシリアル化できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。

このファイルの 3 つの例を参照してください。

  • 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

dict JSON 互換オブジェクト

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

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

パラメーター

名前 説明
data
必須
str

RestAPI 構造体を使用する str。 既定では JSON。
content_type
str

既定では JSON、XML の場合は application/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、XML の場合は application/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

dict JSON 互換オブジェクト