Share via

Question Answering Projects - Update Qnas

Service:
Azure AI Services
API Version:
2021-10-01

Updates the QnAs of a project.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com).
projectName
 path True

string

maxLength: 100

The name of the project to use.
api-version
 query True

string

Client API version.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
body

UpdateQnaRecord[]

Update QnAs parameters of a project.

Responses

Name Type Description
202 Accepted

A successful call results with an Operation-Location header used to check the status of the job.

Headers

Operation-Location: string
Other Status Codes

ErrorResponse

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1/qnas?api-version=2021-10-01


[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

Sample response

Status code:
202 
Operation-Location: job1

Definitions

Name Description
Error

The error object.
ErrorCode

Human-readable error code.
ErrorResponse

Error response.
InnerErrorCode

Human-readable error code.
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.
QnaDialog

Dialog associated with QnA Record.
QnaPrompt

Prompt for an answer.
QnaRecord

QnA record.
SuggestedQuestion

Question suggested by the Active Learning feature.
SuggestedQuestionsCluster

Active Learning suggested questions cluster details.
updateOperationKind

Update operation type for assets.
UpdateQnaRecord

QnA record to be updated.

Error

Object

The error object.

Name Type Description
code

ErrorCode

One of a server-defined set of error codes.
details

Error[]

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

InnerErrorModel

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.

ErrorCode

Enumeration

Human-readable error code.

Value Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

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

InnerErrorCode

One of a server-defined set of error codes.
details

object

Error details.
innererror

InnerErrorModel

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

string

Error message.
target

string

Error target.

QnaDialog

Object

Dialog associated with QnA Record.

Name Type Description
isContextOnly

boolean

To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers.
prompts

QnaPrompt[]

List of prompts associated with the answer.

QnaPrompt

Object

Prompt for an answer.

Name Type Description
displayOrder

integer (int32)

Index of the prompt. It is used for ordering of the prompts.
displayText

string

maxLength: 200

Text displayed to represent a follow up question prompt.
qna

QnaRecord

QnA record. Either QnAId or QnA record needs to be present in a Prompt.
qnaId

integer (int32)

ID of the QnA corresponding to the prompt.

QnaRecord

Object

QnA record.

Name Type Description
activeLearningSuggestions

SuggestedQuestionsCluster[]

List of Active Learning suggestions for the QnA.
answer

string

minLength: 1
maxLength: 25000

Answer text.
dialog

QnaDialog

Context of a QnA.
id

integer (int32)

Unique ID for the QnA.
metadata

object

Metadata associated with the answer, useful to categorize or filter question answers.
questions

string[]

List of questions associated with the answer.
source

string

maxLength: 300

Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Question suggested by the Active Learning feature.

Name Type Description
autoSuggestedCount

integer (int32)

The number of times the question was suggested automatically by the Active Learning algorithm.
question

string

Question suggested by the Active Learning feature.
userSuggestedCount

integer (int32)

The number of times the question was suggested explicitly by the user.

SuggestedQuestionsCluster

Object

Active Learning suggested questions cluster details.

Name Type Description
clusterHead

string

Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm.
suggestedQuestions

SuggestedQuestion[]

List of all suggested questions for the QnA.

updateOperationKind

Enumeration

Update operation type for assets.

Value Description
add
delete
replace

UpdateQnaRecord

Object

QnA record to be updated.

Name Type Description
op

updateOperationKind

Update operation type for assets.
value

QnaRecord

QnA record.