Conversational Analysis Authoring - Get Deployment

Service:

Azure AI Services

API Version:

2022-05-01

Gets the details of a deployment.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}?api-version=2022-05-01

URI Parameters

Name	In	Required	Type	Description
deploymentName	path	True	string	The name of the specific deployment of the project to use.
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName	path	True	string	The name of the project to use.
api-version	query	True	string	Client API version.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	A subscription key for a Language service resource.

Responses

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectDeployment	The Deployment info.
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Get Deployment

Sample request

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging?api-version=2022-05-01

Sample response

Status code:

200

{
  "deploymentName": "staging",
  "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
  "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
  "lastDeployedDateTime": "2022-04-18T15:53:04Z",
  "deploymentExpirationDate": "2023-10-28",
  "modelTrainingConfigVersion": "2022-05-01"
}

Definitions

Name	Description
ConversationalAnalysisAuthoringProjectDeployment	Represents a project deployment.
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringProjectDeployment

Represents a project deployment.

Name	Type	Description
deploymentExpirationDate	string	Represents deployment expiration date in the runtime.
deploymentName	string	Represents deployment name.
lastDeployedDateTime	string	Represents deployment last deployed time.
lastTrainedDateTime	string	Represents deployment last trained time.
modelId	string	Represents deployment modelId.
modelTrainingConfigVersion	string	Represents model training config version.

Error

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Human-readable error code.

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

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Human-readable error code.

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

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.