Field クラス

定義

名前空間:

Microsoft.Azure.Search.Models

アセンブリ:

Microsoft.Azure.Search.Service.dll

パッケージ:

Microsoft.Azure.Search.Service v10.1.0

ソース:

Field.cs

フィールドの名前、データ型、および検索動作を記述する、インデックス定義内のフィールドを表します。 https://docs.microsoft.com/rest/api/searchservice/Create-Index

public class Field

type Field = class

Public Class Field

継承

Object

Field

コンストラクター

Field(String, AnalyzerName)	必要な引数を使用して、新しい検索可能な文字列 Field を初期化します。
Field(String, DataType)	必須の引数を使用して、新しい単純な Field を初期化します。
Field(String, DataType, AnalyzerName)	必要な引数を使用して、新しい検索可能な単純なフィールドを初期化します。
Field(String, DataType, IList<Field>)	必須の引数を使用して、新しい複雑な Field を初期化します。

プロパティ

Analyzer	フィールドに使用する言語アナライザーの名前を取得または設定します。 このオプションは、検索可能なフィールドでのみ使用でき、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'、'is.microsoft'、'id.microsoft'、'id.lucene'、'ga.lucene'、'it.microsoft'、'it.lucene'、'ja.microsoft'、'ja.lucene'、'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'、'th.microsoft'、'th.lucene'、'tr.microsoft'、'tr.lucene'、'uk.microsoft'、'your.microsoft'、'vi.microsoft'、'standard.lucene'、'standardasciifolding.lucene'、'キーワード (keyword)'、'pattern'、'simple'、'stop'、'whitespace'
Fields	Edm.ComplexType 型または Collection(Edm.ComplexType) 型のフィールドである場合は、サブフィールドの一覧を取得または設定します。 単純フィールドの場合は null または空である必要があります。
IndexAnalyzer	フィールドのインデックス作成時に使用されるアナライザーの名前を取得または設定します。 このオプションは、検索可能なフィールドでのみ使用できます。 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'、'is.microsoft'、'id.microsoft'、'id.lucene'、'ga.lucene'、'it.microsoft'、'it.lucene'、'ja.microsoft'、'ja.lucene'、'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'、'th.microsoft'、'th.lucene'、'tr.microsoft'、'tr.lucene'、'uk.microsoft'、'your.microsoft'、'vi.microsoft'、'standard.lucene'、'standardasciifolding.lucene'、'キーワード (keyword)'、'pattern'、'simple'、'stop'、'whitespace'
IsFacetable	ファセット クエリでフィールドを参照できるかどうかを示す値を取得または設定します。 通常、カテゴリ別のヒット数を含む検索結果のプレゼンテーションで使用されます (たとえば、デジタル カメラを検索し、ブランド別、メガピクセル別、価格別などのヒット数を確認します)。 複合フィールドの場合、このプロパティは null である必要があります。 Edm.GeographyPoint 型または Collection(Edm.GeographyPoint) 型のフィールドをファセット可能にすることはできません。 その他の単純なフィールドはすべてファセット可能です。 単純なフィールドの場合は既定値は false、複合フィールドの場合は null です。
IsFilterable	$filterクエリでフィールドを参照できるかどうかを示す値を取得または設定します。 filterable は、文字列の処理方法で検索可能とは異なります。 フィルター可能な Edm.String 型または Collection(Edm.String) 型のフィールドは単語区切りを行わないので、比較は完全一致のみを対象とします。 たとえば、このようなフィールド f を "晴れた日" に設定した場合、$filter=f eq 'sunny' は一致しませんが、$filter=f eq 'sunny day' は発生します。 複合フィールドの場合、このプロパティは null である必要があります。 単純フィールドの場合は既定値は false、複合フィールドの場合は null です。
IsKey	フィールドがインデックス内のドキュメントを一意に識別するかどうかを示す値を取得または設定します。 キー フィールドとして各インデックスの最上位フィールドを 1 つだけ選択し、Edm.String 型にする必要があります。 キー フィールドを使用すると、ドキュメントを直接検索したり、特定のドキュメントを更新または削除したりできます。 単純フィールドの場合は既定値は false、複合フィールドの場合は null です。
IsRetrievable	フィールドを検索結果で返すことができるかどうかを示す値を取得または設定します。 フィルター、並べ替え、スコアリングのメカニズムとしてフィールド (余白など) を使用するが、エンド ユーザーにフィールドを表示したくない場合は、このオプションを無効にすることができます。 このプロパティは、キー フィールドの場合は true、複合フィールドの場合は null である必要があります。 このプロパティは、既存のフィールドで変更できます。 このプロパティを有効にしても、インデックス ストレージの要件が増加することはありません。 単純フィールドの場合は既定値は true、複合フィールドの場合は null です。
IsSearchable	フィールドがフルテキスト検索可能かどうかを示す値を取得または設定します。 これは、インデックス処理中に単語の区切りなどの分析が行われることを意味します。 検索可能フィールドを "sunny day" などの値に設定した場合、その値は内部的に個別のトークン "sunny" と "day" に分割されます。 これにより、これらの語句をフルテキスト検索できます。 このプロパティは、Edm.String 型または Collection(Edm.String) 型のフィールドに対してのみ true に設定でき、複合フィールドの場合は null である必要があります。 単純フィールドの場合は既定値は false、複合フィールドの場合は null です。 注: Azure Cognitive Searchではフルテキスト検索用のフィールド値の追加のトークン化されたバージョンが格納されるため、検索可能なフィールドではインデックスに余分な領域が消費されます。 インデックスの領域を節約し、検索にフィールドを含める必要がない場合は、searchable を false に設定します。
IsSortable	$orderby式でフィールドを参照できるかどうかを示す値を取得または設定します。 既定では、Azure Cognitive Searchスコアで結果が並べ替えられますが、多くのエクスペリエンスでは、ユーザーはドキュメント内のフィールドで並べ替える必要があります。 単純なフィールドは、単一値の場合にのみ並べ替えることができます (親ドキュメントのスコープに 1 つの値があります)。 単純なコレクション フィールドは複数値であるため、並べ替えできません。 複雑なコレクションの単純なサブフィールドも複数値であるため、並べ替えはできません。 これは、親フィールドが直接であるか、先祖フィールドであるかに関係なく、複雑なコレクションである場合に当てはまります。 複合フィールドは並べ替え可能にできず、このようなフィールドの並べ替え可能なプロパティは null である必要があります。 並べ替え可能の既定値は、単純なフィールドの場合は false、複合フィールドの場合は null です。
Name	インデックスまたは親フィールドの fields コレクション内で一意である必要があるフィールドの名前を取得または設定します。
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'、'is.microsoft'、'id.microsoft'、'id.lucene'、'ga.lucene'、'it.microsoft'、'it.lucene'、'ja.microsoft'、'ja.lucene'、'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'、'th.microsoft'、'th.lucene'、'tr.microsoft'、'tr.lucene'、'uk.microsoft'、'your.microsoft'、'vi.microsoft'、'standard.lucene'、'standardasciifolding.lucene'、'キーワード (keyword)'、'pattern'、'simple'、'stop'、'whitespace'
SynonymMaps	このフィールドに関連付けるシノニム マップの名前の一覧を取得または設定します。 このオプションは、検索可能なフィールドでのみ使用できます。 現在、サポートされているシノニム マップはフィールドごとに 1 つだけです。 フィールドにシノニム マップを割り当てると、シノニム マップのルールを使用して、そのフィールドを対象とするクエリ用語がクエリ時に展開されるようになります。 この属性は、既存のフィールドで変更できます。 複合フィールドの場合は null または空のコレクションである必要があります。
Type	フィールドのデータ型を取得または設定します。 使用できる値は、'Edm.String'、'Edm.Int32'、'Edm.Int64'、'Edm.Double'、'Edm.Boolean'、'Edm.DateTimeOffset'、'Edm.GeographyPoint'、'Edm.ComplexType' です。

メソッド

New(String, DataType, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<AnalyzerName>, Nullable<AnalyzerName>, Nullable<AnalyzerName>, IList<String>)	必要な引数を持つ新しい単純な Field を作成します。
NewComplex(String, Boolean, IList<Field>)	必要な引数を持つ新しい複雑な Field を作成します。
NewSearchableCollection(String, AnalyzerName, Boolean, Boolean, Boolean, Boolean, IList<String>)	必要な引数を持つ新しい検索可能な文字列コレクション Field を作成します。
NewSearchableString(String, AnalyzerName, Boolean, Boolean, Boolean, Boolean, Boolean, IList<String>)	必要な引数を持つ新しい検索可能な文字列 Field を作成します。
Validate()	オブジェクトを検証します。