Question Answering Projects - Get Qnas

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-15-preview

Возвращает все QnAs проекта.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview

С использованием необязательных параметров:

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

Параметры URI

Имя	В	Обязательно	Тип	Описание
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
maxpagesize	query		integer int32	Максимальное количество ресурсов для включения в один ответ.
skip	query		integer int32	Смещение в коллекцию первого ресурса, возвращаемого.
source	query		string	Источник QnA.
top	query		integer int32	Максимальное количество ресурсов, возвращаемых из коллекции.

Ответы

Имя	Тип	Описание
200 OK	QnaAssets	Все QnAs проекта.
Other Status Codes	ErrorResponse	Ответ на ошибку.

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

AADToken

Это потоки OAuth2 Azure Active Directory. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами .

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

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

Области

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

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса службы языка.

Тип: apiKey
В: header

Примеры

Successful query

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

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-15-preview

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

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

{
  "value": [
    {
      "id": 1,
      "answer": "ans1",
      "source": "source1",
      "questions": [
        "question 1.1",
        "question 1.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 1.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 1.2"
          }
        ]
      },
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    },
    {
      "id": 2,
      "answer": "ans2",
      "source": "source2",
      "questions": [
        "question 2.1",
        "question 2.2"
      ],
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    }
  ]
}

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaAssets	Все ресурсы QnA для проекта.
QnaDialog	Диалоговое окно, связанное с записью QnA.
QnaPrompt	Запрос ответа.
QnaRecord	Запись QnA.
RetrieveQnaRecord	Запись QnA с последней обновленной датой.
SuggestedQuestion	Вопрос, предлагаемый функцией Активного обучения.
SuggestedQuestionsCluster	Сведения о кластере с предлагаемыми сведениями об активном обучении.

Error

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

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

ErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

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

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

InnerErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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	Целевой объект ошибки.

QnaAssets

Все ресурсы QnA для проекта.

Имя	Тип	Описание
nextLink	string
value	RetrieveQnaRecord[]	Список записей QnA.

QnaDialog

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

Имя	Тип	Описание
isContextOnly	boolean	Чтобы пометить, относится ли запрос только к предыдущему вопросу или нет. Если значение true, не включайте этот QnA в качестве ответа на запросы без контекста; в противном случае игнорирует контекст и включает этот QnA в ответы.
prompts	QnaPrompt[]	Список запросов, связанных с ответом.

QnaPrompt

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

Имя	Тип	Описание
displayOrder	integer	Индекс запроса. Он используется для упорядочивания запросов.
displayText	string	Текст, отображаемый для представления запроса на последующий запрос.
qna	QnaRecord	Запись QnA. Запись QnAId или QnA должна присутствовать в запросе.
qnaId	integer	Идентификатор QnA, соответствующий запросу.

QnaRecord

Запись QnA.

Имя	Тип	Описание
activeLearningSuggestions	SuggestedQuestionsCluster[]	Список предложений Active Learning для QnA.
answer	string	Текст ответа.
dialog	QnaDialog	Контекст QnA.
id	integer	Уникальный идентификатор для QnA.
metadata	object	Метаданные, связанные с ответом, полезны для классификации или фильтрации ответов на вопросы.
questions	string[]	Список вопросов, связанных с ответом.
source	string	Источник, из которого индексированА QnA, например https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs.

RetrieveQnaRecord

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

Имя	Тип	Описание
activeLearningSuggestions	SuggestedQuestionsCluster[]	Список предложений Active Learning для QnA.
answer	string	Текст ответа.
dialog	QnaDialog	Контекст QnA.
id	integer	Уникальный идентификатор для QnA.
lastUpdatedDateTime	string	Дата и время последнего обновления QnA.
metadata	object	Метаданные, связанные с ответом, полезны для классификации или фильтрации ответов на вопросы.
questions	string[]	Список вопросов, связанных с ответом.
source	string	Источник, из которого индексированА QnA, например https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs.

SuggestedQuestion

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

Имя	Тип	Описание
autoSuggestedCount	integer	Число вопросов было предложено автоматически алгоритмом активного обучения.
question	string	Вопрос, предлагаемый функцией Активного обучения.
userSuggestedCount	integer	Количество явно предложенных пользователем вопросов.

SuggestedQuestionsCluster

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

Имя	Тип	Описание
clusterHead	string	Вопрос, выбранный в качестве главы рекомендуемого кластера вопросов алгоритмом кластеризации Active Learning.
suggestedQuestions	SuggestedQuestion[]	Список всех предлагаемых вопросов для QnA.

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