Sdílet prostřednictvím

Question Answering Projects - Update Qnas

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
2021-10-01

Aktualizuje QnA 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

maxLength: 100

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ů QnA 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.

Hlavičky

Operation-Location: string
Other Status Codes

ErrorResponse

Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Successful query

Ukázkový požadavek

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"
      ]
    }
  }
]

Ukázková odpověď

Stavový kód:
202 
Operation-Location: job1

Definice

Name Description
Error

Objekt chyby.
ErrorCode

Kód chyby čitelné člověkem
ErrorResponse

Chybová odpověď.
InnerErrorCode

Kód chyby čitelné člověkem
InnerErrorModel

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – 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ího učení
SuggestedQuestionsCluster

Podrobnosti o clusteru s navrhovanými funkcemi Active Learning
updateOperationKind

Typ operace aktualizace pro prostředky
UpdateQnaRecord

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

Error

Objekt

Objekt chyby.

Name Typ Description
code

ErrorCode

Jedna ze serverově definovaných 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, než je aktuální objekt o chybě.
message

string

Čitelné znázornění chyby člověkem.
target

string

Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

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

ErrorResponse

Objekt

Chybová odpověď.

Name Typ Description
error

Error

Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

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

Name Typ Description
code

InnerErrorCode

Jedna ze serverově definovaných kódů chyb.
details

object

Podrobnosti o chybě
innererror

InnerErrorModel

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message

string

Zpráva o chybě.
target

string

Cíl chyby

QnaDialog

Objekt

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

Name Typ Description
isContextOnly

boolean

Pokud chcete označit, jestli je výzva relevantní jenom s předchozí otázkou, nebo ne. Pokud je pravda, nezahrnujte tuto funkci 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

Objekt

Výzva k zadání odpovědi

Name Typ Description
displayOrder

integer (int32)

Index výzvy Slouží k řazení výzev.
displayText

string

maxLength: 200

Text zobrazený tak, aby představoval výzvu k následné otázce.
qna

QnaRecord

Záznam QnA. Záznam QnAId nebo QnA musí být na příkazovém řádku.
qnaId

integer (int32)

ID QnA odpovídající výzvě.

QnaRecord

Objekt

Záznam QnA.

Name Typ Description
activeLearningSuggestions

SuggestedQuestionsCluster[]

Seznam návrhů aktivního učení pro QnA
answer

string

minLength: 1
maxLength: 25000

Text odpovědi
dialog

QnaDialog

Kontext QnA
id

integer (int32)

Jedinečné ID pro QnA.
metadata

object

Metadata přidružená k odpovědi, užitečná ke kategorizaci nebo filtrování odpovědí na otázky.
questions

string[]

Seznam otázek spojených s odpovědí
source

string

maxLength: 300

Zdroj, ze kterého byla QnA indexována, například https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Objekt

Otázka navržená funkcí aktivního učení

Name Typ Description
autoSuggestedCount

integer (int32)

Počet, kolikrát byl dotaz navržen automaticky algoritmem active learning.
question

string

Otázka navržená funkcí aktivního učení
userSuggestedCount

integer (int32)

Počet, kolikrát uživatel výslovně navrhl otázku.

SuggestedQuestionsCluster

Objekt

Podrobnosti o clusteru s navrhovanými funkcemi Active Learning

Name Typ Description
clusterHead

string

Otázka zvolená jako hlava navrhovaného clusteru otázek pomocí algoritmu clusteringu Active Learning
suggestedQuestions

SuggestedQuestion[]

Seznam všech navrhovaných otázek pro QnA

updateOperationKind

Výčet

Typ operace aktualizace pro prostředky

Hodnota Description
add
delete
replace

UpdateQnaRecord

Objekt

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

Name Typ Description
op

updateOperationKind

Typ operace aktualizace pro prostředky
value

QnaRecord

Záznam QnA.