Si vous disposez d'une application de recherche qui utilise des données structurées ou des données non structurées avec des métadonnées, vous pouvez utiliser les métadonnées pour filtrer vos requêtes de recherche. Cette page explique comment utiliser les champs de métadonnées pour limiter votre recherche à un ensemble spécifique de documents.
Avant de commencer
Assurez-vous d'avoir créé une application et ingéré des données structurées ou des données non structurées avec des métadonnées. Pour en savoir plus, consultez Créer une application de recherche.
Exemple de métadonnées
Examinez cet exemple de métadonnées pour quatre fichiers PDF (document_1.pdf, document_2.pdf, document_3.pdf et document_4.pdf). Ces métadonnées se trouveraient dans un fichier JSON dans un bucket Cloud Storage, avec les fichiers PDF. Vous pouvez vous référer à cet exemple tout au long de la lecture de cette page.
{"id": "1", "structData": {"title": "Policy on accepting corrected claims", "category": ["persona_A"]}, "content": {"mimeType": "application/pdf", "uri": "gs://bucketname_87654321/data/document_1.pdf"}}
{"id": "2", "structData": {"title": "Claims documentation and reporting guidelines for commercial members", "category": ["persona_A", "persona_B"]}, "content": {"mimeType": "application/pdf", "uri": "gs://bucketname_87654321/data/document_2.pdf"}}
{"id": "3", "structData": {"title": "Claims guidelines for bundled services and supplies for commercial members", "category": ["persona_B", "persona_C"]}, "content": {"mimeType": "application/pdf", "uri": "gs://bucketname_87654321/data/document_3.pdf"}}
{"id": "4", "structData": {"title": "Advantage claims submission guidelines", "category": ["persona_A", "persona_C"]}, "content": {"mimeType": "application/pdf", "uri": "gs://bucketname_87654321/data/document_4.pdf"}}
Syntaxe des expressions de filtre
Assurez-vous de bien comprendre la syntaxe de l'expression de filtre que vous utiliserez pour définir votre filtre de recherche. La syntaxe de l'expression de filtre peut être résumée par la forme Backus-Naur étendue suivante :
# A single expression or multiple expressions that are joined by "AND" or "OR". filter = expression, { " AND " | "OR", expression }; # Expressions can be prefixed with "-" or "NOT" to express a negation. expression = [ "-" | "NOT " ], # A parenthetical expression. | "(", expression, ")" # A simple expression applying to a text field. # Function "ANY" returns true if the field exactly matches any of the literals. ( text_field, ":", "ANY", "(", literal, { ",", literal }, ")" # A simple expression applying to a numerical field. Function "IN" returns true # if a field value is within the range. By default, lower_bound is inclusive and # upper_bound is exclusive. | numerical_field, ":", "IN", "(", lower_bound, ",", upper_bound, ")" # A simple expression that applies to a numerical field and compares with a double value. | numerical_field, comparison, double # An expression that applies to a geolocation field with text/street/postal address. | geolocation_field, ":", "GEO_DISTANCE(", literal, ",", distance_in_meters, ")" # An expression that applies to a geolocation field with latitude and longitude. | geolocation_field, ":", "GEO_DISTANCE(", latitude_double, ",", longitude_double, ",", distance_in_meters, ")" # Datetime field | datetime_field, comparison, literal_iso_8601_datetime_format); # A lower_bound is either a double or "*", which represents negative infinity. # Explicitly specify inclusive bound with the character 'i' or exclusive bound # with the character 'e'. lower_bound = ( double, [ "e" | "i" ] ) | "*"; # An upper_bound is either a double or "*", which represents infinity. # Explicitly specify inclusive bound with the character 'i' or exclusive bound # with the character 'e'. upper_bound = ( double, [ "e" | "i" ] ) | "*"; # Supported comparison operators. comparison = "<=" | "<" | ">=" | ">" | "="; # A literal is any double quoted string. You must escape backslash (\) and # quote (") characters. literal = double quoted string; text_field = text field - for example, category; numerical_field = numerical field - for example, score; geolocation_field = field of geolocation data type - for example home_address, location; datetime_field = field of datetime data type - for example creation_date, expires_on; literal_iso_8601_datetime_format = either a double quoted string representing ISO 8601 datetime or a numerical field representing microseconds from unix epoch.
Rechercher à l'aide d'un filtre de métadonnées
Pour effectuer une recherche à l'aide d'un filtre de métadonnées, procédez comme suit :
Déterminez le champ de métadonnées à utiliser pour filtrer vos requêtes de recherche. Par exemple, pour les métadonnées de la section Avant de commencer, vous pouvez utiliser le champ
categorycomme filtre de recherche. Vos utilisateurs peuvent filtrer les résultats parpersona_A,persona_Boupersona_C, de sorte que leur recherche soit limitée aux documents associés au persona qui les intéresse.Rendez le champ de métadonnées indexable :
Dans la console Google Cloud , accédez à la page Gemini Enterprise et cliquez sur Applications dans le menu de navigation.
Cliquez sur votre application de recherche.
Dans le menu de navigation, cliquez sur Données.
Cliquez sur l'onglet Schéma. Cet onglet affiche les paramètres actuels des champs.
Cliquez sur Modifier.
Cochez la case Indexable pour le champ que vous souhaitez rendre indexable.
Cliquez sur Enregistrer. Pour en savoir plus, consultez Configurer les paramètres des champs.
Recherchez l'ID de votre data store. Si vous disposez déjà de l'ID de votre data store, passez à l'étape suivante.
Dans la console Google Cloud , accédez à la page Gemini Enterprise et cliquez sur Datastores dans le menu de navigation.
Cliquez sur le nom de votre datastore.
Sur la page Données de votre datastore, obtenez l'ID du datastore.
Prévisualiser les résultats de recherche
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/default_search:search" \ -d '{ "query": "QUERY", "filter": "FILTER" }'Remplacez les éléments suivants :
PROJECT_ID: par l'ID du projet.DATA_STORE_ID: ID de votre data store.QUERY: texte de la requête à rechercher.FILTER(facultatif) : Champ de texte qui vous permet de filtrer sur un ensemble de champs spécifié, à l'aide de la syntaxe d'expression de filtre. La valeur par défaut est une chaîne vide, ce qui signifie qu'aucun filtre n'est appliqué.
Par exemple, supposons que vous avez importé les quatre fichiers PDF avec des métadonnées de la section Avant de commencer. Vous souhaitez rechercher des documents contenant le mot "claims" et n'interroger que les documents dont la valeur
categoryestpersona_A. Pour ce faire, incluez les instructions suivantes dans votre appel :"query": "claims", "filter": "category: ANY(\"persona_A\")"Pour en savoir plus, consultez l'onglet "REST" de la page Prévisualiser les résultats de recherche d'une application avec des données structurées ou non structurées.
Cliquez pour voir un exemple de réponse.
Si vous effectuez une recherche comme celle de la procédure précédente, vous devriez obtenir une réponse semblable à celle-ci. Notez que la réponse inclut les trois documents dont la valeur
categoryestpersona_A.{ "results": [ { "id": "2", "document": { "name": "projects/abcdefg/locations/global/collections/default_collection/dataStores/search_store_id/branches/0/documents/2", "id": "2", "structData": { "title": "Claims documentation and reporting guidelines for commercial members", "category": [ "persona_A", "persona_B" ] }, "derivedStructData": { "link": "gs://bucketname_87654321/data/document_2.pdf", "extractive_answers": [ { "pageNumber": "1", "content": "lorem ipsum" } ] } } }, { "id": "1", "document": { "name": "projects/abcdefg/locations/global/collections/default_collection/dataStores/search_store_id/branches/0/documents/1", "id": "1", "structData": { "title": "Policy on accepting corrected claims", "category": [ "persona_A" ] }, "derivedStructData": { "extractive_answers": [ { "pageNumber": "2", "content": "lorem ipsum" } ], "link": "gs://bucketname_87654321/data/document_1.pdf" } } }, { "id": "4", "document": { "name": "projects/abcdefg/locations/global/collections/default_collection/dataStores/search_store_id/branches/0/documents/4", "id": "4", "structData": { "title": "Advantage claims submission guidelines", "category": [ "persona_A", "persona_C" ] }, "derivedStructData": { "extractive_answers": [ { "pageNumber": "47", "content": "lorem ipsum" } ], "link": "gs://bucketname_87654321/data/document_4.pdf" } } } ], "totalSize": 330, "attributionToken": "UvBRCgsI26PxpQYQs7vQZRIkNjRiYWY1MTItMDAwMC0yZWIwLTg3MTAtMTQyMjNiYzYzMWEyIgdHRU5FUklDKhSOvp0VpovvF8XL8xfC8J4V1LKdFQ", "guidedSearchResult": {}, "summary": {} }
Exemples d'expressions de filtre
Le tableau suivant fournit des exemples d'expressions de filtre.
| Filtre | Ne renvoie que les résultats pour les documents où : |
|---|---|
category: ANY(\"persona_A\") |
le champ de texte category est persona_A |
score: IN(*, 100.0e) |
Le champ numérique score est supérieur à l'infini négatif et inférieur à 100,0. |
non-smoking = \"true\" |
Le booléen non-smoking est défini sur "true". |
pet-friendly = \"false\" |
le booléen pet-friendly est faux |
manufactured_date = \"2023\" |
la manufactured date est n'importe quelle date en 2023 |
manufactured_date >= \"2024-04-16\" |
La date de manufactured_date est égale ou postérieure au 16 avril 2024. |
manufactured_date < \"2024-04-16T12:00:00-07:00\" |
La manufactured_date est fixée au 16 avril 2024 avant midi (heure avancée du Pacifique). |
office.location:GEO_DISTANCE(\"1600 Amphitheater Pkwy, Mountain View, CA, 94043\", 500) |
le champ de géolocalisation office.location se trouve à moins de 500 m du 1600 Amphitheater Pkwy |
NOT office.location:GEO_DISTANCE(\"Palo Alto, CA\", 1000) |
le champ de géolocalisation office.location ne se trouve pas dans un rayon de 1 km autour de Palo Alto, en Californie. |
office.location:GEO_DISTANCE(34.1829, -121.293, 500) |
le champ de géolocalisation office.location se trouve dans un rayon de 500 m autour de la latitude 34.1829 et de la longitude -121.293 |
category: ANY(\"persona_A\") AND score: IN(*, 100.0e) |
category est persona_A et score est inférieur à 100 |
office.location:GEO_DISTANCE(\"Mountain View, CA\", 500) OR office.location:GEO_DISTANCE(\"Palo Alto, CA\", 500) |
office.location se trouve à moins de 500 m de Mountain View ou de Palo Alto. |
(price<175 AND pet-friendly = \"true\") OR (price<125 AND pet-friendly = \"false\") |
price est inférieur à 175 et je peux amener mon animal de compagnie, ou price est inférieur à 125 et je ne peux pas amener mon animal de compagnie |
Étapes suivantes
- Pour comprendre l'impact des filtres sur la qualité de la recherche, évaluez la qualité de la recherche. Pour en savoir plus, consultez Évaluer la qualité de la recherche.