語言

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 文件 android.app.appsearch.SearchSpec。

本頁部分內容為基於 Open Source Project 所創建與分享的作品,並依授權條款所描述的使用進行修改。

欄位

名稱 Description
EmbeddingSearchMetricTypeCosine
已淘汰.

餘弦相似度作為嵌入搜尋與排名的指標。

EmbeddingSearchMetricTypeDefault
已淘汰.

使用預設 SearchSpec#getDefaultEmbeddingSearchMetricType() 的指標來嵌入搜尋和排名。

EmbeddingSearchMetricTypeDotProduct
已淘汰.

點積相似度作為嵌入搜尋與排名的指標。

EmbeddingSearchMetricTypeEuclidean
已淘汰.

歐幾里得距離作為嵌入搜尋與排名的度量。

GroupingTypePerNamespace
已淘汰.

結果應依命名空間分組,以限制每個命名空間回傳的結果數量。

GroupingTypePerPackage
已淘汰.

結果應依套件分組,以限制每個套件回傳的結果數量。

GroupingTypePerSchema
已淘汰.

結果應依結構類型分組,以限制每個結構類型回傳的結果數量。

OrderAscending
已淘汰.

搜尋結果將依升序返回。

OrderDescending
已淘汰.

搜尋結果將依降序返回。

ProjectionSchemaTypeWildcard

架構類型 SearchSpec.Builder#addProjection 用於對所有結果套用屬性路徑,唯獨不包含那些有自己特定屬性路徑的類型。

RankingStrategyAdvancedRankingExpression
已淘汰.

排名依據提供的高級排名表達式。

RankingStrategyCreationTimestamp
已淘汰.

依文件建立時間戳記排序。

RankingStrategyDocumentScore
已淘汰.

依照應用程式提供的文件分數排名。

RankingStrategyJoinAggregateScore
已淘汰.

依據合併文件的彙整排名訊號排序。

RankingStrategyNone
已淘汰.

無排名,結果以任意順序返回。

RankingStrategyRelevanceScore
已淘汰.

依文件相關性分數排名。

RankingStrategySystemUsageCount
已淘汰.

依系統介面表面的使用次數排名。

RankingStrategySystemUsageLastUsedTimestamp
已淘汰.

依系統介面表面最後使用時間戳排序。

RankingStrategyUsageCount
已淘汰.

依應用程式報告的使用次數排名。

RankingStrategyUsageLastUsedTimestamp
已淘汰.

依據應用程式回報的最後使用時間戳記排名。

SchemaTypeWildcard

架構型別用於 SearchSpec.Builder#addFilterProperties(String, Collection) 並 SearchSpec.Builder#addProjection 套用屬性路徑,適用於所有結果,唯獨不包含特定屬性路徑的類型除外。

TermMatchExactOnly
已淘汰.

查詢詞只會匹配索引中完全相同的代幣。

TermMatchPrefix
已淘汰.

當查詢詞是該索引詞的前綴時,查詢詞會與索引詞匹配。

屬性

名稱 Description
AdvancedRankingExpression

取得進階排名表達式,或如果 Builder#setRankingStrategy(String) 未被叫到的話「」。

Class

回傳此 Object的執行時類別。

(繼承來源 Object)
Creator

SearchSpec 的創建類別。

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 對等端的身份雜湊碼。

(繼承來源 Object)
JniManagedPeerState

此類別代表 AppSearch 的規格邏輯。

(繼承來源 JavaObject)
JniPeerMembers

取得用於存取此 Java 綁定成員的 JNI 元資料。

JoinSpec

回報需要連接的文件指定。

MaxSnippetSize

回傳片段的最大字元大小。

Order

回傳搜尋結果的順序(由降向或由高到低)。

PeerReference

取得這個 Java 節點的 JNI 物件參考。

(繼承來源 Object)
ProjectionPaths

從結構型別回傳到用於投影的屬性路徑的映射。

Projections

從結構型別回傳到用於投影的屬性路徑的映射。

PropertyWeightPaths

回傳用於評分的屬性權重。

PropertyWeights

回傳用於評分的屬性權重。

RankingStrategy

返回排名策略。

ResultCountPerPage

回傳結果集中每頁的結果數。

ResultGroupingLimit

取得每組最多可回傳的結果。

ResultGroupingTypeFlags

取得適用的分組限制類型,或若 Builder#setResultGrouping 未被呼叫則為0。

SearchSourceLogTag

會獲得一個標籤來標示此搜尋的來源,或 null 是否 Builder#setSearchSourceLogTag(String) 未被呼叫。

SearchStringParameters

回傳可透過「getSearchStringParameter({index})」函式在查詢中引用的字串參數清單。

SnippetCount

回傳要產生摘要的文件數量。

SnippetCountPerProperty

回傳每個匹配文件屬性的匹配數量,以產生片段。

TermMatch

回傳查詢詞應該如何匹配索引中的詞彙。

ThresholdClass

此 API 支援 Mono for Android 基礎架構,並非直接從你的程式碼中使用。

(繼承來源 Object)
ThresholdType

此 API 支援 Mono for Android 基礎架構,並非直接從你的程式碼中使用。

(繼承來源 Object)

方法

名稱 Description
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()

喚醒一個正在該物件監視器上等待的執行緒。

(繼承來源 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>通知</><em 或 em>中斷</em> 來喚醒。

(繼承來源 Object)
Wait(Int64, Int32)

會讓目前執行緒等待喚醒,通常是透過 <em>通知</><em 或 em>中斷</em>,或是經過一定的真實時間。

(繼承來源 Object)
Wait(Int64)

會讓目前執行緒等待喚醒,通常是透過 <em>通知</><em 或 em>中斷</em>,或是經過一定的真實時間。

(繼承來源 Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

把這個物體壓扁成一個包裹。

明確介面實作

名稱 Description
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()

將此實例從執行時的 Java 物件查詢中移除。

擴充方法

名稱 Description
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 端是否有效。

適用於