Question Answering Projects - Get Qnas

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-15-preview

Ruft alle QnAs eines Projekts ab.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview

Mit optionalen Parametern:

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
projectName	path	True	string	Der Name des zu verwendenden Projekts.
api-version	query	True	string	Client-API-Version.
maxpagesize	query		integer int32	Die maximale Anzahl von Ressourcen, die in eine einzelne Antwort eingeschlossen werden sollen.
skip	query		integer int32	Ein Offset in der Auflistung der ersten zurückzugebenden Ressource.
source	query		string	Quelle der QnA.
top	query		integer int32	Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	QnaAssets	Alle QnAs eines Projekts.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Notizen

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Geschäfts-, Schul- und Gästekonten, unterstützt aber keine persönlichen Konten.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-15-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": 1,
      "answer": "ans1",
      "source": "source1",
      "questions": [
        "question 1.1",
        "question 1.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 1.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 1.2"
          }
        ]
      },
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    },
    {
      "id": 2,
      "answer": "ans2",
      "source": "source2",
      "questions": [
        "question 2.1",
        "question 2.2"
      ],
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    }
  ]
}

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.
QnaAssets	Alle QnA-Ressourcen für das Projekt.
QnaDialog	Dem QnA-Eintrag zugeordnetes Dialogfeld.
QnaPrompt	Zur Eingabe einer Antwort auffordern.
QnaRecord	QnA-Eintrag.
RetrieveQnaRecord	QnA-Eintrag mit datums-uhrzeit der letzten Aktualisierung.
SuggestedQuestion	Von der Active Learning-Funktion vorgeschlagene Frage.
SuggestedQuestionsCluster	Active Learning vorgeschlagene Fragen clusterdetails.

Error

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

Lesbarer Fehlercode.

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

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Lesbarer Fehlercode.

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

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.

QnaAssets

Alle QnA-Ressourcen für das Projekt.

Name	Typ	Beschreibung
nextLink	string
value	RetrieveQnaRecord[]	Liste der QnA-Einträge.

QnaDialog

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

Zur Eingabe einer Antwort auffordern.

Name	Typ	Beschreibung
displayOrder	integer	Index der Eingabeaufforderung. Sie wird für die Reihenfolge der Eingabeaufforderungen verwendet.
displayText	string	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	ID der QnA, die der Eingabeaufforderung entspricht.

QnaRecord

QnA-Eintrag.

Name	Typ	Beschreibung
activeLearningSuggestions	SuggestedQuestionsCluster[]	Liste der Active Learning-Vorschläge für die QnA.
answer	string	Antworttext.
dialog	QnaDialog	Kontext eines QnA.
id	integer	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	Quelle, aus der QnA indiziert wurde, z. B. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

RetrieveQnaRecord

QnA-Eintrag mit datums-uhrzeit der letzten Aktualisierung.

Name	Typ	Beschreibung
activeLearningSuggestions	SuggestedQuestionsCluster[]	Liste der Active Learning-Vorschläge für die QnA.
answer	string	Antworttext.
dialog	QnaDialog	Kontext eines QnA.
id	integer	Eindeutige ID für die QnA.
lastUpdatedDateTime	string	Datum und Uhrzeit der letzten Aktualisierung der 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	Quelle, aus der QnA indiziert wurde, z. B. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Von der Active Learning-Funktion vorgeschlagene Frage.

Name	Typ	Beschreibung
autoSuggestedCount	integer	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	Die Häufigkeit, mit der die Frage explizit vom Benutzer vorgeschlagen wurde.

SuggestedQuestionsCluster

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.

Freigeben über