AppSearchSession.Search(String, SearchSpec) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定されたクエリ文字列と指定された検索の種類に一致する、開いている AppSearchSession からドキュメントを取得します。
[Android.Runtime.Register("search", "(Ljava/lang/String;Landroid/app/appsearch/SearchSpec;)Landroid/app/appsearch/SearchResults;", "", ApiSince=31)]
public Android.App.AppSearch.SearchResults Search(string queryExpression, Android.App.AppSearch.SearchSpec searchSpec);
[<Android.Runtime.Register("search", "(Ljava/lang/String;Landroid/app/appsearch/SearchSpec;)Landroid/app/appsearch/SearchResults;", "", ApiSince=31)>]
member this.Search : string * Android.App.AppSearch.SearchSpec -> Android.App.AppSearch.SearchResults
パラメーター
- queryExpression
- String
検索するクエリ文字列。
- searchSpec
- SearchSpec
ドキュメント フィルターの設定、プロジェクションの追加、用語の一致の種類の設定などの仕様。
戻り値
一致したドキュメントを取得するための SearchResults オブジェクト。
- 属性
注釈
指定されたクエリ文字列と指定された検索の種類に一致する、開いている AppSearchSession からドキュメントを取得します。
クエリ文字列は、空、演算子なしの 1 つの用語、または複数の用語と演算子を含めることができます。
空のクエリ文字列の場合、 SearchSpec に一致するすべてのドキュメントが返されます。
1 つの用語を持ち、演算子を持たないクエリ文字列の場合、指定されたクエリ文字列と SearchSpec に一致するドキュメントが返されます。
次の演算子がサポートされています。
<ul><li>AND (暗黙的)
AND は、 指定されたすべての 用語を含むドキュメントに一致する演算子です。
<b>NOTE:</b> 用語間のスペースは、"AND" 演算子として扱われます。 クエリ文字列に "AND" を明示的に含めると、"AND" が用語として扱われ、"AND" も含まれるドキュメントが返されます。
例: "apple AND banana" は、"apple"、"and"、"banana" という用語を含むドキュメントと一致します。
例: "apple banana" は、"apple" と "banana" の両方を含むドキュメントと一致します。
例: "apple banana cherry" は、"apple"、"banana"、"cherry" を含むドキュメントと一致します。 <li>OR
OR は 、指定された 用語を含むドキュメントに一致する演算子です。
例: "apple OR banana" は、"apple" または "banana" を含むドキュメントと一致します。
例: "apple OR banana OR cherry" は、"apple"、"banana"、または "cherry" のいずれかを含むドキュメントと一致します。 <li>Exclusion (-)
除外 (-) は、指定された用語を含 まない ドキュメントと一致する演算子です。
例: "-apple" は、"apple" を含まないドキュメントと一致します。 <li>グループ化された使用条件
複数の演算子と用語を必要とするクエリでは、用語をサブクエリにグループ化できます。 サブクエリは、開いている "(" と close ")" のかっこ内に含まれています。
例: "(ドーナツ OR ベーグル) (コーヒー OR ティー)" は、"donut" または "bagel" と "coffee" または "tea" を含むドキュメントと一致します。 <li>Property Restricts
ドキュメントの特定の AppSearchSchema プロパティと一致する用語を必要とするクエリの場合は、プロパティ名と用語の間に ":" を含める必要があります。
例: "subject:important" は、"subject" プロパティに "important" という用語を含むドキュメントと一致します。 </ul>
上記の説明では、AppSearch のすべてのバージョンでサポートされているクエリ演算子について説明します。 その他の演算子とその必要な機能については、以下で説明します。
LIST_FILTER_QUERY_LANGUAGE: この機能では、リスト フィルター言語の定義に準拠するクエリ言語の拡張について説明します (https://aip.dev/160). これには、以下のことが含まれます。
<ul><li>明示的な 'AND' 演算子と 'NOT' 演算子の追加 <li>プロパティ制限は、グループ化 (例: "prop:(a OR b)") <li>一致する </ul を制御するカスタム関数の追加>
この機能の対象となる新しく追加されたカスタム関数は次のとおりです。
<ul><li>createList(String...) <li>search(String, List<String>) <li>propertyDefined(String) </ul>
createList は、可変数の文字列を受け取り、文字列のリストを返します。 検索で使用します。
検索では、サポートされているクエリ言語に従って解析されるクエリ文字列と、制限するプロパティを指定する文字列の省略可能なリストを受け取ります。 これは、複数のプロパティ制限の利便性として存在します。 そのため、たとえば、クエリ '(subject:foo OR body:foo) (subject:bar OR body:bar)' を 'search("foo bar", createList("subject", "body")) として書き換えることができます。
propertyDefined は、対象のプロパティを指定する文字列を受け取り、指定されたプロパティを定義する任意の型のすべてのドキュメントと一致します (例: 'propertyDefined("sender.name")')。 propertyDefined は、ドキュメントの型で指定されたプロパティが定義されている限り一致します。 以下の "hasProperty" 関数とは異なり、この関数では、ドキュメントがこのプロパティの値を実際に保持する必要はありません。
NUMERIC_SEARCH: この機能では、数値検索式について説明します。 クエリ言語では、 AppSearchSchema.LongPropertyConfig#INDEXING_TYPE_RANGE 設定されているプロパティの値を数値検索式 (プロパティ、サポートされている比較子、整数値) と照合できます。 サポートされるコンパレータは、 <、 <=、=、 >= および >です。
Ex. 'price < 10' は、価格プロパティの数値が 10 未満のすべてのドキュメントと一致します。
VERBATIM_SEARCH: この機能では、逐語的な文字列演算子 (引用符) について説明します。
Ex. '"foo/bar" OR baz' は、'foo/bar' が単一の 'verbatim' トークンとして扱われることを保証します。
LIST_FILTER_HAS_PROPERTY_FUNCTION: この機能では、対象のプロパティを指定する文字列を受け取り、このプロパティの値を保持するすべてのドキュメントと一致するクエリ式の "hasProperty" 関数について説明します。 ドキュメント自体にこのプロパティがあるかどうかではなく、ドキュメントのスキーマでプロパティが定義されているかどうかをチェックする "propertyDefined" 関数と混同しないでください。
Ex. 'foo hasProperty("sender.name")' は、"foo" という用語を持ち、プロパティ "sender.name" に値を持つすべてのドキュメントを返します。 省略可能なプロパティ "sender.name" を持つ同じスキーマの documentA と documentB の 2 つのドキュメントを検討してください。 documentA がこのプロパティに "foo" を設定しても documentB が設定しない場合、'hasProperty("sender.name")' は documentA にのみ一致します。 ただし、値が実際に設定されているかどうかに関係なく、'propertyDefined("sender.name")' は documentA と documentB の両方に一致します。
LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION: この機能では、クエリ式の "matchScoreExpression" 関数について説明します。
使用法: matchScoreExpression({score_expression}, {low}, {high})
<ul><li>matchScoreExpression は、指定した範囲内のスコアを持つすべてのドキュメントに一致します。 これらのスコアは、指定されたスコア式を使用して計算されます。これは、 SearchSpec.Builder#setRankingStrategy(String)で定義されている構文に従います。
<li>"score_expression" は、スコア式を指定する文字列値です。
<li>"low" と "high" は、スコア範囲を指定する浮動小数点数です。 "high" パラメーターは省略可能です。指定しない場合、既定では正の無限大になります。
</ul>
Ex. 'matchScoreExpression("this.documentScore()", 3, 4)' は、ドキュメント スコアが 3 から 4 のすべてのドキュメントを返します。
SCHEMA_EMBEDDING_PROPERTY_CONFIG: この機能では、セマンティック検索に使用されるクエリ式の "semanticSearch" 関数と "getEmbeddingParameter" 関数について説明します。
使用法: semanticSearch(getEmbeddingParameter({embedding_index}), {low}, {high}, {metric})
<ul><li>semanticSearch は、少なくとも 1 つの埋め込みベクターを持つすべてのドキュメントに一致するモデルシグネチャ ( EmbeddingVector#getModelSignature() 参照) と、指定されたメトリックに基づいて指定された範囲内の類似性スコアを照合します。
<li>getEmbeddingParameter({embedding_index}) は、指定されたインデックス (0 から始まる) に基づいて、 SearchSpec.Builder#addEmbeddingParameters で渡された埋め込み検索を取得します。
<li>"low" と "high" は、類似性スコア範囲を指定する浮動小数点数です。 省略すると、既定では負の無限大と正の無限大になります。
<li>"metric" は、埋め込みの類似性を計算する方法を指定する文字列値です。 省略すると、既定値は SearchSpec.Builder#setDefaultEmbeddingSearchMetricType(int) で指定されたメトリックになります。 使用できる値: <ul><li>"COSINE" <li>"DOT_PRODUCT" <li>"EUCLIDEAN" </ul></ul>
例:
<ul><li>Basic: semanticSearch(getEmbeddingParameter(0), 0.5, 1, "COSINE") <li> property restriction: property1:semanticSearch(getEmbeddingParameter(0), 0.5, 1) <li>Hybrid: foo OR semanticSearch(getEmbeddingParameter(0), 0.5, 1) <li>Complex: (foo OR semanticSearch(getEmbeddingParameter(0), 0.5, 1)) AND bar </ul>
SEARCH_SPEC_SEARCH_STRING_PARAMETERS: この機能では、クエリ式の "getSearchStringParameter" 関数について説明します。この関数は、 SearchSpec.Builder#addSearchStringParameters の同じインデックスで指定された文字列をプレーン テキストとしてクエリに置き換えます。 その後、この文字列はセグメント化され、正規化され、句読点のみのセグメントが削除されます。 残りのトークンは一緒に AND になります。 この関数は、ユーザー入力を提供するが、ユーザー入力がクエリ演算子を呼び出さないことを確認する呼び出し元に役立ちます。
使用法: getSearchStringParameter({search_parameter_strings_index})
Ex. 'foo OR getSearchStringParameter(0)' と {"bar OR baz." を返 SearchSpec#getSearchStringParameters 。 文字列 "bar OR baz" です。 は、"bar"、"OR"、"baz"、"."にセグメント化されます。 句読点が削除され、セグメントは "bar"、"or"、"baz" に正規化されます。 このクエリは'foo OR (bar AND または AND baz)' と同じです。
AppSearchSchema型によるフィルター処理やプロジェクションの追加など、追加の検索仕様は、対応するSearchSpec.Builderセッターを呼び出すことによって設定できます。
このメソッドは軽量です。 重い作業は SearchResults#getNextPageで行われます。
このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。