Question Answering Projects - Update Qnas

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2023-04-01

Aktualizace otázek projektu.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-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 klientského rozhraní API

Text požadavku

Name	Typ	Description
body	UpdateQnaRecord[]	Aktualizujte parametry QnAs projektu.

Odpovědi

Name	Typ	Description
202 Accepted		Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Odpověď na chybu.

Name

Typ

Description

202 Accepted

Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy.

Hlavičky

Operation-Location: string

Other Status Codes

ErrorResponse

Odpověď na chybu.

Zabezpečení

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Azure Active Directory verze 1.0 nebo v2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby language.

Typ: apiKey
V: header

Příklady

Successful query

Ukázkový požadavek

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-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"
      ]
    }
  }
]

Ukázková odpověď

Stavový kód:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-01

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
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 clusteru s navrhovanými otázkami pro Aktivní učení
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é sady kódů chyb.
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
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

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

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

Name	Typ	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

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é sady kódů chyb.
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í pouze u předchozí otázky, nebo ne. Pokud ano, nezahrnujte tuto funkci QnA jako odpověď pro dotazy bez kontextu; jinak ignoruje kontext a zahrne tuto funkci 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 na 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 QnA
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 byla indexována QnA, např. 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 otázku explicitně navrhl.

SuggestedQuestionsCluster

Podrobnosti clusteru s navrhovanými otázkami pro Aktivní učení

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 QnA

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.

Sdílet prostřednictvím

Question Answering Projects - Update Qnas

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

AADToken

Poznámky

Rozsahy

Ocp-Apim-Subscription-Key

Příklady

Successful query

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord

Další materiály