Question Answering Projects - Update Qnas

Service:

Cognitive Services

API Version:

2021-10-01

Uppdateringar QnA:erna för ett projekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Namnet på det projekt som ska användas.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Name	Typ	Description
body	UpdateQnaRecord[]	Uppdatera QnAs-parametrar för ett projekt.

Svar

Name	Typ	Description
202 Accepted		Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exempel

Successful query

Sample Request

HTTP

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog	Dialogruta som är associerad med QnA-post.
QnaPrompt	Fråga efter ett svar.
QnaRecord	QnA-post.
SuggestedQuestion	Fråga som föreslås av funktionen Active Learning.
SuggestedQuestionsCluster	Active Learning föreslog frågor om klusterinformation.
updateOperationKind	Uppdateringsåtgärdstyp för tillgångar.
UpdateQnaRecord	QnA-post som ska uppdateras.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En läsbar återgivning av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

QnaDialog

Dialogruta som är associerad med QnA-post.

Name	Typ	Description
isContextOnly	boolean	Markera om en fråga endast är relevant med en tidigare fråga eller inte. Om det är sant ska du inte ta med denna QnA som svar på frågor utan kontext. annars ignorerar kontexten och inkluderar denna QnA i svar.
prompts	QnaPrompt[]	Lista över frågor som är associerade med svaret.

QnaPrompt

Fråga efter ett svar.

Name	Typ	Description
displayOrder	integer	Index för prompten. Den används för att beställa anvisningarna.
displayText	string	Text som visas för att representera en fråga om uppföljningsfråga.
qna	QnaRecord	QnA-post. QnAId- eller QnA-post måste finnas i en prompt.
qnaId	integer	ID för den QnA som motsvarar prompten.

QnaRecord

QnA-post.

Name	Typ	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista över Active Learning-förslag för QnA.
answer	string	Svarstext.
dialog	QnaDialog	Kontext för en QnA.
id	integer	Unikt ID för QnA.
metadata	object	Metadata som är associerade med svaret, användbara för att kategorisera eller filtrera frågesvar.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string	Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Fråga som föreslås av funktionen Active Learning.

Name	Typ	Description
autoSuggestedCount	integer	Antalet gånger som frågan föreslogs automatiskt av Active Learning-algoritmen.
question	string	Fråga som föreslås av funktionen Active Learning.
userSuggestedCount	integer	Antalet gånger som frågan uttryckligen föreslogs av användaren.

SuggestedQuestionsCluster

Active Learning föreslog frågor om klusterinformation.

Name	Typ	Description
clusterHead	string	Fråga som valts som chef för det föreslagna frågeklustret av Active Learning-klustringsalgoritmen.
suggestedQuestions	SuggestedQuestion[]	Lista över alla föreslagna frågor för QnA.

updateOperationKind

Uppdateringsåtgärdstyp för tillgångar.

Name	Typ	Description
add	string
delete	string
replace	string

UpdateQnaRecord

QnA-post som ska uppdateras.

Name	Typ	Description
op	updateOperationKind	Uppdateringsåtgärdstyp för tillgångar.
value	QnaRecord	QnA-post.