Conversational Analysis Authoring - Get Deployment Status

Reference

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Získá stav existující úlohy nasazení.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}?api-version=2023-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
deploymentName	path	True	string	Název konkrétního nasazení projektu, který se má použít.
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	ID úlohy.
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze klientského rozhraní API

Odpovědi

Name	Typ	Description
200 OK	ConversationalAnalysisAuthoringDeploymentJobState	Výsledek úlohy nasazení
Other Status Codes	ErrorResponse	Odpověď na chybu.

Zabezpečení

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Azure Active Directory verze 1.0 nebo v2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby language.

Type: apiKey
In: header

Příklady

Successful Get Deployment Status

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000",
  "createdDateTime": "2022-04-18T15:52:48Z",
  "lastUpdatedDateTime": "2022-04-18T15:53:04Z",
  "expirationDateTime": "2022-04-25T15:52:48Z",
  "status": "succeeded"
}

Definice

Name	Description
ConversationalAnalysisAuthoringDeploymentJobState	Představuje stav úlohy nasazení.
ConversationalAnalysisAuthoringWarning	Představuje upozornění, ke kterému došlo při provádění požadavku.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Stav úlohy.

ConversationalAnalysisAuthoringDeploymentJobState

Představuje stav úlohy nasazení.

Name	Typ	Description
createdDateTime	string	Datum vytvoření úlohy.
errors	Error[]	Chyby, ke kterým došlo při provádění úlohy.
expirationDateTime	string	Datum vypršení platnosti úlohy.
jobId	string	ID úlohy.
lastUpdatedDateTime	string	Datum poslední aktualizace úlohy.
status	JobStatus	Stav úlohy.
warnings	ConversationalAnalysisAuthoringWarning[]	Upozornění, která se vyskytla při provádění úlohy.

ConversationalAnalysisAuthoringWarning

Představuje upozornění, ke kterému došlo při provádění požadavku.

Name	Typ	Description
code	string	Kód upozornění
message	string	Upozornění

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definované sady kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
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

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode