Microsoft Azure

QnAMaker Client

An API for QnAMaker Service

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

An API for QnAMaker Service

Endpoints 15

Alterations

  • GETDownload alterations from runtime./alterations
  • PUTReplace alterations data./alterations

EndpointKeys

  • PATCHUpdates endpoint settings for an endpoint./endpointSettings
  • PATCHRe-generates an endpoint key./endpointkeys/:keyType

Knowledgebases

  • GETGets all knowledgebases for a user./knowledgebases
  • POSTAsynchronous operation to create a new knowledgebase./knowledgebases/create
  • GETGets details of a specific knowledgebase./knowledgebases/:kbId
  • PUTReplace knowledgebase contents./knowledgebases/:kbId
  • POSTPublishes all changes in test index of a knowledgebase to its prod index./knowledgebases/:kbId
  • DELETEDeletes the knowledgebase and all its data./knowledgebases/:kbId
  • PATCHAsynchronous operation to modify a knowledgebase./knowledgebases/:kbId
  • GETDownload the knowledgebase./knowledgebases/:kbId/:environment/qna

Operations

  • GETGets details of a specific long running operation./operations/:operationId
  • GETGets endpoint settings for an endpoint./endpointSettings
  • GETGets endpoint keys for an endpoint/endpointkeys

API details

Base URL
https://azure.local
Authentication
An API key in the Ocp-Apim-Subscription-Key header
Operations
15 operations on 9 pathsGET 7PATCH 3PUT 2POST 2DELETE 1
Main resources
Knowledgebases 8Alterations 2EndpointKeys 2Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 4.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the QnAMaker Client in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the QnAMaker Client collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Download alterations from runtime.” (GET /alterations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the QnAMaker Client?

An API for QnAMaker Service It is listed under Developer tools and has 15 endpoints.

Who publishes the QnAMaker Client?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the QnAMaker Client?

Requests go to https://azure.local. Endpoint paths are added to this base URL.

How do I authenticate with the QnAMaker Client?

With an API key in the Ocp-Apim-Subscription-Key header.

How many endpoints does the QnAMaker Client have?

15 operations on 9 paths (7 GET, 3 PATCH, 2 PUT, 2 POST, 1 DELETE). The largest groups are Knowledgebases, Alterations, EndpointKeys, Operations.

Is forking the QnAMaker Client free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.