BaseSearchRequestOptions interface
フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。
プロパティ
| facets | 検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、名前と値のペアのコンマ区切りのリストが続きます。 |
| filter | 検索クエリに適用する OData $filter式。 |
| highlight |
ヒット強調表示に使用するフィールド名のコンマ区切りのリスト。 検索可能なフィールドのみを、ヒット強調表示に使用できます。 |
| highlight |
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は /em<>です。 |
| highlight |
強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は <em>です。 |
| include |
結果の合計数をフェッチするかどうかを指定する値。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは近似値であることに注意してください。 |
| minimum |
クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。 |
| order |
結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。 |
| query |
検索クエリの構文を指定する値。 既定値は "simple" です。 クエリで Lucene クエリ構文を使用する場合は、'full' を使用します。 指定できる値は、"simple"、"full"、"semantic" です。 |
| scoring |
形式名と値を使用してスコアリング関数 (referencePointParameter など) で使用するパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation-122.2,44.8" になります (引用符は使用しません)。 |
| scoring |
結果を並べ替えるために一致するドキュメントの一致スコアを評価するスコアリング プロファイルの名前。 |
| scoring |
スコアリングの統計情報 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルに計算するかを指定する値。待機時間を短縮します。 使用可能な値は、'Local'、'Global' です。 |
| search |
フルテキスト検索の範囲を指定するフィールド名のコンマ区切りのリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターに記載されているフィールド名よりも優先されます。 |
| search |
ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを指定する値。 指定できる値は、'any'、'all' です。 |
| select | 取得するフィールドの一覧。 指定しない場合、スキーマで取得可能としてマークされているすべてのフィールドが含まれます。 |
| session |
スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。 |
| skip | スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。 |
| top | 取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。 |
| vector |
ベクター検索クエリのオプションを定義します |
プロパティの詳細
facets
検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、名前と値のペアのコンマ区切りのリストが続きます。
facets?: string[]プロパティ値
string[]
filter
検索クエリに適用する OData $filter式。
filter?: stringプロパティ値
string
highlightFields
ヒット強調表示に使用するフィールド名のコンマ区切りのリスト。 検索可能なフィールドのみを、ヒット強調表示に使用できます。
highlightFields?: stringプロパティ値
string
highlightPostTag
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は /em<>です。
highlightPostTag?: stringプロパティ値
string
highlightPreTag
強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は <em>です。
highlightPreTag?: stringプロパティ値
string
includeTotalCount
結果の合計数をフェッチするかどうかを指定する値。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは近似値であることに注意してください。
includeTotalCount?: booleanプロパティ値
boolean
minimumCoverage
クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。
minimumCoverage?: numberプロパティ値
number
orderBy
結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
orderBy?: string[]プロパティ値
string[]
queryType
検索クエリの構文を指定する値。 既定値は "simple" です。 クエリで Lucene クエリ構文を使用する場合は、'full' を使用します。 指定できる値は、"simple"、"full"、"semantic" です。
queryType?: QueryTypeプロパティ値
scoringParameters
形式名と値を使用してスコアリング関数 (referencePointParameter など) で使用するパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation-122.2,44.8" になります (引用符は使用しません)。
scoringParameters?: string[]プロパティ値
string[]
scoringProfile
結果を並べ替えるために一致するドキュメントの一致スコアを評価するスコアリング プロファイルの名前。
scoringProfile?: stringプロパティ値
string
scoringStatistics
スコアリングの統計情報 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルに計算するかを指定する値。待機時間を短縮します。 使用可能な値は、'Local'、'Global' です。
scoringStatistics?: ScoringStatisticsプロパティ値
searchFields
フルテキスト検索の範囲を指定するフィールド名のコンマ区切りのリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターに記載されているフィールド名よりも優先されます。
searchFields?: SearchFieldArray<TModel>プロパティ値
SearchFieldArray<TModel>
searchMode
ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを指定する値。 指定できる値は、'any'、'all' です。
searchMode?: SearchModeプロパティ値
select
取得するフィールドの一覧。 指定しない場合、スキーマで取得可能としてマークされているすべてのフィールドが含まれます。
select?: SelectArray<TFields>プロパティ値
SelectArray<TFields>
sessionId
スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間での要求の負荷分散が妨げられる可能性があり、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。
sessionId?: stringプロパティ値
string
skip
スキップする検索結果の数。 この値を 100,000 より大きくすることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限のためにスキップを使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。
skip?: numberプロパティ値
number
top
取得する検索結果の数。 これを$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングが原因で結果が切り捨てられた場合、応答には、結果の次のページに対して別の検索要求を発行するために使用できる継続トークンが含まれます。
top?: numberプロパティ値
number
vectorSearchOptions
ベクター検索クエリのオプションを定義します
vectorSearchOptions?: VectorSearchOptions<TModel>プロパティ値
VectorSearchOptions<TModel>