Conversational Analysis Authoring - Get Deployment Status
Obtém o status de um trabalho de implantação existente.
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}?api-version=2023-04-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
O nome da implantação específica do projeto a ser usado. |
Endpoint
|
path | True |
string |
Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
A ID do trabalho. |
project
|
path | True |
string |
O nome do projeto a ser usado. |
api-version
|
query | True |
string |
Versão de API do cliente. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
O resultado do trabalho de implantação. |
|
Other Status Codes |
Resposta de erro. |
Segurança
AADToken
Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-id
cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
O Authorization URL
é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Uma chave de assinatura para um recurso de serviço de linguagem.
Tipo:
apiKey
Em:
header
Exemplos
Successful Get Deployment Status
Solicitação de exemplo
GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01
Resposta de exemplo
{
"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"
}
Definições
Nome | Description |
---|---|
Conversational |
Representa o estado de um trabalho de implantação. |
Conversational |
Representa um aviso que foi encontrado durante a execução da solicitação. |
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
Inner |
Código de erro legível por humanos. |
Inner |
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
O trabalho status. |
ConversationalAnalysisAuthoringDeploymentJobState
Representa o estado de um trabalho de implantação.
Nome | Tipo | Description |
---|---|---|
createdDateTime |
string |
A data e hora de criação do trabalho. |
errors |
Error[] |
Os erros encontrados durante a execução do trabalho. |
expirationDateTime |
string |
A data de validade do trabalho. |
jobId |
string |
A ID do trabalho. |
lastUpdatedDateTime |
string |
A hora da última data em que o trabalho foi atualizado. |
status |
O trabalho status. |
|
warnings |
Os avisos que foram encontrados durante a execução do trabalho. |
ConversationalAnalysisAuthoringWarning
Representa um aviso que foi encontrado durante a execução da solicitação.
Nome | Tipo | Description |
---|---|---|
code |
string |
O código de aviso. |
message |
string |
A mensagem de aviso. |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Uma representação legível do erro. |
target |
string |
O destino do erro. |
ErrorCode
Código de erro legível por humanos.
Nome | Tipo | 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
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
InnerErrorCode
Código de erro legível por humanos.
Nome | Tipo | Description |
---|---|---|
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
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
object |
Detalhes do erro. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino de erro. |
JobStatus
O trabalho status.
Nome | Tipo | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |