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

Question Answering Projects - Update Qnas

  • Ссылка
Служба:
Azure AI Services
Версия API:
2021-10-01

Обновляет QnAs проекта.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?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

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

Имя Тип Описание
body

UpdateQnaRecord[]

Обновление параметров QnAs проекта.

Ответы

Имя Тип Описание
202 Accepted

Результаты успешного вызова с заголовком Operation-Location, используемым для проверки состояния задания.

Заголовки

Operation-Location: string
Other Status Codes

ErrorResponse

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

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful query

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

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


[
  {
    "op": "add",
    "value": {
      "id": 3,
      "answer": "ans3",
      "source": "source1",
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 3.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 3.2"
          }
        ]
      }
    }
  },
  {
    "op": "replace",
    "value": {
      "id": 1,
      "answer": "ans4",
      "source": "source1",
      "questions": [
        "question 4.1",
        "question 4.2"
      ]
    }
  },
  {
    "op": "delete",
    "value": {
      "id": 2,
      "answer": "ans2",
      "source": "source1",
      "questions": [
        "question 2.1",
        "question 2.2"
      ]
    }
  }
]

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

Код состояния:
202 
Operation-Location: job1

Определения

Имя Описание
Error

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

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

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

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

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

Диалоговое окно, связанное с записью QnA.
QnaPrompt

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

Запись QnA.
SuggestedQuestion

Вопрос, предлагаемый функцией Активного обучения.
SuggestedQuestionsCluster

Сведения о кластере с предлагаемыми сведениями об активном обучении.
updateOperationKind

Тип операции обновления для ресурсов.
UpdateQnaRecord

Запись QnA для обновления.

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

Целевой объект ошибки.

QnaDialog

Object

Диалоговое окно, связанное с записью QnA.

Имя Тип Описание
isContextOnly

boolean

Чтобы пометить, относится ли запрос только к предыдущему вопросу или нет. Если значение true, не включайте этот QnA в качестве ответа на запросы без контекста; в противном случае игнорирует контекст и включает этот QnA в ответы.
prompts

QnaPrompt[]

Список запросов, связанных с ответом.

QnaPrompt

Object

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

Имя Тип Описание
displayOrder

integer (int32)

Индекс запроса. Он используется для упорядочивания запросов.
displayText

string

maxLength: 200

Текст, отображаемый для представления запроса на последующий запрос.
qna

QnaRecord

Запись QnA. Запись QnAId или QnA должна присутствовать в запросе.
qnaId

integer (int32)

Идентификатор QnA, соответствующий запросу.

QnaRecord

Object

Запись QnA.

Имя Тип Описание
activeLearningSuggestions

SuggestedQuestionsCluster[]

Список предложений Active Learning для QnA.
answer

string

minLength: 1
maxLength: 25000

Текст ответа.
dialog

QnaDialog

Контекст QnA.
id

integer (int32)

Уникальный идентификатор для QnA.
metadata

object

Метаданные, связанные с ответом, полезны для классификации или фильтрации ответов на вопросы.
questions

string[]

Список вопросов, связанных с ответом.
source

string

maxLength: 300

Источник, из которого индексированА QnA, например https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs.

SuggestedQuestion

Object

Вопрос, предлагаемый функцией Активного обучения.

Имя Тип Описание
autoSuggestedCount

integer (int32)

Число вопросов было предложено автоматически алгоритмом активного обучения.
question

string

Вопрос, предлагаемый функцией Активного обучения.
userSuggestedCount

integer (int32)

Количество явно предложенных пользователем вопросов.

SuggestedQuestionsCluster

Object

Сведения о кластере с предлагаемыми сведениями об активном обучении.

Имя Тип Описание
clusterHead

string

Вопрос, выбранный в качестве главы рекомендуемого кластера вопросов алгоритмом кластеризации Active Learning.
suggestedQuestions

SuggestedQuestion[]

Список всех предлагаемых вопросов для QnA.

updateOperationKind

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

Тип операции обновления для ресурсов.

Значение Описание
add
delete
replace

UpdateQnaRecord

Object

Запись QnA для обновления.

Имя Тип Описание
op

updateOperationKind

Тип операции обновления для ресурсов.
value

QnaRecord

Запись QnA.