(EAI-563) fixes and upload command (#590)

* add missing references and author emails to verified answers

* upload verified answers command, readme and env vars updates

Author: yakubova92

packages/mongodb-chatbot-verified-answers/.env.example

@@ -5,3 +5,8 @@ OPENAI_EMBEDDING_MODEL_VERSION=2023-03-15-preview
 OPENAI_VERIFIED_ANSWER_EMBEDDING_DEPLOYMENT="docs-chatbot-embedding-ada-002"
 OPENAI_ENDPOINT=https://<resource_name>.openai.azure.com/
 OPENAI_API_KEY=<api_key>
+OPENAI_API_VERSION="2024-06-01"
+OPENAI_RETRIEVAL_EMBEDDING_DEPLOYMENT=text-embedding-3-small
+VECTOR_SEARCH_INDEX_NAME=vector_index
+OPENAI_CHAT_COMPLETION_DEPLOYMENT="n/a"
+OPENAI_CHAT_COMPLETION_MODEL_VERSION="n/a"

packages/mongodb-chatbot-verified-answers/README.md

@@ -1,3 +1,18 @@
 # MongoDB Verified Answer CLI
 
 The Verified Answer CLI imports answers specified in a yaml file into the database.
+
+## To import answers into the database:
+
+Write answers in a yaml file like `verified-answers.yaml` or make updates to an existing file.
+
+In the root directory, run `npm run build`.
+
+Enter the mongodb-chatbot-verified-answers directory with `cd packages/mongodb-chatbot-verified-answers`.
+
+Run `npm run upload -- import <path to verified-answers.yaml>`.
+
+If successful, you will see a success message that looks like:
+
+```sh
+{ failed: 0, updated: 0, created: 18, deleted: 0 }

packages/mongodb-chatbot-verified-answers/package.json

@@ -36,7 +36,8 @@
     "lint": "eslint ./src --ext ts,tsx,js,jsx --report-unused-disable-directives",
     "lint:fix": "npm run lint -- --fix && prettier ./src --check --write",
     "docs": "npx typedoc --excludePrivate --exclude '**/*.test.ts' --out docs src",
-    "release": "release-it"
+    "release": "release-it",
+    "upload": "node ./build/main.js"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7",

verified-answers.yaml

@@ -1689,20 +1689,23 @@
       title: "MongoDB University"
 - answer: >-
     To prepare for any of the MongoDB Certification Exams, we recommend you navigate to the exam of your choice from our certification landing page. Each exam page contains a exam details, a study guide, and a set of practice questions.  author_email: [email protected]
+  author_email: [email protected]
   questions:
     - How do I prepare for a MongoDB Certification Exam?
   references:
     - url: https://learn.mongodb.com/pages/certification-program
       title: "MongoDB Certification Program"
 - answer: >-
     If you need extra time for your certificaiton due to a learning disability or because English is a second language for you, please purchase and schedule your exam and then send a support ticket to [[email protected]](mailto:[email protected]) requesting extra time. 
+  author_email: [email protected]
   questions:
     - How do I request extended time for my certification exam?
   references:
     - url: mailto:[email protected]
       title: "Send an email to the certification team"
 - answer: >-
     If you require a refund for your MongoDB Certification Exam, please submit your request to [[email protected]](mailto:[email protected]) and our support team will do their best to accommodate you.
+  author_email: [email protected]
   questions:
     - How do I request a refund for my certification exam?
   references:
@@ -1712,17 +1715,23 @@
     To register for your exam, log into your learner account on [learn.mongodb.com](learn.mongodb.com) and simply select the exam from the certification page, register, complete the transaction process. Note: If you are using a coupon, please enter the code at checkout.
 
     Once you’ve registered and completed the transaction process, you’ll be sent to our online proctoring partner, Examity, to complete your tester profile and schedule your exam. Our exams are offered 24hrs a day, 7days a week.
+  author_email: [email protected]
   questions:
     - How do I register for a certification exam?
+  references:
+    - url: https://learn.mongodb.com/
+      title: "MongoDB Certification Program"
 - answer: >-
     MongoDB Learning Badges are a new type of free credential offered through MongoDB University. Unlike high-stakes certifications, which cover a large breadth and depth of subjects, these badges are focused on specific topics, making them easier and quicker to earn.
+  author_email: [email protected]
   questions:
     - Where do I learn about MongoDB Learning Badges?
   references:
     - url: https://learn.mongodb.com/pages/learner-badges
       title: "MongoDB Learning Badges"
 - answer: >-
     MongoDB Learning Badges are non-proctored tests that allow you to prove your knowledge on shorter, more targeted topics regardless of your role. MongoDB Certifications are proctored exams that are specific to job roles and cover a large breadth and depth.
+  author_email: [email protected]
   questions:
     - What is the difference between a MongoDB Learning Badge and a MongoDB Certification?
   references: