Question Answering Projects - Update Qnas

Service:

Cognitive Services

API Version:

2021-10-01

Aktualizace otázek a odpovědí projektu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Name	Typ	Description
body	UpdateQnaRecord[]	Aktualizace parametrů QnAs projektu

Odpovědi

Name	Typ	Description
202 Accepted		Výsledky úspěšného volání s hlavičkou Operation-Location sloužící ke kontrole stavu úlohy. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog	Dialogové okno přidružené k záznamu QnA
QnaPrompt	Výzva k zadání odpovědi
QnaRecord	Záznam QnA.
SuggestedQuestion	Otázka navržená funkcí Aktivní učení
SuggestedQuestionsCluster	Podrobnosti o navrhovaných otázkách v active learningu
updateOperationKind	Typ operace aktualizace pro prostředky
UpdateQnaRecord	Záznam QnA, který se má aktualizovat.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definovaných chybových kódů.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

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

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Kód chyby čitelný pro člověka.

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

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jeden ze serverem definovaných chybových kódů.
details	object	Podrobnosti o chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Chybová zpráva.
target	string	Cíl chyby.

QnaDialog

Dialogové okno přidružené k záznamu QnA

Name	Typ	Description
isContextOnly	boolean	Pokud chcete označit, jestli je výzva relevantní jenom u předchozí otázky, nebo ne. Pokud je true, nezahrnujte tuto QnA jako odpověď pro dotazy bez kontextu; jinak ignoruje kontext a zahrne tuto otázku QnA do odpovědí.
prompts	QnaPrompt[]	Seznam výzev přidružených k odpovědi

QnaPrompt

Výzva k zadání odpovědi

Name	Typ	Description
displayOrder	integer	Index výzvy. Používá se k řazení výzev.
displayText	string	Zobrazený text představující výzvu k následné otázce
qna	QnaRecord	Záznam QnA. Záznam QnAId nebo QnA musí být ve výzvě.
qnaId	integer	ID QnA odpovídající výzvě.

QnaRecord

Záznam QnA.

Name	Typ	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Seznam návrhů aktivního učení pro otázky a otázky
answer	string	Text odpovědi.
dialog	QnaDialog	Kontext QnA
id	integer	Jedinečné ID pro QnA.
metadata	object	Metadata přidružená k odpovědi, která jsou užitečná pro kategorizaci nebo filtrování odpovědí na otázky.
questions	string[]	Seznam otázek souvisejících s odpovědí
source	string	Zdroj, ze kterého se indexovala QnA, například https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Otázka navržená funkcí Aktivní učení

Name	Typ	Description
autoSuggestedCount	integer	Kolikrát algoritmus aktivního učení automaticky navrhl otázku.
question	string	Otázka navržená funkcí Aktivní učení
userSuggestedCount	integer	Kolikrát uživatel explicitně navrhl otázku.

SuggestedQuestionsCluster

Podrobnosti o navrhovaných otázkách v active learningu

Name	Typ	Description
clusterHead	string	Otázka zvolená jako vedoucí clusteru navrhovaných otázek algoritmem clusteringu active Learning
suggestedQuestions	SuggestedQuestion[]	Seznam všech navrhovaných otázek pro otázky a odpovědi

updateOperationKind

Typ operace aktualizace pro prostředky

Name	Typ	Description
add	string
delete	string
replace	string

UpdateQnaRecord

Záznam QnA, který se má aktualizovat.

Name	Typ	Description
op	updateOperationKind	Typ operace aktualizace pro prostředky
value	QnaRecord	Záznam QnA.