Conversational Analysis Authoring - Get Project

Служба:

Azure AI Services

Версия API:

2022-05-01

Возвращает сведения о проекте.

GET {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 maxLength: 100	Имя используемого проекта.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

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

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

Ответы

Имя	Тип	Описание
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Метаданные проекта.
Other Status Codes	ErrorResponse	Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

Successful Get Project

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

HTTP

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

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

Код состояния:

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

Определения

Имя	Описание
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	Представляет тип проекта.

ConversationalAnalysisAuthoringProjectMetadata

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	Имя нового проекта.
settings	ConversationalAnalysisAuthoringProjectSettings	Параметры проекта.

ConversationalAnalysisAuthoringProjectSettings

Object

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

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

Error

Object

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

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

ErrorCode

Перечисление

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

Значение	Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Объект ошибки.

InnerErrorCode

Перечисление

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

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемых сервером кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ProjectKind

Перечисление

Представляет тип проекта.

Значение	Описание
Conversation	Проект для создания естественного языка в приложениях, ботах и устройствах Интернета вещей.
Orchestration	Проект для подключения и оркестрации беседы, пользовательских ответов на вопросы и проектов LUIS вместе в одном проекте.