Microsoft Azure Knowledge Bases API

The Knowledge Bases API from Microsoft Azure — 6 operation(s) for knowledge bases.

Documentation GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /knowledgebases List all my QnA Maker knowledge bases · Microsoft Azure Gets All Knowledgebases For A User #

Ask an LLM

“Which QnA Maker knowledge bases do I have?”

“Can I see every knowledge base under my QnA Maker resource at once?”

Tell an agent

List all my knowledge bases.

Show every QnA Maker knowledge base I own.

GET /knowledgebases/{kbId} Get a knowledge base's details · Microsoft Azure Gets Details Of A Specific Knowledgebase #

Ask an LLM

“How do I see the name, sources and last-published date of one knowledge base?”

“What details does QnA Maker hold about a specific knowledge base ID?”

Tell an agent

Get the details of knowledge base {kbId}.

Show when knowledge base {kbId} was last changed and published.

DELETE /knowledgebases/{kbId} Delete a knowledge base · Microsoft Azure Deletes The Knowledgebase And All Its Data #

Ask an LLM

“How do I permanently delete a knowledge base and all of its data?”

“Can a QnA Maker knowledge base be removed once it is retired?”

Tell an agent destructive · confirm first

Delete knowledge base {kbId}.

Remove {kbId} and everything in it.

POST /knowledgebases/{kbId} Publish a knowledge base to production · Microsoft Azure Publishes All Changes In Test Index Of A Knowledgebase To Its… #

Ask an LLM

“How do I push the test edits in my knowledge base live to the production index?”

“Can I publish all pending changes in a QnA Maker knowledge base?”

Tell an agent

Publish knowledge base {kbId}.

Copy the test index of {kbId} to production.

PUT /knowledgebases/{kbId} Replace a knowledge base's contents · Microsoft Azure Replace Knowledgebase Contents #

Ask an LLM

“Can I overwrite every question and answer in a knowledge base with a new list?”

“How do I wipe a knowledge base's QnA pairs and load a fresh set?”

Tell an agent destructive · confirm first

Replace the contents of knowledge base {kbId} with {replaceKb}.

Overwrite all QnA pairs in {kbId} with this new list: {replaceKb}.

PATCH /knowledgebases/{kbId} Add, edit or remove items in a knowledge base · Microsoft Azure Asynchronous Operation To Modify A Knowledgebase #

Ask an LLM

“How do I add a few new QnA pairs to an existing knowledge base without replacing it?”

“Can I edit or delete individual questions in a knowledge base asynchronously?”

Tell an agent

Apply these add, update and delete changes to knowledge base {kbId}: {updateKb}.

Modify some QnA pairs in {kbId} using {updateKb}.

POST /knowledgebases/create Create a new knowledge base · Microsoft Azure Asynchronous Operation To Create A New Knowledgebase #

Ask an LLM

“How do I create a new QnA Maker knowledge base from URLs, files or QnA pairs?”

“Is creating a knowledge base an asynchronous operation I need to poll?”

Tell an agent

Create a new knowledge base from {createKbPayload}.

Start building a knowledge base with this name and sources: {createKbPayload}.

GET /knowledgebases/{kbId}/{environment}/qna Download a knowledge base's QnA pairs · Microsoft Azure Download The Knowledgebase #

Ask an LLM

“Can I export all the QnA pairs from the test or prod version of a knowledge base?”

“Is it possible to download only the QnAs that changed since a certain date?”

Tell an agent

Download knowledge base {kbId} from the {environment} environment.

Export QnAs from {kbId} in {environment} changed since {changedSince}.

POST /knowledgebases/{kbId}/generateAnswer Ask a knowledge base a question · Microsoft Azure Generateanswer Call To Query Knowledgebase Qna Maker Managed #

Ask an LLM

“How do I send a user's question to my knowledge base and get the best answer back?”

“Can I query a managed QnA Maker knowledge base for ranked answers?”

Tell an agent

Ask knowledge base {kbId} the question in {generateAnswerPayload}.

Get the top answer from {kbId} for {generateAnswerPayload}.

POST /knowledgebases/{kbId}/train Send active-learning feedback to a knowledge base · Microsoft Azure Train Call To Add Suggestions To Knowledgebase Qnamaker Managed #

Ask an LLM

“How do I feed user click feedback back into a QnA Maker knowledge base?”

“Can I add alternate-question suggestions to a managed knowledge base through training?”

Tell an agent

Train knowledge base {kbId} with feedback {trainPayload}.

Submit active learning suggestions {trainPayload} to {kbId}.

Microsoft Azure Knowledge Bases API

Operations 10

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification