Conversational Analysis Authoring - Swap Deployments

Serviço:

Cognitive Services - Language

Versão da API:

2022-05-01

Troca duas implementações existentes entre si.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments/:swap?api-version=2022-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de subscrição para um recurso do Serviço de idiomas.

Corpo do Pedido

Name	Necessário	Tipo	Description
firstDeploymentName	True	string	Representa o primeiro nome de implementação.
secondDeploymentName	True	string	Representa o segundo nome de implementação.

Respostas

Name	Tipo	Description
202 Accepted		Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Cabeçalhos operation-location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Tipo: apiKey
Em: header

Exemplos

Successful Swap Deployments

Pedido de amostra

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/:swap?api-version=2022-05-01


{
  "firstDeploymentName": "production",
  "secondDeploymentName": "staging"
}

Resposta da amostra

Código de estado:

202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-05-01

Definições

Name	Description
ConversationalAnalysisAuthoringSwapDeploymentsOptions	Representa as opções para trocar duas implementações em conjunto.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringSwapDeploymentsOptions

Representa as opções para trocar duas implementações em conjunto.

Name	Tipo	Description
firstDeploymentName	string	Representa o primeiro nome de implementação.
secondDeploymentName	string	Representa o segundo nome de implementação.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	InnerErrorModel	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 por humanos do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

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

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Name	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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	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 do erro.