Lenguaje

AppSearchSession.Search(String, SearchSpec) Método

Definición

Recupera documentos de la apertura AppSearchSession que coinciden con una cadena de consulta determinada y el tipo de búsqueda proporcionados.

[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

Parámetros

queryExpression
String

cadena de consulta que se va a buscar.

searchSpec
SearchSpec

especificación para establecer filtros de documento, agregar proyección, establecer el tipo de coincidencia de términos, etc.

Devoluciones

un SearchResults objeto para los documentos coincidentes recuperados.

Atributos

Comentarios

Recupera documentos de la apertura AppSearchSession que coinciden con una cadena de consulta determinada y el tipo de búsqueda proporcionados.

Las cadenas de consulta pueden estar vacías, contener un término sin operadores o contener varios términos y operadores.

Para las cadenas de consulta que están vacías, se devolverán todos los documentos que coincidan SearchSpec con .

En el caso de las cadenas de consulta con un solo término y ningún operador, se devolverán documentos que coincidan con la cadena de consulta proporcionada.SearchSpec

Se admiten los siguientes operadores:

<ul><li>AND (implícito)

AND es un operador que coincide con los documentos que contienen todos los términos proporcionados.

<b>NOTA:</b> Un espacio entre términos se trata como un operador "AND". La inclusión explícita de "AND" en una cadena de consulta tratará "AND" como término, devolviendo documentos que también contienen "AND".

Ejemplo: "apple AND banana" coincide con los documentos que contienen los términos "apple", "and", "banana".

Ejemplo: "plátano de manzana" coincide con documentos que contienen "manzana" y "plátano".

Ejemplo: "cereza de plátano de manzana" coincide con los documentos que contienen "manzana", "banana" y "cherry". <li>OR

OR es un operador que coincide con documentos que contienen cualquier término proporcionado.

Ejemplo: "manzana O plátano" coincide con documentos que contienen "manzana" o "plátano".

Ejemplo: "apple OR banana OR cherry" coincide con los documentos que contienen cualquiera de "manzana", "banana" o "cherry". <li>Exclusion (-)

Exclusión (-) es un operador que coincide con documentos que no contienen el término proporcionado.

Ejemplo: "-apple" coincide con documentos que no contienen "apple". <li>Grouped Terms

En el caso de las consultas que requieren varios operadores y términos, los términos se pueden agrupar en subconsultas. Las subconsultas se encuentran dentro de un paréntesis "(" y cerrar ")".

Ejemplo: "(donut OR bagel) (café O té)" coincide con documentos que contienen "donut" o "bagel" y "café" o "té". <li (>restricciones de propiedad)

En el caso de las consultas que requieren un término para que coincida con una propiedad específica AppSearchSchema de un documento, se debe incluir un valor ":" entre el nombre de propiedad y el término .

Ejemplo: "subject:important" coincide con documentos que contienen el término "importante" en la propiedad "subject". </ul>

En la descripción anterior se describen los operadores de consulta que se admiten en todas las versiones de AppSearch. A continuación se describen operadores adicionales y sus características necesarias.

LIST_FILTER_QUERY_LANGUAGE: esta característica cubre la expansión del lenguaje de consulta para ajustarse a la definición del lenguaje de filtros de lista (https://aip.dev/160). Esto incluye lo siguiente:

<Se permite la adición ul><li>de operadores <explícitos "AND" y "NOT" restricciones de propiedad li>con agrupaciones (por ejemplo, "prop:(a OR b)") <adición de li>de funciones personalizadas para controlar la coincidencia </ul>

Las funciones personalizadas recién agregadas cubiertas por esta característica son:

<ul><li>createList(String...) <li>search(String, List<String>) <li>propertyDefined(String) </ul>

createList toma un número variable de cadenas y devuelve una lista de cadenas. Se usa con la búsqueda.

search toma una cadena de consulta que se analizará según el lenguaje de consulta admitido y una lista opcional de cadenas a las que se van a restringir las propiedades. Esto existe como comodidad para varias restricciones de propiedad. Por lo tanto, por ejemplo, la consulta '(subject:foo OR body:foo) (subject:bar OR body:bar)' podría reescribirse como 'search("foo bar", createList("subject", "body"))'.

propertyDefined toma una cadena que especifica la propiedad de interés y coincide con todos los documentos de cualquier tipo que defina la propiedad especificada (por ejemplo, 'propertyDefined("sender.name")"). Tenga en cuenta que propertyDefined coincidirá siempre que el tipo del documento defina la propiedad especificada. A diferencia de la función "hasProperty" siguiente, esta función no requiere que el documento contenga realmente ningún valor para esta propiedad.

NUMERIC_SEARCH: esta característica cubre expresiones de búsqueda numéricas. En el lenguaje de consulta, los valores de las propiedades que se han AppSearchSchema.LongPropertyConfig#INDEXING_TYPE_RANGE establecido pueden coincidir con una expresión de búsqueda numérica (la propiedad, un comparador admitido y un valor entero). Los comparadores admitidos son <, <=, ==, >= y >.

Por ejemplo, 'price < 10' coincidirá con todos los documentos que tengan un valor numérico en su propiedad price que sea inferior a 10.

VERBATIM_SEARCH: esta característica cubre el operador de cadena textual (comillas).

Por ejemplo, "foo/bar" OR baz" garantizará que "foo/bar" se trate como un único token "textual".

LIST_FILTER_HAS_PROPERTY_FUNCTION: esta característica cubre la función "hasProperty" en expresiones de consulta, que toma una cadena que especifica la propiedad de interés y coincide con todos los documentos que contienen valores para esta propiedad. No debe confundirse con la función "propertyDefined", que comprueba si el esquema de un documento ha definido la propiedad, en lugar de si un propio documento tiene esta propiedad.

Por ejemplo, 'foo hasProperty("sender.name")' devolverá todos los documentos que tienen el término "foo" AND tienen valores en la propiedad "sender.name". Considere dos documentos, documentA y documentB, del mismo esquema con una propiedad opcional "sender.name". Si documentA establece "foo" en esta propiedad, pero documentB no, "hasProperty("sender.name")" solo coincidirá con documentA. Sin embargo, 'propertyDefined("sender.name")" coincidirá con documentA y documentB, independientemente de si se establece realmente un valor.

LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION: esta característica cubre la función "matchScoreExpression" en expresiones de consulta.

Uso: matchScoreExpression({score_expression}, {low}, {high})

<ul><li>matchScoreExpression coincide con todos los documentos con puntuaciones que se encuentran dentro del intervalo especificado. Estas puntuaciones se calculan mediante la expresión de puntuación proporcionada, que se adhiere a la sintaxis definida en SearchSpec.Builder#setRankingStrategy(String). <li>"score_expression" es un valor de cadena que especifica la expresión de puntuación. <li>"low" y "high" son números de punto flotante que especifican el intervalo de puntuación. El parámetro "high" es opcional; si no se proporciona, el valor predeterminado es infinito positivo. </ul>

Por ejemplo, 'matchScoreExpression("this.documentScore()", 3, 4)' devolverá todos los documentos que tienen puntuaciones de documento de 3 a 4.

SCHEMA_EMBEDDING_PROPERTY_CONFIG: esta característica cubre las funciones "semanticSearch" y "getEmbeddingParameter" en expresiones de consulta, que se usan para la búsqueda semántica.

Uso: semanticSearch(getEmbeddingParameter({embedding_index}), {low}, {high}, {metric})

<ul><li>semanticSearch coincide con todos los documentos que tienen al menos un vector de inserción con una firma de modelo coincidente (vea EmbeddingVector#getModelSignature()) y una puntuación de similitud dentro del intervalo especificado en función de la métrica proporcionada. <li>getEmbeddingParameter({embedding_index}) recupera la búsqueda de inserción pasada en SearchSpec.Builder#addEmbeddingParameters función del índice especificado, que comienza a partir de 0. <li>"low" y "high" son números de punto flotante que especifican el intervalo de puntuación de similitud. Si se omite, el valor predeterminado es infinito negativo y positivo, respectivamente. <li>"metric" es un valor de cadena que especifica cómo se deben calcular las similitudes de inserción. Si se omite, el valor predeterminado es la métrica especificada en SearchSpec.Builder#setDefaultEmbeddingSearchMetricType(int). Valores posibles: <ul><li>"COSINE" <li"DOT_PRODUCT" <li>>"EUCLIDEAN" </ul></ul>

Ejemplos:

<ul><li>Basic: semanticSearch(getEmbeddingParameter(0), 0.5, 1, "COSINE") <li>Con una restricción de propiedad: 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: esta característica cubre la función "getSearchStringParameter" en expresiones de consulta, que sustituye la cadena proporcionada en el mismo índice de SearchSpec.Builder#addSearchStringParameters la consulta como texto sin formato. A continuación, esta cadena se segmenta, normaliza y quita de segmentos de solo puntuación. A continuación, los tokens restantes son AND'd juntos. Esta función es útil para los autores de llamadas que desean proporcionar la entrada del usuario, pero quieren asegurarse de que la entrada del usuario no invoca ningún operador de consulta.

Uso: getSearchStringParameter({search_parameter_strings_index})

Por ejemplo, 'foo OR getSearchStringParameter(0)' con SearchSpec#getSearchStringParameters devolver {"bar OR baz."}. Cadena "bar OR baz". se segmentará en "bar", "OR", "baz", ".". Se quita la puntuación y los segmentos se normalizan en "bar", "or", "baz". Esta consulta será equivalente a "foo OR (bar AND o AND baz)".

Las especificaciones de búsqueda adicionales, como el filtrado por AppSearchSchema tipo o la adición de proyección, se pueden establecer llamando al establecedor correspondiente SearchSpec.Builder .

Este método es ligero. El trabajo pesado se realizará en SearchResults#getNextPage.

Java documentación para android.app.appsearch.AppSearchSession.search(java.lang.String, android.app.appsearch.SearchSpec).

Las partes de esta página son modificaciones basadas en el trabajo creado y compartido por el Android y se usan según los términos descritos en creative Creative Commons 2.5 Attribution License.

Se aplica a