SimpleField interface
インデックス定義内のフィールドを表します。フィールドの名前、データ型、および検索動作を表します。
プロパティ
analyzer |
フィールドに使用するアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用でき、searchAnalyzer または indexAnalyzer と一緒に設定することはできません。 アナライザーを選択すると、フィールドに対して変更することはできません。 |
facetable | ファセット クエリでフィールドを参照できるようにするかどうかを示す値。 通常、カテゴリ別のヒット数を含む検索結果のプレゼンテーションで使用されます (たとえば、デジタル カメラを検索し、ブランド別、画素数別、価格別などのヒット数を確認します)。 Edm.GeographyPoint 型または Collection(Edm.GeographyPoint) 型のフィールドをファセット可能にすることはできません。 既定値は false です。 |
filterable | $filterクエリでフィールドを参照できるようにするかどうかを示す値。 filterable は、文字列の処理方法で検索可能とは異なります。 フィルター可能な Edm.String 型または Collection(Edm.String) 型のフィールドは単語区切りを行わないので、比較は完全一致のみを対象とします。 たとえば、このようなフィールド f を "晴れた日" に設定した場合、$filter=f eq 'sunny' は一致しませんが、$filter=f eq 'sunny day' になります。 既定値は false です。 |
hidden | 検索結果でフィールドを返すことができるかどうかを示す値。 フィルター、並べ替え、またはスコア付けメカニズムとしてフィールド (余白など) を使用するが、エンド ユーザーにフィールドを表示したくない場合は、このオプションを無効にすることができます。 キー フィールドの場合、このプロパティは false にする必要があります。 このプロパティは、既存のフィールドで変更できます。 このプロパティを有効にしても、インデックス ストレージの要件は増加しません。 ベクトル フィールドの既定値は true、それ以外の場合は false です。 |
index |
フィールドのインデックス作成時に使用されるアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用できます。 searchAnalyzer と共に設定する必要があり、アナライザー オプションと一緒に設定することはできません。 このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりにアナライザー プロパティを使用してください。 アナライザーを選択すると、フィールドに対して変更することはできません。 |
key | フィールドがインデックス内のドキュメントを一意に識別するかどうかを示す値。 キー フィールドとして各インデックスの最上位フィールドを 1 つだけ選択し、Edm.String 型にする必要があります。 キー フィールドを使用すると、ドキュメントを直接検索したり、特定のドキュメントを更新または削除したりできます。 既定値は false です。 |
name | フィールドの名前。インデックスまたは親フィールドのフィールド コレクション内で一意である必要があります。 |
searchable | フィールドがフルテキスト検索可能かどうかを示す値。 つまり、インデックス作成中に単語区切りなどの分析が行われます。 検索可能なフィールドを "晴れた日" のような値に設定すると、内部的には個々のトークン "sunny" と "day" に分割されます。 これにより、これらの用語のフルテキスト検索が可能になります。 Edm.String 型または Collection(Edm.String) 型のフィールドは、既定で検索できます。 他の文字列以外のデータ型の単純フィールドの場合、このプロパティは false にする必要があります。 注: 検索可能フィールドは、フルテキスト検索のフィールド値のトークン化された追加バージョンに対応するために、インデックスに余分なスペースを消費します。 インデックスの領域を節約する必要があり、検索にフィールドを含める必要がない場合は、検索可能を false に設定します。 既定値は false です。 |
search |
フィールドの検索時に使用されるアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用できます。
|
sortable | $orderby式でフィールドを参照できるようにするかどうかを示す値。 既定では、検索エンジンは結果をスコアで並べ替えますが、多くのエクスペリエンスでは、ユーザーはドキュメント内のフィールドで並べ替える必要があります。 単純フィールドは、単一値である場合にのみ並べ替えることができます (親ドキュメントのスコープ内に 1 つの値があります)。 単純なコレクション フィールドは複数値であるため、並べ替えできません。 複合コレクションの単純なサブフィールドも複数値であるため、並べ替えできません。 これは、それが直接の親フィールドであるか、先祖フィールドであるかに関係なく、複雑なコレクションです。 既定値は false です。 |
stored | フィールドが検索結果に返されるディスク上に個別に保持されるかどうかを示す変更できない値。 検索応答でフィールドの内容を返してストレージのオーバーヘッドを節約する予定がない場合は、このオプションを無効にすることができます。 これは、インデックスの作成時にのみ設定でき、ベクター フィールドに対してのみ設定できます。 既存のフィールドに対してこのプロパティを変更したり、新しいフィールドに対して false に設定したりすることはできません。 このプロパティが false に設定されている場合、プロパティ 'hidden' を 'true' に設定する必要があります。 このプロパティは、キー フィールド、新しいフィールド、および非ベクター フィールドの場合は false または未設定にする必要があります。 このプロパティを無効にすると、インデックスストレージの要件が減ります。 |
synonym |
このフィールドに関連付けるシノニム マップの名前の一覧。 このオプションは、検索可能なフィールドでのみ使用できます。 現在、サポートされているシノニム マップはフィールドごとに 1 つだけです。 フィールドにシノニム マップを割り当てると、そのフィールドを対象とするクエリ用語が、シノニム マップのルールを使用してクエリ時に展開されます。 この属性は、既存のフィールドで変更できます。 |
type | フィールドのデータ型。 |
vector |
フィールドの内容を解釈するエンコード形式。 |
vector |
ベクター フィールドの次元。 |
vector |
ベクター フィールドを検索するときに使用するアルゴリズムとベクターライザーを指定するベクター検索プロファイルの名前。 |
プロパティの詳細
analyzerName
フィールドに使用するアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用でき、searchAnalyzer または indexAnalyzer と一緒に設定することはできません。 アナライザーを選択すると、フィールドに対して変更することはできません。
analyzerName?: string
プロパティ値
string
facetable
ファセット クエリでフィールドを参照できるようにするかどうかを示す値。 通常、カテゴリ別のヒット数を含む検索結果のプレゼンテーションで使用されます (たとえば、デジタル カメラを検索し、ブランド別、画素数別、価格別などのヒット数を確認します)。 Edm.GeographyPoint 型または Collection(Edm.GeographyPoint) 型のフィールドをファセット可能にすることはできません。 既定値は false です。
facetable?: boolean
プロパティ値
boolean
filterable
$filterクエリでフィールドを参照できるようにするかどうかを示す値。 filterable は、文字列の処理方法で検索可能とは異なります。 フィルター可能な Edm.String 型または Collection(Edm.String) 型のフィールドは単語区切りを行わないので、比較は完全一致のみを対象とします。 たとえば、このようなフィールド f を "晴れた日" に設定した場合、$filter=f eq 'sunny' は一致しませんが、$filter=f eq 'sunny day' になります。 既定値は false です。
filterable?: boolean
プロパティ値
boolean
hidden
検索結果でフィールドを返すことができるかどうかを示す値。 フィルター、並べ替え、またはスコア付けメカニズムとしてフィールド (余白など) を使用するが、エンド ユーザーにフィールドを表示したくない場合は、このオプションを無効にすることができます。 キー フィールドの場合、このプロパティは false にする必要があります。 このプロパティは、既存のフィールドで変更できます。 このプロパティを有効にしても、インデックス ストレージの要件は増加しません。 ベクトル フィールドの既定値は true、それ以外の場合は false です。
hidden?: boolean
プロパティ値
boolean
indexAnalyzerName
フィールドのインデックス作成時に使用されるアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用できます。 searchAnalyzer と共に設定する必要があり、アナライザー オプションと一緒に設定することはできません。 このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりにアナライザー プロパティを使用してください。 アナライザーを選択すると、フィールドに対して変更することはできません。
indexAnalyzerName?: string
プロパティ値
string
key
フィールドがインデックス内のドキュメントを一意に識別するかどうかを示す値。 キー フィールドとして各インデックスの最上位フィールドを 1 つだけ選択し、Edm.String 型にする必要があります。 キー フィールドを使用すると、ドキュメントを直接検索したり、特定のドキュメントを更新または削除したりできます。 既定値は false です。
key?: boolean
プロパティ値
boolean
name
フィールドの名前。インデックスまたは親フィールドのフィールド コレクション内で一意である必要があります。
name: string
プロパティ値
string
searchable
フィールドがフルテキスト検索可能かどうかを示す値。 つまり、インデックス作成中に単語区切りなどの分析が行われます。 検索可能なフィールドを "晴れた日" のような値に設定すると、内部的には個々のトークン "sunny" と "day" に分割されます。 これにより、これらの用語のフルテキスト検索が可能になります。 Edm.String 型または Collection(Edm.String) 型のフィールドは、既定で検索できます。 他の文字列以外のデータ型の単純フィールドの場合、このプロパティは false にする必要があります。 注: 検索可能フィールドは、フルテキスト検索のフィールド値のトークン化された追加バージョンに対応するために、インデックスに余分なスペースを消費します。 インデックスの領域を節約する必要があり、検索にフィールドを含める必要がない場合は、検索可能を false に設定します。 既定値は false です。
searchable?: boolean
プロパティ値
boolean
searchAnalyzerName
フィールドの検索時に使用されるアナライザーの名前。 このオプションは、検索可能なフィールドでのみ使用できます。
indexAnalyzerName
と共に設定する必要があり、analyzerName
オプションと一緒に設定することはできません。 このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりに analyzerName
プロパティを使用してください。 このアナライザーは、既存のフィールドで更新できます。
searchAnalyzerName?: string
プロパティ値
string
sortable
$orderby式でフィールドを参照できるようにするかどうかを示す値。 既定では、検索エンジンは結果をスコアで並べ替えますが、多くのエクスペリエンスでは、ユーザーはドキュメント内のフィールドで並べ替える必要があります。 単純フィールドは、単一値である場合にのみ並べ替えることができます (親ドキュメントのスコープ内に 1 つの値があります)。 単純なコレクション フィールドは複数値であるため、並べ替えできません。 複合コレクションの単純なサブフィールドも複数値であるため、並べ替えできません。 これは、それが直接の親フィールドであるか、先祖フィールドであるかに関係なく、複雑なコレクションです。 既定値は false です。
sortable?: boolean
プロパティ値
boolean
stored
フィールドが検索結果に返されるディスク上に個別に保持されるかどうかを示す変更できない値。 検索応答でフィールドの内容を返してストレージのオーバーヘッドを節約する予定がない場合は、このオプションを無効にすることができます。 これは、インデックスの作成時にのみ設定でき、ベクター フィールドに対してのみ設定できます。 既存のフィールドに対してこのプロパティを変更したり、新しいフィールドに対して false に設定したりすることはできません。 このプロパティが false に設定されている場合、プロパティ 'hidden' を 'true' に設定する必要があります。 このプロパティは、キー フィールド、新しいフィールド、および非ベクター フィールドの場合は false または未設定にする必要があります。 このプロパティを無効にすると、インデックスストレージの要件が減ります。
stored?: boolean
プロパティ値
boolean
synonymMapNames
このフィールドに関連付けるシノニム マップの名前の一覧。 このオプションは、検索可能なフィールドでのみ使用できます。 現在、サポートされているシノニム マップはフィールドごとに 1 つだけです。 フィールドにシノニム マップを割り当てると、そのフィールドを対象とするクエリ用語が、シノニム マップのルールを使用してクエリ時に展開されます。 この属性は、既存のフィールドで変更できます。
synonymMapNames?: string[]
プロパティ値
string[]
type
vectorEncodingFormat
フィールドの内容を解釈するエンコード形式。
vectorEncodingFormat?: string
プロパティ値
string
vectorSearchDimensions
ベクター フィールドの次元。
vectorSearchDimensions?: number
プロパティ値
number
vectorSearchProfileName
ベクター フィールドを検索するときに使用するアルゴリズムとベクターライザーを指定するベクター検索プロファイルの名前。
vectorSearchProfileName?: string
プロパティ値
string