Esta página proporciona orientación sobre cómo generar queries en MongoDB para sus datos a partir de lenguaje natural usando un gran modelo de lenguaje (LLM).
Por ejemplo, considera la siguiente query en lenguaje natural para generar una query en mongosh para la base de datos sample_mflix:
Dada la siguiente query en lenguaje natural: | Esto genera el siguiente código |
Métodos disponibles
Además de usar LLM de fábrica, puede utilizar las siguientes herramientas compiladas por MongoDB para generar queries de MongoDB a partir de lenguaje natural:
Selección de un modelo
Los modelos que funcionan bien en tareas generales normalmente también funcionan bien en la generación de query de MongoDB. Al seleccionar un LLM para generar MongoDB queries, consulta puntos de referencia populares como MMLU-Pro y Chatbot Arena ELO para evaluar el rendimiento entre modelos.
Prompts eficaces
En esta sección, se describen estrategias eficaces para pedir a un LLM que genere queries de MongoDB.
Las herramientas de MongoDB que generan queries para usted, como la habilidad de agente Natural Language Querying, utilizan las mismas entradas descritas en esta sección — los esquemas de su colección, los documentos de muestra y la información del índice — para generar queries precisas y optimizadas.
Nota
Las siguientes estrategias de prompting se basan en benchmarks creados por MongoDB. Para aprender más, consultar nuestro benchmark público de lenguaje natural a mongosh código en Hugging Face.
Prompt base
Su prompt base, también llamado prompt del sistema, debe ofrecer una visión general clara de su tarea, incluyendo lo siguiente:
El tipo de query a generar.
Información sobre la estructura de salida prevista, como el lenguaje del controlador o la herramienta que ejecuta el query.
El siguiente ejemplo de prompt base demuestra cómo generar una operación de lectura de MongoDB o una agregación para mongosh:
You are an expert data analyst experienced at using MongoDB.Your job is to take information about a MongoDB database plus a natural language query and generate a MongoDB shell (mongosh) query to execute to retrieve the information needed to answer the natural language query.
Format the mongosh query in the following structure:
db.<collection name>.find({/* query */}) or db.<collection name>.aggregate([/* query */])
Return only the executable mongosh code. Do not include explanations, markdown, or code fences in your answer.Orientación general
Para mejorar la calidad de las queries, agregue la siguiente orientación a su mensaje base para proporcionarle al modelo consejos habituales para generar queries efectivas de MongoDB:
Some general query-authoring tips:
Ensure proper use of MongoDB operators ($eq, $gt, $lt, etc.) and data types (ObjectId, ISODate) For complex queries, use aggregation pipeline with proper stages ($match, $group, $lookup, etc.) Consider performance by utilizing available indexes, avoiding $where and full collection scans, and using covered queries where possible Include sorting (.sort()) and limiting (.limit()), when appropriate, for result set management Handle null values and existence checks explicitly with $exists and $type operators to differentiate between missing fields, null values, and empty arrays Do not include null in results objects in aggregation, e.g. do not include _id: null For date operations, NEVER use an empty new date object (e.g. new Date()). ALWAYS specify the date, such as new Date("2024-10-24"). For Decimal128 operations, prefer range queries over exact equality When querying arrays, use appropriate operators like $elemMatch for complex matching, $all to match multiple elements, or $size for array length checksCadena de pensamiento
Se puede solicitar al modelo que "piense en voz alta" antes de generar la respuesta para mejorar la calidad de la respuesta. Esta técnica, denominada cadena de pensamiento prompting, mejora el rendimiento pero aumenta el tiempo de generación y los costos.
Para que el modelo piense paso a paso antes de generar el query, añada el siguiente texto a su prompt base:
Think step by step about the code in the answer before providing it. In your thoughts, consider: Which collections are relevant to the query. Which query operation to use (find vs aggregate) and what specific operators ($match, $group, $project, etc.) are needed. What fields are relevant to the query. Which indexes you can use to improve performance. What specific transformations or projections are required. What data types are involved and how to handle them appropriately (ObjectId, Decimal128, Date, etc.). What edge cases to consider (empty results, null values, missing fields). How to handle any array fields that require special operators ($elemMatch, $all, $size). Any other relevant considerations.Incluir documentos de muestra
Para mejorar significativamente la calidad del query, incluya algunos documentos de muestra representativos de su colección. Dos o tres documentos representativos suelen proporcionar al modelo suficiente contexto sobre la estructura de los datos.
Al proporcionar documentos de muestra, siga estas directrices:
Utilice la función BSON.EJSON.serialize() a fin de convertir documentos BSON a strings EJSON para el prompt.
Trunque campos largos u objetos profundamente anidados.
Excluya valores de strings largas.
Para arreglos grandes, como las incrustaciones vectoriales, incluya solo unos pocos elementos.
Mejores prácticas
Aplique las siguientes mejores prácticas de creación de prompts para casos de uso específicos al generar queries de MongoDB a partir de lenguaje natural.
Incluir información del índice
Incluya índices de colección en su prompt para que el LLM genere queries de mayor rendimiento. Los controladores de MongoDB y mongosh proporcionan métodos para obtener información sobre los índices. Por ejemplo, el controlador de Node.js proporciona el método listIndexes() para obtener índices para su prompt.
Queries basadas en tiempo
La mayoría de las herramientas LLM incluyen la fecha en su prompt del sistema. Sin embargo, si se utiliza un LLM listo para usar, el modelo no conoce la fecha ni la hora actuales. Por lo tanto, al trabajar con modelos base o al crear el propio lenguaje natural para herramientas de MongoDB, se debe incluir la fecha más reciente en el prompt. Se debe usar el método del lenguaje de programación para obtener la fecha actual como una string, como new Date().toString() de JavaScript o str(datetime.now()) de Python.
Esquemas de bases de datos anotados
Incluya esquemas anotados de colecciones relevantes de bases de datos en su prompt. Si bien ningún método de representación funciona mejor para todos los LLM, algunos son más efectivos que otros.
Recomendamos representar las colecciones utilizando tipos nativos del lenguaje de programación que describan la estructura de los datos, como los tipos de TypeScript, los modelos de Pydantic de Python o las estructuras de Go. Si utiliza MongoDB desde estos lenguajes, probablemente ya tenga definida la estructura de los datos. Para guiar al LLM y reducir la ambigüedad, añada comentarios al prompt para describir cada campo.
El siguiente ejemplo muestra un tipo de TypeScript para la colección sample_mflix.movies:
Prompt Template
El siguiente ejemplo demuestra un prompt completo utilizando las estrategias descritas en esta página para generar mongosh código a partir del lenguaje natural.
Ejemplo de prompt base
Utiliza el siguiente ejemplo de prompt del sistema como plantilla para tus tareas de generación de query en MongoDB. El mensaje de muestra incluye los siguientes componentes:
Descripción general de la tarea y formato de salida esperado
Guía general para la redacción de queries de MongoDB
You are an expert data analyst experienced at using MongoDB.Your job is to take information about a MongoDB database plus a natural language query and generate a MongoDB shell (mongosh) query to execute to retrieve the information needed to answer the natural language query.
Format the mongosh query in the following structure:
db.<collection name>.find({/* query */}) or db.<collection name>.aggregate([/* query */])
Return only the executable mongosh code. Do not include explanations, markdown, or code fences in your answer.
Some general query-authoring tips:
Ensure proper use of MongoDB operators ($eq, $gt, $lt, etc.) and data types (ObjectId, ISODate). For complex queries, use aggregation pipeline with proper stages ($match, $group, $lookup, etc.). Consider performance by utilizing available indexes, avoiding $where and full collection scans, and using covered queries where possible. Include sorting (.sort()) and limiting (.limit()) when appropriate for result set management. Handle null values and existence checks explicitly with $exists and $type operators to differentiate between missing fields, null values, and empty arrays. Do not include null in results objects in aggregation, e.g. do not include _id: null. For date operations, NEVER use an empty new date object (e.g. new Date()). ALWAYS specify the date, such as new Date("2024-10-24"). Use the provided 'Latest Date' field to inform dates in queries. For Decimal128 operations, prefer range queries over exact equality. When querying arrays, use appropriate operators like $elemMatch for complex matching, $all to match multiple elements, or $size for array length checks.Nota
También se podría añadir el indicador de cadena de pensamiento para fomentar el pensamiento paso a paso antes de la generación del código.
Ejemplos de pocos disparos
Considera añadir de uno a tres ejemplos de query de lenguaje natural y sus query mongosh correspondientes a tu prompt. Los ejemplos que se asemejan a la query que desea generar proporcionan al modelo un patrón a seguir y pueden mejorar la calidad de la query, especialmente para modelos con menos conocimientos específicos de MongoDB.
Include one to three examples of natural language queries and their corresponding mongosh queries. Examples that resemble your query give the model a pattern to follow.
Example 1
Natural language query: Show me the genres and runtime of 10 movies from 2015 that have the most comments
mongosh:
shdb.movies.aggregate([ { $match: { year: 2015 } }, { $sort: { num_mflix_comments: -1 } }, { $limit: 10 }, { $project: { _id: 0, genres: 1, runtime: 1 } },]);
Example 2
Natural language query: List the titles and release years of 5 sci-fi movies from 2010
mongosh:
shdb.movies.find( { year: 2010, genres: "Sci-Fi" }, { title: 1, year: 1, _id: 0 }).limit(5);
Example 3
Natural language query: Which movies were released between 1990 and 2000, newest first?
mongosh:
shdb.movies.find({ year: { $gte: 1990, $lte: 2000 } }).sort({ year: -1 });Plantilla de mensaje de usuario
Se puede utilizar la siguiente plantilla de mensaje de usuario para proporcionar al modelo el contexto necesario sobre la base de datos y la query deseada:
Generate MongoDB Shell (mongosh) queries for the following database and natural language query:
Database Information
Name: {{Database name}}Description: {{database description}}Latest Date: {{latest date}} (use this to inform dates in queries)
Collections
Collection {{collection name. Do for each collection you want to query over}}Description: {{collection description}}
Schema:{{interpreted or annotated schema here}}
Example documents:{{truncated example documents here}}
Indexes:{{collection index descriptions here}}
Natural language query: {{Natural language query here}}