Question Answering Projects - Create Project

Служба:: Azure AI Services

Версия API:: 2023-04-01

Создание или обновление проекта.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}?api-version=2023-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string (uri)	Поддерживаемая конечная точка Cognitive Services (например, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Имя проекта.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Тип	Описание
description	string	Описание проекта.
language	string	Язык текстовых записей. Это представление языка BCP-47. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.
multilingualResource	boolean	Ресурс включен для нескольких языков в проектах или нет.
settings	ProjectSettings	Настраиваемые параметры проекта.

Ответы

Имя	Тип	Описание
200 OK	QuestionAnsweringProjectMetadata	Запрос выполнен успешно.
201 Created	QuestionAnsweringProjectMetadata	Запрос успешно выполнен, и в результате был создан новый ресурс.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

QuestionAnsweringProjectMetadata

Запрос выполнен успешно.

201 Created

QuestionAnsweringProjectMetadata

Запрос успешно выполнен, и в результате был создан новый ресурс.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Successful query

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

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1?api-version=2023-04-01

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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

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

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Определения

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

Error

Object

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

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

ErrorCode

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

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

Значение	Описание
InvalidRequest	Недопустимая ошибка запроса
InvalidArgument	Недопустимая ошибка аргумента
Unauthorized	Ошибка несанкционированного доступа
Forbidden	Ошибка запрещенного доступа
NotFound	Ошибка не найдена
ProjectNotFound	Ошибка проекта не найдена
OperationNotFound	Ошибка операции не найдена
AzureCognitiveSearchNotFound	Ошибка "Когнитивный поиск Azure" не найдена
AzureCognitiveSearchIndexNotFound	Индекс Когнитивного поиска Azure не найден ошибкой
TooManyRequests	Ошибка слишком большого количества запросов
AzureCognitiveSearchThrottling	Ошибка регулирования когнитивного поиска Azure
AzureCognitiveSearchIndexLimitReached	Достигнуто ограничение индекса Когнитивного поиска Azure
InternalServerError	Внутренняя ошибка сервера.
ServiceUnavailable	Ошибка недоступности службы
Timeout	Ошибка времени ожидания
QuotaExceeded	Ошибка превышения квоты
Conflict	ошибка конфликта
Warning	Предупреждение об ошибке

ErrorResponse

Object

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

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

InnerErrorCode

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

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

Значение	Описание
InvalidRequest	Недопустимая ошибка запроса
InvalidParameterValue	Ошибка недопустимого значения параметра
KnowledgeBaseNotFound	Ошибка базы знаний не найдена
AzureCognitiveSearchNotFound	Ошибка "Когнитивный поиск Azure" не найдена
AzureCognitiveSearchThrottling	Ошибка регулирования когнитивного поиска Azure
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	Целевой объект ошибки.

ProjectSettings

Object

Настраиваемые параметры проекта.

Имя	Тип	Описание
defaultAnswer	string	Ответ ответа по умолчанию, если в базе знаний не найдено правильного совпадения.

QuestionAnsweringProjectMetadata

Object

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

Имя	Тип	Описание
createdDateTime	string (date-time)	Дата создания проекта.
description	string	Описание проекта.
language	string	Язык текстовых записей. Это представление языка BCP-47. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.
lastDeployedDateTime	string (date-time)	Представляет проект последней даты развертывания.
lastModifiedDateTime	string (date-time)	Представляет проект последней измененной даты и времени.
multilingualResource	boolean	Ресурс включен для нескольких языков в проектах или нет.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Имя проекта.
settings	ProjectSettings	Настраиваемые параметры проекта.

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

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

Имя	Тип	Описание
description	string	Описание проекта.
language	string	Язык текстовых записей. Это представление языка BCP-47. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.
multilingualResource	boolean	Ресурс включен для нескольких языков в проектах или нет.
settings	ProjectSettings	Настраиваемые параметры проекта.

Поделиться через

Question Answering Projects - Create Project

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Successful query

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

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

Определения

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectSettings

QuestionAnsweringProjectMetadata

QuestionAnsweringProjectMetadataCreateOrUpdate