Question Answering Projects - Import

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Projektressourcen importieren.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

Mit optionalen Parametern:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string (uri)	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Der Name des zu verwendenden Projekts.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
assetKind	query		AssestKind	Art der Ressource des Projekts.
format	query		format	Knowledge Base Import- oder Exportformat.

Anforderungstext

Name	Typ	Beschreibung
assets	Assets	Alle Ressourcen für dieses Projekt.
fileUri	string	Datendatei-URI importieren.
metadata	QuestionAnsweringProjectMetadata	Parameter, die zum Erstellen des Projekts erforderlich sind.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

202 Accepted

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

Operation-Location: string

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

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

Bereiche

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

Beispiele

Successful query

Beispielanforderung

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "qnas": [
      {
        "answer": "ans1",
        "dialog": {
          "isContextOnly": false,
          "prompts": [
            {
              "displayOrder": 1,
              "displayText": "prompt 1.1",
              "qnaId": 2
            }
          ]
        },
        "id": 1,
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "metadata": {
          "k1": "v1",
          "k2": "v2"
        },
        "questions": [
          "question 1.1",
          "question 1.2"
        ],
        "source": "source1"
      },
      {
        "answer": "ans2",
        "id": 2,
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "questions": [
          "question 2.1",
          "question 2.2"
        ],
        "source": "source2"
      }
    ],
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 202

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

Definitionen

Name	Beschreibung
AssestKind	Art der Ressource des Projekts.
Assets	Alle Ressourcen für dieses Projekt.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
format	Knowledge Base Import- oder Exportformat.
ImportJobOptions	Projektressourcen, die importiert werden müssen.
ImportQnaRecord	Importieren Sie QnA-Eintrag.
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.
ProjectSettings	Konfigurierbare Einstellungen des Projekts.
QnaDialog	Dem QnA-Eintrag zugeordnetes Dialogfeld.
QnaPrompt	Zur Eingabe einer Antwort auffordern.
QnaRecord	QnA-Eintrag.
QuestionAnsweringProjectMetadata	Stellt das Projekt dar.
SuggestedQuestion	Von der Active Learning-Funktion vorgeschlagene Frage.
SuggestedQuestionsCluster	Active Learning vorgeschlagene Fragen clusterdetails.
WordAlterations	Sammlung von Wortänderungen.

AssestKind

Enumeration

Art der Ressource des Projekts.

Wert	Beschreibung
qnas	Frage und Antworten.
synonyms	Synonyme.

Assets

Objekt

Alle Ressourcen für dieses Projekt.

Name	Typ	Beschreibung
qnas	ImportQnaRecord[]	Liste der zu importierenden QnA-Datensätze.
synonyms	WordAlterations[]	Sammlung von Synonymen.

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	Azure Cognitive Search Index limit reached error
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
Conflict	Konfliktfehler
Forbidden	Fehler beim unzulässigen Zugriff
InternalServerError	Interner Serverfehler
InvalidArgument	Ungültiger Argumentfehler
InvalidRequest	Ungültiger Anforderungsfehler
NotFound	Fehler nicht gefunden
OperationNotFound	Fehler beim Vorgang nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
QuotaExceeded	Fehler "Kontingent überschritten"
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
TooManyRequests	Fehler bei zu vielen Anforderungen
Unauthorized	Fehler beim nicht autorisierten Zugriff
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

format

Enumeration

Knowledge Base Import- oder Exportformat.

Wert	Beschreibung
excel	Exportieren oder Importieren des Knowledge Base-Replikats, einschließlich aller Objekte und Metadaten im Tsv-Format.
json	Exportieren oder Importieren von QnA-Ressourcen im JSON-Format.
tsv	Exportieren oder Importieren des Knowledge Base-Replikats, einschließlich aller Objekte und Metadaten im Excel-Format.

ImportJobOptions

Objekt

Projektressourcen, die importiert werden müssen.

Name	Typ	Beschreibung
assets	Assets	Alle Ressourcen für dieses Projekt.
fileUri	string	Datendatei-URI importieren.
metadata	QuestionAnsweringProjectMetadata	Parameter, die zum Erstellen des Projekts erforderlich sind.

ImportQnaRecord

Objekt

Importieren Sie 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.
lastUpdatedDateTime	string (date-time)	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 maxLength: 300	Quelle, aus der QnA indiziert wurde, z. B. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName	string minLength: 1 maxLength: 200	Anzeigename der Quelle.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
EmptyRequest	Fehler "Leere Anforderung"
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidCountryHint	Ungültiger Fehler im Landhinweis
InvalidDocument	Ungültiger Dokumentfehler
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
InvalidRequest	Ungültiger Anforderungsfehler
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
ModelVersionIncorrect	Fehler bei der Modellversion
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode

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.

ProjectSettings

Objekt

Konfigurierbare Einstellungen des Projekts.

Name	Typ	Beschreibung
defaultAnswer	string	Standardantwortantwort, wenn keine gute Übereinstimmung in der Wissensdatenbank gefunden wird.

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 .

QuestionAnsweringProjectMetadata

Objekt

Stellt das Projekt dar.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Datum und Uhrzeit der Projekterstellung.
description	string	Beschreibung des Projekts.
language	string	Sprache der Texteinträge. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, verwenden Sie "en" für Englisch als Standard.
lastDeployedDateTime	string (date-time)	Represents the project last deployment date-time.
lastModifiedDateTime	string (date-time)	Stellt das Datum und die Uhrzeit der letzten Änderung des Projekts dar.
multilingualResource	boolean	Ressource für mehrere Sprachen in Projekten aktiviert oder nicht.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Name des Projekts.
settings	ProjectSettings	Konfigurierbare Einstellungen des Projekts.

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.

WordAlterations

Objekt

Sammlung von Wortänderungen.

Name	Typ	Beschreibung
alterations	string[]	Sammlung von Wortänderungen.

Freigeben über

Question Answering Projects - Import

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Successful query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AssestKind

Assets

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

QuestionAnsweringProjectMetadata

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations