Language

SearchSpec クラス

定義

このクラスは、AppSearch の仕様ロジックを表します。

[Android.Runtime.Register("android/app/appsearch/SearchSpec", ApiSince=31, DoNotGenerateAcw=true)]
public sealed class SearchSpec : Java.Lang.Object, Android.OS.IParcelable, IDisposable
[<Android.Runtime.Register("android/app/appsearch/SearchSpec", ApiSince=31, DoNotGenerateAcw=true)>]
type SearchSpec = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
継承
SearchSpec
属性
実装

注釈

このクラスは、AppSearch の仕様ロジックを表します。 プレフィックスや正確な検索のみなど、検索の種類を設定したり、フィルターを適用して特定のスキーマの種類のみを検索したりするために使用できます。

Javaドキュメント。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。

フィールド

Name 説明
EmbeddingSearchMetricTypeCosine
古い.

検索とランク付けを埋め込むためのメトリックとしてのコサインの類似性。

EmbeddingSearchMetricTypeDefault
古い.

検索とランク付けを埋め込むには、 SearchSpec#getDefaultEmbeddingSearchMetricType() の既定のメトリック セットを使用します。

EmbeddingSearchMetricTypeDotProduct
古い.

検索とランク付けを埋め込むためのメトリックとしてのドット積の類似性。

EmbeddingSearchMetricTypeEuclidean
古い.

検索とランク付けを埋め込むためのメトリックとしてのユークリッド距離。

GroupingTypePerNamespace
古い.

名前空間ごとに返される結果の数に制限を適用するために、結果を名前空間ごとにグループ化する必要があります。

GroupingTypePerPackage
古い.

パッケージごとに返される結果の数に制限を適用するために、結果をパッケージごとにグループ化する必要があります。

GroupingTypePerSchema
古い.

スキーマの種類ごとに返される結果の数に制限を適用するために、結果をスキーマの種類ごとにグループ化する必要があります。

OrderAscending
古い.

検索結果は昇順で返されます。

OrderDescending
古い.

検索結果は降順で返されます。

ProjectionSchemaTypeWildcard

独自の特定のプロパティ パスが設定されている型を除き、すべての結果にプロパティ パスを適用するために、 SearchSpec.Builder#addProjection で使用されるスキーマ型。

RankingStrategyAdvancedRankingExpression
古い.

指定された高度なランク付け式によってランク付けされます。

RankingStrategyCreationTimestamp
古い.

ドキュメント作成タイムスタンプでランク付けされます。

RankingStrategyDocumentScore
古い.

アプリが提供するドキュメント スコアによってランク付けされます。

RankingStrategyJoinAggregateScore
古い.

結合されたドキュメントの集計されたランク付けシグナルによってランク付けされます。

RankingStrategyNone
古い.

順位なし。結果は任意の順序で返されます。

RankingStrategyRelevanceScore
古い.

ドキュメントの関連性スコアでランク付けされます。

RankingStrategySystemUsageCount
古い.

システム UI サーフェイスからの使用状況の数でランク付けされます。

RankingStrategySystemUsageLastUsedTimestamp
古い.

システム UI サーフェイスからの最後の使用状況のタイムスタンプでランク付けされます。

RankingStrategyUsageCount
古い.

アプリによって報告された使用量の数でランク付けされます。

RankingStrategyUsageLastUsedTimestamp
古い.

アプリによって報告された、前回の使用状況のタイムスタンプでランク付けされます。

SchemaTypeWildcard

SearchSpec.Builder#addFilterProperties(String, Collection)およびSearchSpec.Builder#addProjectionで使用されるスキーマ型は、独自の特定のプロパティ パスが設定されている型を除き、すべての結果にプロパティ パスを適用します。

TermMatchExactOnly
古い.

クエリ用語は、インデックス内の正確なトークンにのみ一致します。

TermMatchPrefix
古い.

クエリ用語がトークンのプレフィックスである場合、クエリ用語はインデックス付きトークンと一致します。

プロパティ

Name 説明
AdvancedRankingExpression

高度なランク付け式を取得します。 Builder#setRankingStrategy(String) が呼び出されなかった場合は "" を取得します。

Class

この Objectのランタイム クラスを返します。

(継承元 Object)
Creator

このクラスは、AppSearch の仕様ロジックを表します。

DefaultEmbeddingSearchMetricType

