DOCSP 43493 VSCode Copilot /query functionality #92
Conversation
✅ Deploy Preview for docs-mongodb-vscode ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ltran-mdb2
force-pushed
the
DOCSP-43493
branch
from
9ee97ce to
ad7a58d
Compare
source/copilot.txt
Outdated
| .. code-block:: javascript | ||
| :copyable: false | ||
|
|
||
| { |
There was a problem hiding this comment.
[question] Should we use the edu dataset for examples like this?
There was a problem hiding this comment.
I think it makes sense to do so! I changed the example to use the sample Mflix database
source/ai-data-usage.txt
Outdated
| --------------------- | ||
|
|
||
| The MongoDB Github Copilot Participant is powered by `Github Copilot <https://github.com/features/copilot>`__. | ||
| This is subject to change in the future. |
There was a problem hiding this comment.
I'm not sure if this will ever change since it is an extension for Github Copilot.
There was a problem hiding this comment.
Removed the line about changing!
source/ai-data-usage.txt
Outdated
| --------------------- | ||
|
|
||
| When you use the MongoDB Github Copilot Participant, the following | ||
| information is sent to MongoDB's backend and/or the third party AI |
There was a problem hiding this comment.
The 'third party AI provider' here refer distinct to two things:
- The LLM API exposed by Copilot itself (we theoretically use the exact same LLM that Copilot uses)
- Our docs chatbot API endpoint used by our Docs Chatbot
There was a problem hiding this comment.
Not sure if we need to be that specific, however,
There was a problem hiding this comment.
@themantissa What do you think?
There was a problem hiding this comment.
It doesn't really fit the header but I tend to like to over-provide than under so it would be good to note we augment the underlying LLM with our own docs chatbot.
source/copilot.txt
Outdated
| |vsce-full| includes a MongoDB Github Copilot Participant to assist in | ||
| using `Github Copilot <https://github.com/features/copilot>`__ with your | ||
| MongoDB deployments. Through Github Copilot's chat feature, users with | ||
| |vsce| can interact with their MongoDB clusters and generate code with |
There was a problem hiding this comment.
Let's also include that they can ask questions about their database collection schema, and ask MongoDB documentation questions that the participant will provide an answer to with specific docs URLs as a reference.
source/copilot.txt
Outdated
| When the LLM generates a query, you can open the query in a playground | ||
| file or run the query directly in your collection. | ||
|
|
||
| Example |
There was a problem hiding this comment.
Could we provide an example where we can show that users can iteratively build an aggregation with Copilot? Sent over a view of this example to you over slack!
There was a problem hiding this comment.
Done! Because adding this example requires more page space, I made the /query section a separate page so that we can add longer examples for each command without resulting in one super long page.
snooty.toml
Outdated
| cps = ":abbr:`CPS (Cloud Provider Snapshots)`" | ||
| cmk = ":abbr:`CMK (customer master key)`" | ||
| compass = "MongoDB Compass" | ||
| copilot = "MongoDB Github Copilot Participant" |
There was a problem hiding this comment.
There is a capital H in GitHub - we should correct throughout.
source/ai-data-usage.txt
Outdated
| --------------------- | ||
|
|
||
| When you use the MongoDB Github Copilot Participant, the following | ||
| information is sent to MongoDB's backend and/or the third party AI |
There was a problem hiding this comment.
It doesn't really fit the header but I tend to like to over-provide than under so it would be good to note we augment the underlying LLM with our own docs chatbot.
|
|
||
| The MongoDB Github Copilot Participant is powered by `Github Copilot <https://github.com/features/copilot>`__. | ||
|
|
||
| How Your Data is Used |
There was a problem hiding this comment.
I'd like us to make sure to run this answer by Product legal if we haven't yet. This contains what we normally include but because we get so many questions from customers it's just good to be sure we have covered our bases here. We've been primarily working with Rachael McClure - let me know if you need any assistance in getting a check here. cc @GaurabAryal
|
Thanks for your feedback @themantissa ! I added a mention of the docs chatbot and fixed the GitHub spelling error - could you take another look when you get a chance? |
DESCRIPTION
Adds a page on the MongoDB Github Copilot Participant and the /query command
Adds a page on AI and Data Usage (Based on the Compass AI and Data Usage page)
STAGING
https://deploy-preview-92--docs-mongodb-vscode.netlify.app/copilot/
https://deploy-preview-92--docs-mongodb-vscode.netlify.app/ai-data-usage/
https://deploy-preview-92--docs-mongodb-vscode.netlify.app/copilot-query/
JIRA
https://jira.mongodb.org/browse/DOCSP-43493
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?