Knowledgebase - Replace

Ссылка

Служба:: Azure AI Services

Версия API:: v5.0-preview.2

Замените содержимое базы знаний.

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Идентификатор базы знаний.

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

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

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

Имя	Обязательно	Тип	Описание
qnAList	True	QnADTO[]	Список Q-A (QnADTO), добавляемый в базу знаний. Идентификаторы Q-A назначаются службой и должны быть опущены.

Ответы

Имя	Тип	Описание
204 No Content		HTTP 204 No content.
Other Status Codes	ErrorResponse	Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful query

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

HTTP

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


{
  "qnAList": [
    {
      "id": 0,
      "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
      "source": "Custom Editorial",
      "questions": [
        "How can I change the default message from QnA Maker?"
      ],
      "metadata": []
    },
    {
      "id": 0,
      "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
      "source": "Custom Editorial",
      "questions": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ]
    }
  ]
}

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

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

Определения

Имя	Описание
Context	Контекст, связанный с обновлением Qna.
Error	Объект ошибки. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Один из определяемых сервером кодов ошибок.
ErrorResponse	Ответ на ошибку. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Имя — пара значений метаданных.
PromptDTO	Запрос ответа.
Qna	QnADTO — QnaId или QnADTO должны присутствовать в объекте PromptDTO
QnADTO	Объект Q-A.
ReplaceKbDTO	Схема текста после замены базы знаний.

Context

Object

Контекст, связанный с обновлением Qna.

Имя	Тип	Описание
isContextOnly	boolean	Чтобы пометить, относится ли запрос только к предыдущему вопросу или нет. true. Не включать этот QnA в качестве результата поиска для запросов без контекста false , игнорирует контекст и включает этот QnA в результат поиска
promptsToAdd	PromptDTO[]	Список запросов, которые нужно добавить в qna.
promptsToDelete	integer[] (int32)	Список запросов, связанных с qna, которые необходимо удалить

Error

Object

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

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

ErrorCodeType

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

Один из определяемых сервером кодов ошибок.

Значение	Описание
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

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

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

InnerErrorModel

Object

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

Имя	Тип	Описание
code	string	Более конкретный код ошибки, чем был предоставлен содержащей ошибкой.
innerError	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

MetadataDTO

Object

Имя — пара значений метаданных.

Имя	Тип	Описание
name	string minLength: 1 maxLength: 100	Имя метаданных.
value	string minLength: 1 maxLength: 500	Значение метаданных.

PromptDTO

Object

Запрос ответа.

Имя	Тип	Описание
displayOrder	integer (int32)	Индекс запроса , используемый в порядке запросов
displayText	string maxLength: 200	Текст, отображаемый для представления запроса на следующий вопрос
qna	Qna	QnADTO — QnaId или QnADTO должны присутствовать в объекте PromptDTO
qnaId	integer (int32)	Идентификатор Qna, соответствующий запросу. Если QnaId присутствует, объект QnADTO игнорируется.

Qna

Object

QnADTO — QnaId или QnADTO должны присутствовать в объекте PromptDTO

Имя	Тип	Описание
answer	string minLength: 1 maxLength: 25000	Текст ответа
context	Context	Контекст QnA
id	integer (int32)	Уникальный идентификатор для Q-A.
lastUpdatedTimestamp	string maxLength: 300	Метка времени последнего обновления QnA.
metadata	MetadataDTO[]	Список метаданных, связанных с ответом.
questions	string[]	Список вопросов, связанных с ответом.
source	string maxLength: 300	Источник, из которого индексирован Q-A. Например. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Object

Объект Q-A.

Имя	Тип	Описание
answer	string minLength: 1 maxLength: 25000	Текст ответа
context	Context	Контекст QnA
id	integer (int32)	Уникальный идентификатор для Q-A.
lastUpdatedTimestamp	string maxLength: 300	Метка времени последнего обновления QnA.
metadata	MetadataDTO[]	Список метаданных, связанных с ответом.
questions	string[]	Список вопросов, связанных с ответом.
source	string maxLength: 300	Источник, из которого индексирован Q-A. Например. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Object

Схема текста после замены базы знаний.

Имя	Тип	Описание
qnAList	QnADTO[]	Список Q-A (QnADTO), добавляемый в базу знаний. Идентификаторы Q-A назначаются службой и должны быть опущены.

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

Knowledgebase - Replace

Параметры URI

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

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Successful query

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

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

Определения

Context

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnADTO

ReplaceKbDTO

Дополнительные ресурсы