BaseSearchRequestOptions interface

パッケージ:

@azure/search-documents

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

プロパティ

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

プロパティの詳細

facets

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

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

プロパティ値

QueryType

scoringParameters

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

scoringParameters?: string[]

プロパティ値

string[]

scoringProfile

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

scoringProfile?: string

プロパティ値

string

scoringStatistics

スコアリングの統計 (ドキュメントの頻度など) をグローバルに計算して、より一貫性のあるスコアリングを行うか、ローカルで計算して待機時間を短縮するかを指定する値。 使用可能な値は、'Local'、'Global' です。

scoringStatistics?: ScoringStatistics

プロパティ値

ScoringStatistics

searchFields

フルテキスト検索の範囲を指定するフィールド名のコンマ区切りリスト。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターにリストされているフィールド名よりも優先されます。

searchFields?: SearchFieldArray<TModel>

プロパティ値

SearchFieldArray<TModel>

searchMode

ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを示す 値。 使用可能な値は次のとおりです: 'any'、'all'

searchMode?: SearchMode

プロパティ値

SearchMode

select

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

select?: SelectArray<TFields>

プロパティ値

SelectArray<TFields>

sessionId

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

sessionId?: string

プロパティ値

string

skip

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

skip?: number

プロパティ値

number

top

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

top?: number

プロパティ値

number

vectorSearchOptions

ベクター検索クエリのオプションを定義します

vectorSearchOptions?: VectorSearchOptions<TModel>

プロパティ値

VectorSearchOptions<TModel>