Compartilhar via

Conversational Analysis Authoring - Swap Deployments

  • Referência
Serviço:
Cognitive Services - Language
Versão da API:
2022-05-01

Troca duas implantações existentes entre si.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
Endpoint
 path True

string

Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
projectName
 path True

string

O nome do projeto a ser usado.
api-version
 query True

string

Versão de API do cliente.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

Uma chave de assinatura para um recurso de serviço de linguagem.

Corpo da solicitação

Nome Obrigatório Tipo Description
firstDeploymentName True

string

Representa o primeiro nome de implantação.
secondDeploymentName True

string

Representa o segundo nome de implantação.

Respostas

Nome Tipo Description
202 Accepted

Uma chamada bem-sucedida resulta em um cabeçalho Operation-Location usado para verificar o status do trabalho.

Cabeçalhos

operation-location: string
Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

Exemplos

Successful Swap Deployments

Solicitação de exemplo

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


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

Resposta de exemplo

Código de status:
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

Nome Description
ConversationalAnalysisAuthoringSwapDeploymentsOptions

Representa as opções para trocar duas implantações juntas.
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 API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringSwapDeploymentsOptions

Representa as opções para trocar duas implantações juntas.

Nome Tipo Description
firstDeploymentName

string

Representa o primeiro nome de implantação.
secondDeploymentName

string

Representa o segundo nome de implantação.

Error

O objeto de erro.

Nome Tipo Description
code

ErrorCode

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

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 pelo homem 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

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

InnerErrorCode

Um de um conjunto definido pelo servidor de códigos de erro.
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.