@@ -13,21 +13,24 @@ MongoDB Github Copilot Participant
13
13
:class: singlecol
14
14
15
15
16
- |vsce-full| includes a MongoDB Github Copilot Participant
17
- to assist in using Copilot with your MongoDB deployments. Through
18
- Copilot's chat feature, users with |vsce| can interact their MongoDB
19
- clusters and generate code with MongoDB domain-specific knowledge on top
20
- of VSCode Copilot's LLM.
16
+ |vsce-full| includes a MongoDB Github Copilot Participant to assist in
17
+ using `Github Copilot <https://github.com/features/copilot>`__ with your
18
+ MongoDB deployments. Through Github Copilot's chat feature, users with
19
+ |vsce| can interact with their MongoDB clusters and generate code with
20
+ MongoDB domain-specific knowledge on top of Github Copilot's LLM.
21
+
22
+ The MongoDB Github Copilot Participant includes MongoDB-specific
23
+ commands to assist in interacting with your deployment.
21
24
22
25
/query
23
26
------
24
27
25
- Users can use the ``/query`` command in the Copilot chat to
28
+ Users can use the ``/query`` command in the Github Copilot chat to
26
29
generate queries from a natural language against a connected MongoDB
27
- cluster. The MongoDB Participant provides underlying schema information
28
- of the relevant collections to Copilot to generate a response. If you do
29
- not specify a collection in your prompt to Copilot, the MongoDB
30
- Participant prompts you to select a relevant collection.
30
+ cluster. The MongoDB Github Copilot Participant provides underlying
31
+ schema information of the relevant collections to Github Copilot to
32
+ generate a response. If you do not specify a collection in your prompt,
33
+ the chat prompts you to select a relevant collection.
31
34
32
35
When the LLM generates a query, users can open the query in a playground
33
36
file or run the query directly in their collection.
@@ -47,18 +50,19 @@ following structure:
47
50
type: "citrus"
48
51
}
49
52
50
- Once you connet to the databse that contains the ``fruits`` collection,
51
- you can ask the Copilot chat to generate a query that finds all documents
52
- in the ``fruits`` collection that have the type ``citrus``.
53
+ Once you connect to the deployment that contains the ``fruits``
54
+ collection, you can ask the Github Copilot chat to generate a query that
55
+ finds all documents in the ``fruits`` collection that have the type
56
+ ``citrus``.
53
57
54
58
.. code-block:: javascript
55
59
:copyable: false
56
60
57
61
@MongoDB /query find all documents in the fruits collection that have
58
62
the type citrus
59
63
60
- The Github Copilot Chat uses the MongoDB Copilot Participant to generate
61
- the following query using knowledge of your database schema:
64
+ The Github Copilot Chat uses the MongoDB Github Copilot Participant to
65
+ generate the following query using knowledge of your database schema:
62
66
63
67
.. code-block:: javascript
64
68
0 commit comments