Question Answering Projects - Export

Dienst:

Azure AI Services

API-Version:

2021-10-01

Exportieren von Projektmetadaten und Ressourcen.

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01

Mit optionalen Parametern:

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01&format={format}&assetKind={assetKind}

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

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	ExportJobState	Exportieren des Auftragsstatus, der Projektmetadaten und der Ressourcen.
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

HTTP

POST {Endpoint}/language/query-knowledgebases/projects/proj1/:export?api-version=2021-10-01

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=2021-10-01"
}

Statuscode:

202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

Definitionen

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

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.

ExportJobState

Objekt

Exportieren des Auftragsstatus, der Projektmetadaten und der Ressourcen.

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

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.

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.

jobStatus

Enumeration

Auftragsstatus.

Wert	Beschreibung
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded