Conversational Analysis Authoring - Get Export Status

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2022-05-01

Pobiera stan zadania eksportu. Po zakończeniu zadania zwraca metadane projektu i zasoby.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Identyfikator zadania.
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz subskrypcji zasobu usługi językowej.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ConversationalAnalysisAuthoringExportProjectJobState	Stan długotrwałej operacji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful Get Export Status

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ConversationalAnalysisAuthoringExportProjectJobState	Reprezentuje stan zadania eksportu.
ConversationalAnalysisAuthoringWarning	Reprezentuje ostrzeżenie, które zostało napotkane podczas wykonywania żądania.
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Stan zadania.

ConversationalAnalysisAuthoringExportProjectJobState

Reprezentuje stan zadania eksportu.

Nazwa	Typ	Opis
createdDateTime	string	Data utworzenia zadania.
errors	Error[]	Błędy napotkane podczas wykonywania zadania.
expirationDateTime	string	Data wygaśnięcia zadania.
jobId	string	Identyfikator zadania.
lastUpdatedDateTime	string	Data ostatniej aktualizacji zadania.
resultUrl	string	Adres URL do użycia w celu pobrania wyeksportowanego projektu.
status	JobStatus	Stan zadania.
warnings	ConversationalAnalysisAuthoringWarning[]	Ostrzeżenia, które zostały napotkane podczas wykonywania zadania.

ConversationalAnalysisAuthoringWarning

Reprezentuje ostrzeżenie, które zostało napotkane podczas wykonywania żądania.

Nazwa	Typ	Opis
code	string	Kod ostrzegawczy.
message	string	Komunikat ostrzegawczy.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode