Conversational Analysis Authoring - Get Export Status

Referenz

Dienst:: Cognitive Services - Language

API-Version:: 2022-05-01

Ruft den Status eines Exportauftrags ab. Gibt die Projektmetadaten und -ressourcen zurück, sobald der Auftrag abgeschlossen ist.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}?api-version=2022-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Die Auftrags-ID.
projectName	path	True	string	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	Ein Abonnementschlüssel für eine Sprachdienstressource.

Antworten

Name	Typ	Beschreibung
200 OK	ConversationalAnalysisAuthoringExportProjectJobState	Die status des zeitintensiven Vorgangs.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful Get Export Status

Beispielanforderung

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2022-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-01",
  "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000",
  "createdDateTime": "2022-04-18T15:23:07Z",
  "lastUpdatedDateTime": "2022-04-18T15:23:08Z",
  "expirationDateTime": "2022-04-25T15:23:07Z",
  "status": "succeeded"
}

Definitionen

Name	Beschreibung
ConversationalAnalysisAuthoringExportProjectJobState	Stellt den Status eines Exportauftrags dar.
ConversationalAnalysisAuthoringWarning	Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Der Auftrag status.

ConversationalAnalysisAuthoringExportProjectJobState

Stellt den Status eines Exportauftrags dar.

Name	Typ	Beschreibung
createdDateTime	string	Die Erstellungsdatumszeit des Auftrags.
errors	Error[]	Die Fehler, die beim Ausführen des Auftrags aufgetreten sind.
expirationDateTime	string	Die Ablaufzeit des Auftrags.
jobId	string	Die Auftrags-ID.
lastUpdatedDateTime	string	Das Datum, zu dem der Auftrag zuletzt aktualisiert wurde.
resultUrl	string	Die URL, die zum Herunterladen des exportierten Projekts verwendet werden soll.
status	JobStatus	Der Auftrag status.
warnings	ConversationalAnalysisAuthoringWarning[]	Die Warnungen, die beim Ausführen des Auftrags aufgetreten sind.

ConversationalAnalysisAuthoringWarning

Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.

Name	Typ	Beschreibung
code	string	Der Warncode.
message	string	Die Warnmeldung.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer von einem serverdefiniertem Satz 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