Share via

Question Answering Projects - Update Qnas

  • Reference
Service:
Azure AI Services
API Version:
2023-04-15-preview

Updates the QnAs of a project.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview

URI Parameters

Name In Required Type Description
projectName
 path True

string

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

string

Client API version.

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

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

  • Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful query

Sample request

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-15-preview

[
  {
    "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: https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-15-preview

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

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

Human-readable error code.

Name Type Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Human-readable error code.

Name Type Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

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

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

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

Prompt for an answer.

Name Type Description
displayOrder

integer

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

string

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

ID of the QnA corresponding to the prompt.

QnaRecord

QnA record.

Name Type Description
activeLearningSuggestions

SuggestedQuestionsCluster[]

List of Active Learning suggestions for the QnA.
answer

string

Answer text.
dialog

QnaDialog

Context of a QnA.
id

integer

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

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

SuggestedQuestion

Question suggested by the Active Learning feature.

Name Type Description
autoSuggestedCount

integer

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

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

SuggestedQuestionsCluster

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

Update operation type for assets.

Name Type Description
add

string

delete

string

replace

string

UpdateQnaRecord

QnA record to be updated.

Name Type Description
op

updateOperationKind

Update operation type for assets.
value

QnaRecord

QnA record.