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://< resource-name.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

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

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

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

ErrorResponse

Object

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

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

InnerErrorCode

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

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

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

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	Проект по встраиванию естественного языка в приложения, боты и устройства IoT.
Orchestration	Проект для объединения и координации диалогов, пользовательских ответов на вопросы и проектов LUIS в одном проекте.