SearchField クラス

フィールドの名前、データ型、および検索動作を記述するインデックス定義のフィールドを表します。

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

継承

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

SearchField

コンストラクター

SearchField(**kwargs)

変数

名前	説明
name	str フィールドの名前。インデックスまたは親フィールドの fields コレクション内で一意である必要があります。 必須。
type	str または <xref:search_service_client.models.SearchFieldDataType> フィールドのデータ型。 必須。 既知の値は、"Edm.String"、"Edm.Int32"、"Edm.Int64"、"Edm.Double"、"Edm.Boolean"、"Edm.DateTimeOffset"、"Edm.GeographyPoint"、"Edm.ComplexType"、"Edm.Single" です。
key	bool フィールドがインデックス内のドキュメントを一意に識別するかどうかを示す値。 キー フィールドとして各インデックスの最上位フィールドを 1 つだけ選択し、Edm.String 型にする必要があります。 キー フィールドを使用すると、ドキュメントを直接検索したり、特定のドキュメントを更新または削除したりできます。 単純なフィールドの場合は既定値は false、複合フィールドの場合は null です。
searchable	bool フィールドがフルテキスト検索可能かどうかを示す値。 これは、インデックス処理中に単語の区切りなどの分析が行われることを意味します。 検索可能フィールドを "sunny day" などの値に設定した場合、その値は内部的に個別のトークン "sunny" と "day" に分割されます。 これにより、これらの語句をフルテキスト検索できます。 Edm.String 型または Collection(Edm.String) 型のフィールドは、既定で検索できます。 このプロパティは、他の文字列以外のデータ型の単純なフィールドの場合は false、複合フィールドの場合は null である必要があります。 注: 検索可能なフィールドでは、フルテキスト検索用のフィールド値のトークン化された追加バージョンがAzure Cognitive Searchに格納されるため、インデックスに余分な領域が消費されます。 インデックスの領域を節約し、検索にフィールドを含める必要がない場合は、searchable を false に設定します。
filterable	bool $filterクエリでフィールドを参照できるかどうかを示す値。 filterable は、文字列の処理方法で検索可能とは異なります。 フィルター可能な Edm.String 型または Collection(Edm.String) 型のフィールドは単語区切りを行わないので、比較は完全一致のみを対象とします。 たとえば、このようなフィールド f を "晴れた日" に設定した場合、$filter=f eq 'sunny' は一致しませんが、$filter=f eq 'sunny day' は見つかります。 複合フィールドの場合、このプロパティは null である必要があります。 単純フィールドの場合は既定値は true、複合フィールドの場合は null です。
sortable	bool $orderby式でフィールドを参照できるかどうかを示す値。 既定ではAzure Cognitive Search結果はスコア順に並べ替えられますが、多くのエクスペリエンスでは、ユーザーはドキュメント内のフィールドで並べ替える必要があります。 単純なフィールドは、単一値の場合にのみ並べ替えることができます (親ドキュメントのスコープに 1 つの値があります)。 単純なコレクション フィールドは複数値であるため、並べ替えできません。 複雑なコレクションの単純なサブフィールドも複数値であるため、並べ替えできません。 これは、それが直接の親フィールドであるか、先祖フィールドであるかに関係なく、複雑なコレクションです。 複合フィールドは並べ替え可能にできず、このようなフィールドの並べ替え可能なプロパティは null である必要があります。 並べ替え可能の既定値は、単一値の単純フィールドの場合は true、複数値の単純フィールドの場合は false、複合フィールドの場合は null です。
facetable	bool ファセット クエリでフィールドを参照できるかどうかを示す値。 通常、カテゴリ別のヒット数を含む検索結果のプレゼンテーションで使用されます (たとえば、デジタルカメラを検索し、ブランド別、メガピクセル別、価格別などのヒット数を確認します)。 複合フィールドの場合、このプロパティは null である必要があります。 Edm.GeographyPoint 型または Collection(Edm.GeographyPoint) 型のフィールドをファセット可能にすることはできません。 他のすべての単純なフィールドの既定値は true です。
analyzer_name	str または <xref:search_service_client.models.LexicalAnalyzerName> フィールドに使用するアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用でき、searchAnalyzer または indexAnalyzer と共に設定することはできません。 フィールドのアナライザーを選択した後は変更できません。 複合フィールドの場合は null にする必要があります。 既知の値は、"ar.microsoft"、"ar.lucene"、"hy.lucene"、 "bn.microsoft"、"eu.lucene"、"bg.microsoft"、"bg.lucene"、"ca.microsoft"、"ca.lucene"、"zh-Hans.microsoft"、"zh-Hans.lucene"、"zh-Hant.microsoft"、"zh-Hant.lucene"、"hr.microsoft"、"cs.microsoft"、"cs.lucene"、 "da.microsoft"、"da.lucene"、"nl.microsoft"、"nl.lucene"、"en.microsoft"、"en.lucene"、"et.microsoft"、"fi.microsoft"、"fi.lucene"、"fr.microsoft"、"fr.lucene"、"gl.lucene"、"de.microsoft"、"de.lucene"、"el.microsoft"、"el.lucene"、"gu.microsoft"、"he.microsoft"、"hi.microsoft"、"hi.lucene"、"hu.microsoft"、"hu.lucene"、"is.microsoft"、"id.microsoft"、"id.lucene"、"ga.lucene"、"it.microsoft"、"it.lucene"、"ja.microsoft"、"ja.lucene"、 "kn.microsoft"、"ko.microsoft"、"ko.lucene"、"lv.microsoft"、"lv.lucene"、"lt.microsoft"、"ml.microsoft"、"ms.microsoft"、"mr.microsoft"、"nb.microsoft"、"no.lucene"、"fa.lucene"、"pl.microsoft"、"pl.lucene"、"pt-BR.microsoft"、"pt-BR.lucene"、"pt-PT.microsoft"、"pt-PT.lucene"、"pa.microsoft"、"ro.microsoft"、"ro.lucene"、"ru.microsoft"、"ru.lucene"、"sr-cyrillic.microsoft"、"sr-latin.microsoft"、"sk.microsoft"、"sl.microsoft"、 "es.microsoft"、"es.lucene"、"sv.microsoft"、"sv.lucene"、"ta.microsoft"、"te.microsoft"、"th.microsoft"、"th.lucene"、"tr.microsoft"、"tr.lucene"、"uk.microsoft"、"your.microsoft"、"vi.microsoft"、"standard.lucene"、"standardasciifolding.lucene"、"キーワード (keyword)"、"pattern"、"simple"、"stop"、および "空白" です。
search_analyzer_name	str または <xref:search_service_client.models.LexicalAnalyzerName> フィールドの検索時に使用されるアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用できます。 indexAnalyzer と共に設定する必要があり、アナライザー オプションと一緒に設定することはできません。 このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりにアナライザー プロパティを使用してください。 このアナライザーは、既存のフィールドで更新できます。 複合フィールドの場合は null にする必要があります。 既知の値は、"ar.microsoft"、"ar.lucene"、"hy.lucene"、 "bn.microsoft"、"eu.lucene"、"bg.microsoft"、"bg.lucene"、"ca.microsoft"、"ca.lucene"、"zh-Hans.microsoft"、"zh-Hans.lucene"、"zh-Hant.microsoft"、"zh-Hant.lucene"、"hr.microsoft"、"cs.microsoft"、"cs.lucene"、 "da.microsoft"、"da.lucene"、"nl.microsoft"、"nl.lucene"、"en.microsoft"、"en.lucene"、"et.microsoft"、"fi.microsoft"、"fi.lucene"、"fr.microsoft"、"fr.lucene"、"gl.lucene"、"de.microsoft"、"de.lucene"、"el.microsoft"、"el.lucene"、"gu.microsoft"、"he.microsoft"、"hi.microsoft"、"hi.lucene"、"hu.microsoft"、"hu.lucene"、"is.microsoft"、"id.microsoft"、"id.lucene"、"ga.lucene"、"it.microsoft"、"it.lucene"、"ja.microsoft"、"ja.lucene"、 "kn.microsoft"、"ko.microsoft"、"ko.lucene"、"lv.microsoft"、"lv.lucene"、"lt.microsoft"、"ml.microsoft"、"ms.microsoft"、"mr.microsoft"、"nb.microsoft"、"no.lucene"、"fa.lucene"、"pl.microsoft"、"pl.lucene"、"pt-BR.microsoft"、"pt-BR.lucene"、"pt-PT.microsoft"、"pt-PT.lucene"、"pa.microsoft"、"ro.microsoft"、"ro.lucene"、"ru.microsoft"、"ru.lucene"、"sr-cyrillic.microsoft"、"sr-latin.microsoft"、"sk.microsoft"、"sl.microsoft"、 "es.microsoft"、"es.lucene"、"sv.microsoft"、"sv.lucene"、"ta.microsoft"、"te.microsoft"、"th.microsoft"、"th.lucene"、"tr.microsoft"、"tr.lucene"、"uk.microsoft"、"your.microsoft"、"vi.microsoft"、"standard.lucene"、"standardasciifolding.lucene"、"キーワード (keyword)"、"pattern"、"simple"、"stop"、および "空白" です。
index_analyzer_name	str または <xref:search_service_client.models.LexicalAnalyzerName> フィールドのインデックス作成時に使用されるアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用できます。 searchAnalyzer と共に設定する必要があり、アナライザー オプションと一緒に設定することはできません。 このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりにアナライザー プロパティを使用してください。 フィールドのアナライザーを選択した後は変更できません。 複合フィールドの場合は null にする必要があります。 既知の値は、"ar.microsoft"、"ar.lucene"、"hy.lucene"、 "bn.microsoft"、"eu.lucene"、"bg.microsoft"、"bg.lucene"、"ca.microsoft"、"ca.lucene"、"zh-Hans.microsoft"、"zh-Hans.lucene"、"zh-Hant.microsoft"、"zh-Hant.lucene"、"hr.microsoft"、"cs.microsoft"、"cs.lucene"、 "da.microsoft"、"da.lucene"、"nl.microsoft"、"nl.lucene"、"en.microsoft"、"en.lucene"、"et.microsoft"、"fi.microsoft"、"fi.lucene"、"fr.microsoft"、"fr.lucene"、"gl.lucene"、"de.microsoft"、"de.lucene"、"el.microsoft"、"el.lucene"、"gu.microsoft"、"he.microsoft"、"hi.microsoft"、"hi.lucene"、"hu.microsoft"、"hu.lucene"、"is.microsoft"、"id.microsoft"、"id.lucene"、"ga.lucene"、"it.microsoft"、"it.lucene"、"ja.microsoft"、"ja.lucene"、 "kn.microsoft"、"ko.microsoft"、"ko.lucene"、"lv.microsoft"、"lv.lucene"、"lt.microsoft"、"ml.microsoft"、"ms.microsoft"、"mr.microsoft"、"nb.microsoft"、"no.lucene"、"fa.lucene"、"pl.microsoft"、"pl.lucene"、"pt-BR.microsoft"、"pt-BR.lucene"、"pt-PT.microsoft"、"pt-PT.lucene"、"pa.microsoft"、"ro.microsoft"、"ro.lucene"、"ru.microsoft"、"ru.lucene"、"sr-cyrillic.microsoft"、"sr-latin.microsoft"、"sk.microsoft"、"sl.microsoft"、 "es.microsoft"、"es.lucene"、"sv.microsoft"、"sv.lucene"、"ta.microsoft"、"te.microsoft"、"th.microsoft"、"th.lucene"、"tr.microsoft"、"tr.lucene"、"uk.microsoft"、"your.microsoft"、"vi.microsoft"、"standard.lucene"、"standardasciifolding.lucene"、"キーワード (keyword)"、"pattern"、"simple"、"stop"、および "空白" です。
vector_search_dimensions	int ベクター フィールドの次元。
vector_search_profile_name	str ベクター フィールドを検索するときに使用するアルゴリズムを指定するベクター検索プロファイルの名前。
synonym_map_names	list[str] このフィールドに関連付けるシノニム マップの名前の一覧。 このオプションは、検索可能なフィールドでのみ使用できます。 現時点では、フィールドごとに 1 つのシノニム マップのみがサポートされています。 シノニム マップをフィールドに割り当てると、シノニム マップのルールを使用して、そのフィールドを対象とするクエリ用語がクエリ時に展開されます。 この属性は、既存のフィールドで変更できます。 複合フィールドの場合は null または空のコレクションである必要があります。
fields	list[<xref:search_service_client.models.SearchField>] Edm.ComplexType 型または Collection(Edm.ComplexType) 型のフィールドである場合のサブフィールドのリスト。 単純フィールドの場合は null または空である必要があります。

メソッド

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