SearchIndexerSkill クラス

スキルの基本型。

このクラスを直接使用せず、サブクラスを使用する必要がある場合があります。 既知のサブクラスは次のとおりです。WebApiSkill、 CustomEntityLookupSkill、EntityRecognitionSkill、KeyPhraseExtractionSkill、LanguageDetectionSkill、MergeSkill、PIIDetectionSkill、SentimentSkill、SplitSkill、TextTranslationSkill、EntityLinkingSkill、EntityRecognitionSkillV3、SentimentSkillV3、ConditionalSkill、DocumentExtractionSkill、ShaperSkill、ImageAnalysisSkill、OcrSkill

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

継承

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

SearchIndexerSkill

コンストラクター

SearchIndexerSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, **kwargs: Any)

Keyword-Only パラメータ

名前	説明
name	str スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が与えられ、先頭に 文字 が付けられます #。
description	str スキルの入力、出力、使用状況を記述するスキルの説明。
context	str ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。 既定値は /document です。
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。 必須。
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。 必須。

変数

名前	説明
odata_type	str スキルの種類を指定する URI フラグメント。 必須。
name	str スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が与えられ、先頭に 文字 が付けられます #。
description	str スキルの入力、出力、使用状況を記述するスキルの説明。
context	str ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。 既定値は /document です。
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。 必須。
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。 必須。

メソッド

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 互換オブジェクト