Knowledgebase - Replace

Replace knowledgebase contents.

PUT {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}

URI Parameters

Name In Required Type Description
Endpoint
path True
  • string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

kbId
path True
  • string

Knowledgebase id.

Request Body

Name Required Type Description
qnAList True

List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.

Responses

Name Type Description
204 No Content

HTTP 204 No content.

Other Status Codes

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample Request

PUT {Endpoint}/qnamaker/v4.0/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff
{
  "qnAList": [
    {
      "id": 0,
      "answer": "string",
      "source": "string",
      "questions": [
        "string"
      ],
      "metadata": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Sample Response

Definitions

Context

Context of a QnA

Error

The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ErrorCodeType

One of a server-defined set of error codes.

ErrorResponse

Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

MetadataDTO

Name - value pair of metadata.

PromptDTO

Prompt for an answer.

Qna

QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object

QnADTO

Q-A object.

ReplaceKbDTO

Post body schema for Replace KB operation.

Context

Context of a QnA

Name Type Description
isContextOnly
  • boolean

To mark if a prompt is relevant only with a previous question or not. true - Do not include this QnA as search result for queries without context false - ignores context and includes this QnA in search result

prompts

List of prompts associated with the answer.

Error

The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

One of a server-defined set of error codes.

details

An array of details about specific errors that led to this reported error.

innerError

An object containing more specific information than the current object about the error.

message
  • string

A human-readable representation of the error.

target
  • string

The target of the error.

ErrorCodeType

One of a server-defined set of error codes.

Name Type Description
BadArgument
  • string
EndpointKeysError
  • string
ExtractionFailure
  • string
Forbidden
  • string
KbNotFound
  • string
NotFound
  • string
OperationNotFound
  • string
QnaRuntimeError
  • string
QuotaExceeded
  • string
SKULimitExceeded
  • string
ServiceError
  • string
Unauthorized
  • string
Unspecified
  • string
ValidationFailure
  • string

ErrorResponse

Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
error

The error object.

InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code
  • string

A more specific error code than was provided by the containing error.

innerError

An object containing more specific information than the current object about the error.

MetadataDTO

Name - value pair of metadata.

Name Type Description
name
  • string

Metadata name.

value
  • string

Metadata value.

PromptDTO

Prompt for an answer.

Name Type Description
displayOrder
  • integer

Index of the prompt - used in ordering of the prompts

displayText
  • string

Text displayed to represent a follow up question prompt

qna

QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object

qnaId
  • integer

Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.

Qna

QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object

QnADTO

Q-A object.

Name Type Description
answer
  • string

Answer text

context

Context of a QnA

id
  • integer

Unique id for the Q-A.

metadata

List of metadata associated with the answer.

questions
  • string[]

List of questions associated with the answer.

source
  • string

Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Post body schema for Replace KB operation.

Name Type Description
qnAList

List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.