次の方法で共有


SearchOptions クラス

定義

フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。

public class SearchOptions
type SearchOptions = class
Public Class SearchOptions
継承
SearchOptions

コンストラクター

SearchOptions()

SearchOptions の新しいインスタンスを初期化します。

プロパティ

Debug

セマンティック検索結果をさらに探索するために使用できるデバッグ ツールを有効にします。

Facets

検索クエリに適用するファセット式の一覧。 各ファセット式にはフィールド名が含まれます。必要に応じて、name:value ペアのコンマ区切りのリストが続きます。

Filter

検索クエリに適用する OData $filter式。 を使用 Create(FormattableString) すると、フィルター式の構築に役立ちます。

HighlightFields

ヒット ハイライトに使用するフィールド名の一覧。 検索可能なフィールドのみを、ヒット強調表示に使用できます。

HighlightPostTag

ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 既定値は </em です>。

HighlightPreTag

ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 既定値は em です<>。

IncludeTotalCount

結果の合計数を プロパティとして TotalCount フェッチするかどうかを示す 値。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは概数であることに注意してください。

MinimumCoverage

クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 100 です。

OrderBy

結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示し、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大で 32 個の$orderby句を指定できます。

QueryAnswer

検索応答の一部として返す必要があるかどうかを Answers 示す 値。

QueryAnswerCount

検索応答の一部として返される の数 Answers を示す 値。

QueryAnswerThreshold

検索応答の一部として返される のしきい値 Answers を指定する 値。

QueryCaption

検索応答の一部として返す必要があるかどうかを Captions 示す 値。

既定値は None です。

QueryCaptionHighlightEnabled

が に設定されている場合 QueryCaptionExtractiveこれを に設定すると true 、返されるキャプションが強調表示されます。 が設定されます Highlights

既定値は true です。

QueryLanguage

検索クエリの言語を指定する 値。

QuerySpeller

個々の検索クエリ用語のスペルを修正するために使用するスペル チェックの種類を指定する 値。

QueryType

検索クエリの構文を示す 値。 既定値は 'simple' です。 クエリで Lucene クエリ構文が使用されている場合は、'full' を使用します。

ScoringParameters

name-values 形式を使用してスコアリング関数 (referencePointParameter など) で使用されるパラメーター値の一覧。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation---122.2,44.8" になります (引用符は使用しません)。

ScoringProfile

結果を並び替えるために一致ドキュメントの一致スコアを評価するスコア付けプロファイルの名前。

ScoringStatistics

スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。 既定値は 'local' です。 スコアリングの前にグローバルにスコアリング統計を集計するには、'global' を使用します。 グローバル スコアリング統計を使用すると、検索クエリの待機時間が長くなる可能性があります。

SearchFields

フルテキスト検索の対象となるフィールド名の一覧。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターにリストされているフィールド名よりも優先されます。

SearchMode

ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを示す 値。

Select

取得するフィールドの一覧。 指定しないと、スキーマで取得可能とマークされているすべてのフィールドが含まれます。

SemanticConfigurationName

セマンティック型のクエリのドキュメントを処理するときに使用されるセマンティック構成の名前。

SemanticErrorHandling

セマンティック呼び出しを完全に失敗させるか、部分的な結果を返すかをユーザーが選択できるようにします (既定値)。

SemanticFields

セマンティック検索に使用されるフィールド名の一覧。

SemanticMaxWaitInMilliseconds

ユーザーが、セマンティック エンリッチメントが要求が失敗するまでの処理が完了するまでにかかる時間の上限を設定できるようにします。

SemanticQuery

セマンティック リランク、セマンティック キャプション、セマンティック回答にのみ使用される個別の検索クエリを設定できます。 基本取得フェーズとランク付けフェーズと L2 セマンティック フェーズの間で異なるクエリを使用する必要があるシナリオに役立ちます。

SessionId

スティッキー セッションの作成に使用する値。これは、より一貫性のある結果を得るのに役立ちます。 同じ sessionId が使用されている限り、同じレプリカ セットをターゲットにするためのベスト エフォート試行が行われます。 同じ sessionID 値を繰り返し再利用すると、レプリカ間の要求の負荷分散が妨げられ、検索サービスのパフォーマンスに悪影響を及ぼす可能性があります。 sessionId として使用される値は、'_' 文字で始めることはできません。

Size

取得する検索結果の数です。 これは、 Skip と組み合わせて使用して、検索結果のクライアント側のページングを実装できます。 サーバー側のページングによって結果が切り捨てられた場合、応答には継続トークンが含まれます。このトークンを使用して、結果の次のページに対して別の検索要求を発行できます。

Skip

スキップする検索結果の数です。 この値は 100,000 を超えることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限により skip を使用できない場合は、完全に順序付けられたキーで orderby を使用し、代わりに範囲クエリでフィルター処理することを検討してください。

VectorFilterMode

ベクター検索の実行前または実行後にフィルターを適用するかどうかを指定します。 既定値は 'preFilter' です。

VectorQueries

複数ベクトル検索クエリのクエリ パラメーター。

適用対象