Conversational Analysis Authoring - Create Project

Reference

Service:: Azure AI Services

API Version:: 2022-05-01

Creates a new project or updates an existing one.

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

URI Parameters

Name	In	Required	Type	Description
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

Media Types: "application/merge-patch+json"

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

Request Body

Media Types: "application/merge-patch+json"

Name	Required	Type	Description
language	True	string	The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
projectKind	True	ProjectKind	Represents the project kind.
projectName	True	string	The new project name.
description		string	The project description.
multilingual		boolean	Whether the project would be used for multiple languages or not.
settings		ConversationalAnalysisAuthoringProjectSettings	The project settings.

Responses

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	The metadata of the updated project, if it already exists.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	The metadata of the created project.
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 Create Project

Sample request

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01


{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

Sample response

Status code:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Status code:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definitions

Name	Description
ConversationalAnalysisAuthoringCreateProjectOptions	Represents the options used to create or update a project.
ConversationalAnalysisAuthoringProjectMetadata	Represents the metadata of a project.
ConversationalAnalysisAuthoringProjectSettings	Represents the settings used to define the project behavior.
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.
ProjectKind	Represents the project kind.

ConversationalAnalysisAuthoringCreateProjectOptions

Represents the options used to create or update a project.

Name	Type	Description
description	string	The project description.
language	string	The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
multilingual	boolean	Whether the project would be used for multiple languages or not.
projectKind	ProjectKind	Represents the project kind.
projectName	string	The new project name.
settings	ConversationalAnalysisAuthoringProjectSettings	The project settings.

ConversationalAnalysisAuthoringProjectMetadata

Represents the metadata of a project.

Name	Type	Description
createdDateTime	string	Represents the project creation datetime.
description	string	The project description.
language	string	The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
lastDeployedDateTime	string	Represents the project last deployed datetime.
lastModifiedDateTime	string	Represents the project creation datetime.
lastTrainedDateTime	string	Represents the project last trained datetime.
multilingual	boolean	Whether the project would be used for multiple languages or not.
projectKind	ProjectKind	Represents the project kind.
projectName	string	The new project name.
settings	ConversationalAnalysisAuthoringProjectSettings	The project settings.

ConversationalAnalysisAuthoringProjectSettings

Represents the settings used to define the project behavior.

Name	Type	Description
confidenceThreshold	number	The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to "None".

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