SearchSpec.Builder.SetRankingStrategy メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| Name | 説明 |
|---|---|
| SetRankingStrategy(Int32) |
AppSearch の結果のランク付け戦略を設定します。 |
| SetRankingStrategy(String) |
advancedRankingExpression に基づいて高度なランク付けをスコア付けできるようにします。 |
SetRankingStrategy(Int32)
AppSearch の結果のランク付け戦略を設定します。
[Android.Runtime.Register("setRankingStrategy", "(I)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=31)]
public Android.App.AppSearch.SearchSpec.Builder SetRankingStrategy(int rankingStrategy);
[<Android.Runtime.Register("setRankingStrategy", "(I)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=31)>]
member this.SetRankingStrategy : int -> Android.App.AppSearch.SearchSpec.Builder
パラメーター
- rankingStrategy
- Int32
値は、SearchSpec.RANKING_STRATEGY_NONE SearchSpec.RANKING_STRATEGY_DOCUMENT_SCORE SearchSpec.RANKING_STRATEGY_CREATION_TIMESTAMP SearchSpec.RANKING_STRATEGY_RELEVANCE_SCORE SearchSpec.RANKING_STRATEGY_USAGE_COUNT SearchSpec.RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP SearchSpec.RANKING_STRATEGY_SYSTEM_USAGE_COUNT SearchSpec.RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP SearchSpec.RANKING_STRATEGY_JOIN_AGGREGATE_SCORE SearchSpec のいずれかです。RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION
戻り値
- 属性
注釈
AppSearch の結果のランク付け戦略を設定します。
android.app.appsearch.SearchSpec.Builder.setRankingStrategyの Android リファレンス。
このページの一部は、Androidオープンソースプロジェクトによって作成および共有された作業に基づく変更でありCreative Commons 2.5属性ライセンスに記載されている条件に従って使用されます。
適用対象
SetRankingStrategy(String)
advancedRankingExpression に基づいて高度なランク付けをスコア付けできるようにします。
[Android.Runtime.Register("setRankingStrategy", "(Ljava/lang/String;)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=34)]
public Android.App.AppSearch.SearchSpec.Builder SetRankingStrategy(string advancedRankingExpression);
[<Android.Runtime.Register("setRankingStrategy", "(Ljava/lang/String;)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=34)>]
member this.SetRankingStrategy : string -> Android.App.AppSearch.SearchSpec.Builder
パラメーター
- advancedRankingExpression
- String
ランク付け式を表す空でない文字列。 この値は null にすることはできません。
戻り値
- 属性
注釈
advancedRankingExpression に基づいて高度なランク付けをスコア付けできるようにします。 このメソッドは RankingStrategy をSearchSpec.RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSIONに設定します。 ランク付け式は、各ドキュメントのスコアを表す倍精度浮動小数点型に評価される数式です。 数値リテラル、算術演算子、数学関数、ドキュメント ベース、プロパティ値ベースの関数は、式を作成するためにサポートされています。 サポートされている算術演算子は次のとおりです。加算(+) Subtraction(-) 乗算(*) 浮動小数点除算(/) 演算子の優先順位はJava言語に準拠しており、かっこがサポートされています。 たとえば、"2.2 + (3 - 4) / 2" は 1.7 と評価されます。 サポートされている基本的な数学関数を次に示します。log(x) - x log(x, y) - 底 x pow(x, y) の y の対数 - x から y sqrt(x) abs(x) sin(x)、cos(x)、tan(x) の累乗に対する例: "max(abs(-100), 10) + pow(2, 10)" は 1124 に評価されます。次の可変数数学関数がサポートされています。 n > 0。 また、リスト値パラメーターも受け入れます。 たとえば、V がリスト型の値である場合、sum(V) を呼び出して V 内のすべての値の合計を取得できます。リスト リテラルはサポートされていないため、リスト型の値は、特定のドキュメント ベースの関数の戻り値としてのみ構築できます。 max(v1, v2,..., vn) または max(V) min(v1, v2,..., vn) または min(V) len(v1, v2,..., vn) または len(V) sum(v1, v2,..., vn) または sum(V) avg(v1, v2,..., vn) または avg(V) ドキュメントベースの関数は、スコア付けされている現在のドキュメントを表す "this" を介して呼び出す必要があります。 サポートされているドキュメント ベースの関数を次に示します。this.documentScore() 現在のドキュメントのアプリ指定のドキュメント スコアを取得します。 これは、SearchSpec.RANKING_STRATEGY_DOCUMENT_SCOREに返されるのと同じスコアです。 this.creationTimestamp() 現在のドキュメントの作成タイムスタンプを取得します。 これは、SearchSpec.RANKING_STRATEGY_CREATION_TIMESTAMPに対して返されるのと同じスコアです。 this.relevanceScore() クエリ文字列に関連して、現在のドキュメントの BM25F 関連性スコアを取得します。 これは、SearchSpec.RANKING_STRATEGY_RELEVANCE_SCOREに対して返されるのと同じスコアです。 this.usageCount(type) と this.usageLastUsedTimestamp(type) 現在のドキュメントの種類別の使用状況の数または最後の使用状況のタイムスタンプを取得します。ここで、型は 1 から 2 の整数に評価する必要があります。 型 1 は AppSearchSession.reportUsage によって報告される使用状況を表し、型 2 は GlobalSearchSession.reportSystemUsage によって報告される使用状況を指します。 this.childrenRankingSignals() 入れ子になった SearchSpec で指定されたランク付け戦略を使用して、結合されたドキュメントをスコア付けすることによって計算された子ランク付けシグナルの一覧を返します。 現在、ドキュメントは結合のコンテキスト内の別のドキュメントの子にのみできます。 Join API を有効にせずにこの関数を呼び出すと、型エラーが発生します。 this.propertyWeights() スコア付けされている現在のドキュメントの一致するプロパティの正規化された重みの一覧を返します。 プロパティの重みは、SearchSpec で指定されたものから取得されます。 正規化後、指定された各重みが最大重みで除算されるため、各重みは、embedding_indexとメトリックに基づいて AppSearchSession.search) になります。 メトリックを省略すると、既定値は SearchSpec.Builder.setDefaultEmbeddingSearchMetricType(int) で指定されたメトリックになります。 クエリのembedding_indexとメトリックに対して "semanticSearch" が呼び出されない場合、この関数は空のリストを返します。 同じembedding_indexとメトリックに対して複数の "semanticSearch" が呼び出された場合、この関数はマージされたスコアの一覧を返します。 例: 'this.matchedSemanticScores(getEmbeddingParameter(0), "COSINE") ' は、クエリ式で 'semanticSearch(getEmbeddingParameter(0), 0.5, 1, "COSINE") が呼び出された場合、[0.5, 1]の範囲内で一致したスコアのリストを返します。 プロパティ値ベースの関数は、getScorableProperty(schemaType, propertyPath) の関数を介して呼び出すことができます。この関数を使用するには、ScorablePropertyRanking 機能を SearchSpec.Builder.setScorablePropertyRankingEnabled(boolean) で有効にする必要があります。 パラメーター 'schemaType' は有効な AppSearch SchemaType である必要があります。それ以外の場合はエラーが返されます。 パラメーター 'propertyPath' は有効で、スコアリング可能である必要があります。それ以外の場合はエラーが返されます。 スコア付け可能と見なされるのは、スコアリングが有効に設定されているプロパティ、または入れ子になったスキーマ型のスコア可能なプロパティを指すプロパティです。 この関数は、一致したドキュメントのリストの double 値を返します。 一致したドキュメントのスキーマが 'schemaType' と異なる場合、または 'propertyPath' の下のプロパティに要素が保持されていない場合は、空のリストが返されます。 以下の例: "Gmail" と "Person" の 2 つのスキーマがあるとします。 "Gmail" スキーマには、スキーマの種類が "Person" のプロパティ 'recipient' があります。 高度なランク付け式では、"sum(getScorableProperty('Gmail', 'viewTimes'))" "maxOrDefault(getScorableProperty('Person', 'income'), 0)" "sum(getScorableProperty('Gmail', 'recipient.income')))" "this.documentScore() + sum(getScorableProperty('Gmail', 'viewTimes'))" 次の関数は、リスト操作を強化するために用意されています。 minOrDefault(V, default_score) リストが空の場合は、入力リスト V またはdefault_scoreの最小値を返します。 例: "minOrDefault(this.matchedSemanticScores(getEmbeddingParameter(0)), 10)" は、現在のドキュメントに一致するスコアがない場合、最小一致セマンティック スコアまたは 10 を返します。 この関数には、ERROR(/Features#SEARCH_SPEC_RANKING_FUNCTION_MAX_MIN_OR_DEFAULT) 機能が必要です。 maxOrDefault(V, default_score) リストが空の場合は、入力リスト V またはdefault_scoreの最大値を返します。 例: "maxOrDefault(this.matchedSemanticScores(getEmbeddingParameter(0)), -10)" は、現在のドキュメントに一致するスコアがない場合、一致した最大セマンティック スコアまたは -10 を返します。 この関数には、ERROR(/Features#SEARCH_SPEC_RANKING_FUNCTION_MAX_MIN_OR_DEFAULT) 機能が必要です。 filterByRange(V, low, high) 指定された範囲内にある要素のみを含む V のサブリストを返します [low, high]. 例: "filterByRange(this.matchedSemanticScores(getEmbeddingParameter(0)), 0, 1)" は、0 から 1 までの一致するセマンティック スコアの一覧を返します。 この関数には、ERROR(/Features#SEARCH_SPEC_RANKING_FUNCTION_FILTER_BY_RANGE) 機能が必要です。 高度なランク付けを使用すると、一部のエラーが発生する可能性があります。 構文エラー: 式が高度なランク付け言語の構文に違反しています。 いくつかの例を次に示します。 "1 + " - 不足しているオペランド "2 * (1 + 2))" - アンバランスかっこ "2 ^ 3" - 不明な演算子の型エラー: 式は静的な型チェックに失敗します。 いくつかの例を次に示します。 "sin(2, 3)" - sin 関数 "this.childrenRankingSignals() + 1" の引数の数が間違っています- 数値 "this.propertyWeights()" を持つリストを追加できません。式全体の最後の型をリストにすることはできません。 "max(this.propertyWeights())" "abs(this.propertyWeights())" で修正できます- abs 関数はリスト型引数 "print(2)" をサポートしていません - 不明な関数の評価エラー: 式の値の評価中にエラーが発生しました。 いくつかの例を次に示します。 "1/ 0"、"log(0)"、"1 + sqrt(-1)" - 評価 "this.usageCount(1 + 0.5)" の途中で非有限値を取得します。引数は整数であると想定します。 これは型エラーではなく、"this.documentScore()" という問題なしで "this.usageCount(1.5 + 1/2)" が成功する可能性があることに注意してください。IO エラーの場合は、評価エラー構文エラーになり、型エラーは検索全体で失敗し、SearchResults.getNextPage は AppSearchResult.RESULT_INVALID_ARGUMENT の結果コードで AppSearchException をスローします。 評価エラーが発生すると、問題のあるドキュメントが既定のスコアを受け取ります。 SearchSpec.ORDER_DESCENDINGの場合、既定のスコアは 0 になり、既定のスコアSearchSpec.ORDER_ASCENDING無限大になります。
android.app.appsearch.SearchSpec.Builder.setRankingStrategyの Android リファレンス。
このページの一部は、Androidオープンソースプロジェクトによって作成および共有された作業に基づく変更でありCreative Commons 2.5属性ライセンスに記載されている条件に従って使用されます。