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)	Поддерживаемая конечная точка Cognitive Services, например 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
Flow: 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 в одном проекте.