Question Answering Projects - Export

Dienst:

Azure AI Services

API-Version:

2023-04-15-preview

Exportieren von Projektmetadaten und Ressourcen.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview

Mit optionalen Parametern:

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

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.
assetKind	query		assetKind	Art der Ressource des Projekts.
format	query		format	Knowledge Base Import- oder Exportformat.

Antworten

Name	Typ	Beschreibung
200 OK	ExportJobState	Exportieren des Auftragsstatus, der Projektmetadaten und der Ressourcen.
202 Accepted		Ein erfolgreicher Aufruf führt zu einem Operation-Location Header, der verwendet wird, um den Status des Auftrags zu überprüfen. Header Operation-Location: string
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

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-15-preview

Beispiel für eine Antwort

Statuscode:

200

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded",
  "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-04-15-preview"
}

Statuscode:

202

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

Definitionen

Name	Beschreibung
assetKind	Art der Ressource des Projekts.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
ExportJobState	Exportieren des Auftragsstatus, der Projektmetadaten und der Ressourcen.
format	Knowledge Base Import- oder Exportformat.
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.
jobStatus	Auftragsstatus.

assetKind

Art der Ressource des Projekts.

Name	Typ	Beschreibung
qnas	string
synonyms	string

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.

ExportJobState

Exportieren des Auftragsstatus, der Projektmetadaten und der Ressourcen.

Name	Typ	Beschreibung
createdDateTime	string
errors	Error[]	Das Fehlerobjekt.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL zum Herunterladen des Ergebnisses des Exportauftrags.
status	jobStatus	Auftragsstatus.

format

Knowledge Base Import- oder Exportformat.

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

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.

jobStatus

Auftragsstatus.

Name	Typ	Beschreibung
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string