Conversation Authoring Project - Create Project

服务:

Azure AI Services

API 版本:

2025-11-01

创建新项目或更新现有项目。

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string (uri)	支持的认知服务终结点，例如 https://< resource-name.api.cognitiveservices.azure.com>。
projectName	path	True	string maxLength: 100	新项目名称。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求正文

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

名称	必需	类型	说明
language	True	string	项目语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
projectKind	True	ProjectKind	表示项目类型。
projectName	True	string	新项目名称。
description		string	项目说明。
multilingual		boolean	项目是否用于多种语言。
settings		AnalyzeConversationAuthoringProjectSettings	项目设置。

响应

名称	类型	说明
200 OK	AnalyzeConversationAuthoringProjectMetadata	请求已成功。
201 Created	AnalyzeConversationAuthoringProjectMetadata	请求已成功，因此创建了一个新资源。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Successful Create Project

示例请求

HTTP

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

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

示例响应

状态代码:

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"
}

状态代码:

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"
}

定义

名称	说明
AnalyzeConversationAuthoringCreateProjectOptions	表示用于创建或更新项目的选项。
AnalyzeConversationAuthoringProjectMetadata	表示项目的元数据。
AnalyzeConversationAuthoringProjectSettings	表示用于定义项目行为的设置。
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
ProjectKind

AnalyzeConversationAuthoringCreateProjectOptions

Object

表示用于创建或更新项目的选项。

名称	类型	说明
description	string	项目说明。
language	string	项目语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
multilingual	boolean	项目是否用于多种语言。
projectKind	ProjectKind	表示项目类型。
projectName	string	新项目名称。
settings	AnalyzeConversationAuthoringProjectSettings	项目设置。

AnalyzeConversationAuthoringProjectMetadata

Object

表示项目的元数据。

名称	类型	说明
createdDateTime	string (date-time)	表示项目创建日期/时间。
description	string	项目说明。
language	string	项目语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
lastDeployedDateTime	string (date-time)	表示项目上次部署的日期时间。
lastModifiedDateTime	string (date-time)	表示项目创建日期/时间。
lastTrainedDateTime	string (date-time)	表示项目上次训练的日期时间。
multilingual	boolean	项目是否用于多种语言。
projectKind	ProjectKind	表示项目类型。
projectName	string maxLength: 100	新项目名称。
settings	AnalyzeConversationAuthoringProjectSettings	项目设置。

AnalyzeConversationAuthoringProjectSettings

Object

表示用于定义项目行为的设置。

名称	类型	说明
confidenceThreshold	number (float)	置信度最高的意图的阈值，在此阈值下，预测将自动更改为“无”。 阈值的值应介于 0 和 1 之间（含）。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

ProjectKind

枚举

值	说明
Conversation	将自然语言构建到应用、机器人和 IoT 设备中的项目。
Orchestration	一个项目，用于在一个项目中连接和协调对话、自定义问答和 LUIS 项目。