Question Answering Projects - Create Project

Служба:

Azure AI Services

Версия API:

2021-10-01

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

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}?api-version=2021-10-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

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

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

Ответы

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

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful query

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

HTTP

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1?api-version=2021-10-01


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

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

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

200

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

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

201

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

Определения

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

CreateProjectOptions

Object

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

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

Error

Object

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

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

ErrorCode

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

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

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

ErrorResponse

Object

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

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

InnerErrorCode

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

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

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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	Целевой объект ошибки.

ProjectMetadata

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	Имя проекта.
settings	ProjectSettings	Настраиваемые параметры проекта.

ProjectSettings

Object

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

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