| page_type | description | languages | products | |||
|---|---|---|---|---|---|---|
sample |
These REST samples show you how to programmatically create, update, publish, and replace a QnA Maker knowledge base. |
|
|
These REST samples show you how to programmatically create, update, publish, and replace a QnA Maker knowledge base, amongst many other ways to interact with it. All samples are in Java. To view these same samples in other languages:
cognitive-services-qnamaker-csharp
cognitive-services-qnamaker-nodejs
cognitive-services-qnamaker-python
Included are the following samples:
- Create knowledge base. Create a brand new knowledge base with given FAQ URLs. You may supply your own.
- Update knowledge base. Update an existing knowledge base by changing its name.
- Publish knowledge base. Publish any existing knowledge base to the host your Azure account.
- Replace knowledge base. Replace an entire existing knowledge base with a custom question/answer pair.
- Download knowledge base. Download the contents of your existing knowledge base in JSON.
- Delete knowledge base. Deletes an existing knowledge base that has been published through qnamaker.ai.
All REST samples revolve around what you can do with a knowledge base, which is made up of FAQs or product manuals where there is a question and an answer. QnA Maker gives you more control over how to answer questions by allowing you to train a chat bot to give answers in a variety of ways that feels more like natural, conversational exchanges.
For each sample, a subscription key is required from your Azure Portal account.
- To create a new account/resource for QnA Maker, see Create a Cognitive Services API account in the Azure portal. You may need to 'Search in Marketplace' for QnA Maker if you don't see it in the list given.
- For existing accounts, the key can be found in your Azure Portal dashboard in your QnA Maker resource under Resource Management > Keys.
With the exception of creating a new knowledge base, these samples will require your QnA Maker account knowledge base ID. To find your knowledge base ID, go to My knowledge bases and select View Code on the right. You'll see the http request and your knowledge base ID is in the topmost line: for example, POST /knowledgebases/2700e6b9-91a1-41e9-a958-6d1a98735b10/.... Use only the ID.
-
Use your favorite IDE for this sample. IntelliJ IDEA is used here. This IDE has a free evaluation version.
-
Create a new Java project, using the SDK 10. The simplest way to test these samples is to add a new class to the project's
srcfolder for each sample. -
Copy/paste the sample code into the corresponding class.
-
Add the Google GSON library to your Java project, either by manually creating & importing the .jar file or adding a dependency to your preferred project management tool, such as Maven.
-
Add your subscription key (from Azure portal) and (if applicable) your knowledge base ID (from qnamaker.ai) as requested in the variables at the top of the class.
-
Run your project.
- Quickstart: Create a new knowledge base in Java
- Quickstart: Update a knowledge base in Java
- Quickstart: Publish a knowledge base in Java
- More quickstarts coming soon... in the meantime, refer to Quickstart for Microsoft QnA Maker API with Java for all quickstarts in minimal format.