Freigeben über

Question Answering Projects - Update Qnas

  • Referenz
Dienst:
Azure AI Services
API-Version:
2021-10-01

Aktualisiert die QnAs eines Projekts.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
Endpoint
 path True

string

Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName
 path True

string

maxLength: 100

Der Name des zu verwendenden Projekts.
api-version
 query True

string

Client-API-Version.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Ocp-Apim-Subscription-Key True

string

Anforderungstext

Name Typ Beschreibung
body

UpdateQnaRecord[]

Aktualisieren sie QnAs-Parameter eines Projekts.

Antworten

Name Typ Beschreibung
202 Accepted

Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird.

Header

Operation-Location: string
Other Status Codes

ErrorResponse

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
202 
Operation-Location: job1

Definitionen

Name Beschreibung
Error

Das Fehlerobjekt.
ErrorCode

Lesbarer Fehlercode.
ErrorResponse

Fehlerantwort.
InnerErrorCode

Lesbarer Fehlercode.
InnerErrorModel

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaDialog

Dem QnA-Eintrag zugeordnetes Dialogfeld.
QnaPrompt

Zur Eingabe einer Antwort auffordern.
QnaRecord

QnA-Eintrag.
SuggestedQuestion

Von der Active Learning-Funktion vorgeschlagene Frage.
SuggestedQuestionsCluster

Active Learning vorgeschlagene Fragen clusterdetails.
updateOperationKind

Vorgangstyp für Ressourcen aktualisieren.
UpdateQnaRecord

QnA-Eintrag, der aktualisiert werden soll.

Error

Objekt

Das Fehlerobjekt.

Name Typ Beschreibung
code

ErrorCode

Eine serverdefinierte Gruppe von Fehlercodes.
details

Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

InnerErrorModel

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Eine lesbare Darstellung des Fehlers.
target

string

Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert Beschreibung
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Fehlerantwort.

Name Typ Beschreibung
error

Error

Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert Beschreibung
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Beschreibung
code

InnerErrorCode

Eine serverdefinierte Gruppe von Fehlercodes.
details

object

Fehlerdetails.
innererror

InnerErrorModel

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Fehlermeldung.
target

string

Fehlerziel.

QnaDialog

Objekt

Dem QnA-Eintrag zugeordnetes Dialogfeld.

Name Typ Beschreibung
isContextOnly

boolean

Um zu markieren, ob eine Eingabeaufforderung nur mit einer vorherigen Frage relevant ist oder nicht. Wenn wahr, schließen Sie diese QnA nicht als Antwort für Abfragen ohne Kontext ein; andernfalls ignoriert den Kontext und schließt diese QnA in Antworten ein.
prompts

QnaPrompt[]

Liste der Eingabeaufforderungen, die der Antwort zugeordnet sind.

QnaPrompt

Objekt

Zur Eingabe einer Antwort auffordern.

Name Typ Beschreibung
displayOrder

integer (int32)

Index der Eingabeaufforderung. Sie wird für die Reihenfolge der Eingabeaufforderungen verwendet.
displayText

string

maxLength: 200

Text, der angezeigt wird, um eine Nachverfolgungsfrageaufforderung darzustellen.
qna

QnaRecord

QnA-Eintrag. Entweder QnAId- oder QnA-Eintrag muss in einer Eingabeaufforderung vorhanden sein.
qnaId

integer (int32)

ID der QnA, die der Eingabeaufforderung entspricht.

QnaRecord

Objekt

QnA-Eintrag.

Name Typ Beschreibung
activeLearningSuggestions

SuggestedQuestionsCluster[]

Liste der Active Learning-Vorschläge für die QnA.
answer

string

minLength: 1
maxLength: 25000

Antworttext.
dialog

QnaDialog

Kontext eines QnA.
id

integer (int32)

Eindeutige ID für die QnA.
metadata

object

Metadaten, die der Antwort zugeordnet sind, nützlich zum Kategorisieren oder Filtern von Frageantworten.
questions

string[]

Liste der Fragen, die der Antwort zugeordnet sind.
source

string

maxLength: 300

Quelle, aus der QnA indiziert wurde, z. B. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Objekt

Von der Active Learning-Funktion vorgeschlagene Frage.

Name Typ Beschreibung
autoSuggestedCount

integer (int32)

Die Häufigkeit, mit der die Frage automatisch vom Active Learning-Algorithmus vorgeschlagen wurde.
question

string

Von der Active Learning-Funktion vorgeschlagene Frage.
userSuggestedCount

integer (int32)

Die Häufigkeit, mit der die Frage explizit vom Benutzer vorgeschlagen wurde.

SuggestedQuestionsCluster

Objekt

Active Learning vorgeschlagene Fragen clusterdetails.

Name Typ Beschreibung
clusterHead

string

Die Frage wurde als Leiter vorgeschlagener Fragen clustern durch active Learning Clustering Algorithmus ausgewählt.
suggestedQuestions

SuggestedQuestion[]

Liste aller vorgeschlagenen Fragen für die QnA.

updateOperationKind

Enumeration

Vorgangstyp für Ressourcen aktualisieren.

Wert Beschreibung
add
delete
replace

UpdateQnaRecord

Objekt

QnA-Eintrag, der aktualisiert werden soll.

Name Typ Beschreibung
op

updateOperationKind

Vorgangstyp für Ressourcen aktualisieren.
value

QnaRecord

QnA-Eintrag.