埋め込み検索 ( AppSearchSession#searchを参照) とランク付けに使用される既定の埋め込みメトリックの種類を返します ( SearchSpec.Builder#setRankingStrategy(String)を参照)。

EmbeddingParameters

"getEmbeddingParameter({index})" 関数を使用してクエリで参照できる EmbeddingVector の一覧を返します。

FilterDocumentIds

検索対象のドキュメント ID の一覧を返します。

FilterNamespaces

検索対象の名前空間の一覧を返します。

FilterPackageNames

検索対象のパッケージ名フィルターの一覧を返します。

FilterProperties

検索対象のスキーマおよびターゲット プロパティのマップを返します。

FilterSchemas

検索するスキーマ型の一覧を返します。

Handle

基になる Android インスタンスへのハンドル。

(継承元 Object)
InformationalRankingExpressions

情報ランク付け式を返します。

IsListFilterHasPropertyFunctionEnabled

LIST_FILTER_HAS_PROPERTY_FUNCTION機能が有効になっているかどうかを返します。

IsListFilterMatchScoreExpressionFunctionEnabled

LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION機能が有効になっているかどうかを返します。

IsListFilterQueryLanguageEnabled

LIST_FILTER_QUERY_LANGUAGE機能が有効になっているかどうかを返します。

IsNumericSearchEnabled

NUMERIC_SEARCH機能が有効になっているかどうかを返します。

IsScorablePropertyRankingEnabled

ScorablePropertyRanking 機能が有効になっているかどうかを返します。

IsVerbatimSearchEnabled

VERBATIM_SEARCH機能が有効になっているかどうかを返します。

JniIdentityHashCode

相互運用ランタイムによってこのJava ピアに割り当てられた ID ハッシュ コードを取得します。

(継承元 Object)
JniManagedPeerState

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
JniPeerMembers

このクラスは、AppSearch の仕様ロジックを表します。

JoinSpec

ドキュメントを結合する必要がある指定を返します。

MaxSnippetSize

スニペットの最大サイズを文字で返します。

Order

返された検索結果の順序を返します (降順または昇順)。

PeerReference

このJava ピアの JNI オブジェクト参照を取得します。

(継承元 Object)
ProjectionPaths

スキーマ型からプロジェクションに使用するプロパティ パスへのマップを返します。

Projections

スキーマ型からプロジェクションに使用するプロパティ パスへのマップを返します。

PropertyWeightPaths

スコアリングに使用するプロパティの重みを返します。

PropertyWeights

スコアリングに使用するプロパティの重みを返します。

RankingStrategy

ランク付け戦略を返します。

ResultCountPerPage

結果セット内の 1 ページあたりの結果の数を返します。

ResultGroupingLimit

各グループに対して返される結果の最大数を取得します。

ResultGroupingTypeFlags

適用するグループ化制限の種類を取得します。 Builder#setResultGrouping が呼び出されなかった場合は 0 を取得します。

SearchSourceLogTag

この検索のソースを示すタグを取得するか、nullが呼び出されなかった場合にBuilder#setSearchSourceLogTag(String)します。

SearchStringParameters

"getSearchStringParameter({index})" 関数を使用してクエリで参照できる文字列パラメーターの一覧を返します。

SnippetCount

スニペットを生成するドキュメントの数を返します。

SnippetCountPerProperty

スニペットを生成する一致するドキュメントの各プロパティの一致数を返します。

TermMatch

クエリ用語がインデックス内の用語と一致する方法を返します。

ThresholdClass

この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。

(継承元 Object)
ThresholdType

この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。

(継承元 Object)

メソッド

Name 説明
Clone()

このオブジェクトのコピーを作成して返します。

(継承元 Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
DescribeContents()

この Parcelable インスタンスのマーシャリングされた表現に含まれる特殊なオブジェクトの種類について説明します。

Dispose()

このJava ピアによって保持されているリソースを解放します。

(継承元 Object)
Dispose(Boolean)

このJava ピアによって保持されているリソースを解放します。

(継承元 Object)
DisposeUnlessReferenced()

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
Equals(Object)

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
Equals(Object)

他のオブジェクトがこのオブジェクトと "等しい" かどうかを示します。

(継承元 Object)
GetHashCode()

オブジェクトのハッシュ コード値を返します。

(継承元 Object)
JavaFinalize()
古い.

オブジェクトへの参照がなくなったとガベージ コレクションによって判断されたときに、オブジェクトのガベージ コレクターによって呼び出されます。

(継承元 Object)
Notify()

このオブジェクトのモニターで待機している 1 つのスレッドを起動します。

(継承元 Object)
NotifyAll()

このオブジェクトのモニターで待機しているすべてのスレッドを起動します。

(継承元 Object)
SetHandle(IntPtr, JniHandleOwnership)

Handle プロパティを設定します。

(継承元 Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
ShouldRetrieveEmbeddingMatchInfos()

埋め込み一致情報を一部として取得するかどうかを返します。 SearchResult#getMatchInfos()

ToArray<T>()

このJava配列ラッパーからマネージド配列を作成します。

(継承元 Object)
ToString()

オブジェクトの文字列形式を返します。

(継承元 Object)
UnregisterFromRuntime()

相互運用ランタイムからこのJava ピアの登録を解除します。

(継承元 Object)
Wait()

現在のスレッドが起動するまで待機します。通常は、 <em>notified</em> または <em>interrupted</em>。

(継承元 Object)
Wait(Int64, Int32)

現在のスレッドは、通常、 <em>notified</em> または <em>interrupted</em>、または一定のリアルタイムが経過するまで、起動されるまで待機します。

(継承元 Object)
Wait(Int64)

現在のスレッドは、通常、 <em>notified</em> または <em>interrupted</em>、または一定のリアルタイムが経過するまで、起動されるまで待機します。

(継承元 Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

このオブジェクトをパーセルにフラット化します。

明示的なインターフェイスの実装

Name 説明
IJavaPeerable.Disposed()

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
IJavaPeerable.Finalized()

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

このクラスは、AppSearch の仕様ロジックを表します。

(継承元 JavaObject)
IJavaPeerable.UnregisterFromRuntime()

このクラスは、AppSearch の仕様ロジックを表します。

拡張メソッド

Name 説明
GetJniTypeName(IJavaPeerable)

インスタンス selfの型の JNI 名を取得します。

JavaAs<TResult>(IJavaPeerable)

selfを強制的にTResult入力し、強制型がJava側で有効であることを確認します。

JavaCast<TResult>(IJavaObject)

Android ランタイムチェック型変換を実行します。

JavaCast<TResult>(IJavaObject)

このクラスは、AppSearch の仕様ロジックを表します。

TryJavaCast<TResult>(IJavaPeerable, TResult)

selfを強制的にTResult入力し、強制型がJava側で有効であることを確認します。

適用対象