Conversational Analysis Authoring - Create Project

Ссылка

Служба:: Cognitive Services - Language

Версия API:: 2022-05-01

Создает новый проект или обновляет существующий.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия API клиента.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Ключ подписки для ресурса языковой службы.

Текст запроса

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		ConversationalAnalysisAuthoringProjectSettings	Параметры проекта.

Ответы

Имя	Тип	Описание
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Метаданные обновленного проекта, если они уже существуют.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	Метаданные созданного проекта.
Other Status Codes	ErrorResponse	Ответ об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful Create Project

Образец запроса

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
}

Пример ответа

Код состояния:: 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"
}

Определения

Имя	Описание
ConversationalAnalysisAuthoringCreateProjectOptions	Представляет параметры, используемые для создания или обновления проекта.
ConversationalAnalysisAuthoringProjectMetadata	Представляет метаданные проекта.
ConversationalAnalysisAuthoringProjectSettings	Представляет параметры, используемые для определения поведения проекта.
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Представляет тип проекта.

ConversationalAnalysisAuthoringCreateProjectOptions

Представляет параметры, используемые для создания или обновления проекта.

Имя	Тип	Описание
description	string	Описание проекта.
language	string	Язык проекта. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского языка и т. д.
multilingual	boolean	Будет ли проект использоваться для нескольких языков или нет.
projectKind	ProjectKind	Представляет тип проекта.
projectName	string	Имя нового проекта.
settings	ConversationalAnalysisAuthoringProjectSettings	Параметры проекта.

ConversationalAnalysisAuthoringProjectMetadata

Представляет метаданные проекта.

Имя	Тип	Описание
createdDateTime	string	Представляет дату и время создания проекта.
description	string	Описание проекта.
language	string	Язык проекта. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского языка и т. д.
lastDeployedDateTime	string	Представляет проект, развернутый в последний раз, datetime.
lastModifiedDateTime	string	Представляет дату и время создания проекта.
lastTrainedDateTime	string	Представляет проект с последней обученной датой и временем.
multilingual	boolean	Будет ли проект использоваться для нескольких языков или нет.
projectKind	ProjectKind	Представляет тип проекта.
projectName	string	Имя нового проекта.
settings	ConversationalAnalysisAuthoringProjectSettings	Параметры проекта.

ConversationalAnalysisAuthoringProjectSettings

Представляет параметры, используемые для определения поведения проекта.

Имя	Тип	Описание
confidenceThreshold	number	Порог намерения с наибольшей достоверностью, при котором прогноз автоматически изменится на "Нет".

Error

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из серверных наборов кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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	Error	Объект ошибки.

InnerErrorCode