Question Answering Projects - Update Sources

Служба:: Azure AI Services

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

Обновляет источники проекта.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?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, используемая для данной операции.

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

Имя	Тип	Описание
body	UpdateSourceRecord[]	Обновление параметров источников проекта.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена. Заголовки Operation-Location: string
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

202 Accepted

Запрос был принят для обработки, но обработка еще не завершена.

Заголовки

Operation-Location: string

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/sources?api-version=2023-04-01

[
  {
    "op": "add",
    "value": {
      "displayName": "source3",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
    }
  },
  {
    "op": "replace",
    "value": {
      "displayName": "source1",
      "refresh": true,
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    }
  },
  {
    "op": "delete",
    "value": {
      "displayName": "source2",
      "source": "surface-guide.pdf",
      "sourceKind": "file",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  }
]

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

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

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-01

Определения

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

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

sourceContentStructureKind

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

Тип структуры контента для источников.

Значение	Описание
unstructured	Неструктурированный.

sourceKind

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

Поддерживаемые типы источников.

Значение	Описание
file	Источник файла.
url	Источник URI.

updateOperationKind

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

Обновление типа операции для активов.

Значение	Описание
add	Добавить операцию.
delete	Операция удаления.
replace	Замените операцию.

UpdateQnaSourceRecord

Object

Обновите исходную запись.

Имя	Тип	Default value	Описание
contentStructureKind	sourceContentStructureKind	unstructured	Тип структуры контента для источников.
displayName	string minLength: 1 maxLength: 200		Понятное имя источника.
refresh	boolean		Логический флаг, используемый для обновления данных из источника.
source	string		Уникальный идентификатор источника. Имя файла, если это источник файла; в противном случае полный URL, если это источник 'url'.
sourceKind	sourceKind		Поддерживаемые типы источников.
sourceUri	string (uri)		Расположение URI для файла или URL-адреса.

UpdateSourceRecord

Object

Источник подлежит обновлению.

Имя	Тип	Описание
op	updateOperationKind	Обновление типа операции для активов.
value	UpdateQnaSourceRecord	Обновите исходную запись.

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

Question Answering Projects - Update Sources

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Successful query

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

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

Определения

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord